2023-07-12 11:28:07 +03:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "x-ua-compatible" content = "ie=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2023-07-25 10:58:48 +03:00
< meta name = "generator" content = "ExDoc v0.30.3" >
2023-07-12 11:28:07 +03:00
< meta name = "project" content = "Plausible v0.0.1" >
< title > PlausibleWeb.Api.StatsController — Plausible v0.0.1< / title >
2023-07-25 10:58:48 +03:00
< link rel = "stylesheet" href = "dist/html-elixir-P5GXSCHE.css" / >
2023-07-12 11:28:07 +03:00
< script src = "dist/handlebars.runtime-NWIB6V2M.js" > < / script >
2023-07-25 10:58:48 +03:00
< script src = "dist/handlebars.templates-NBND3S2D.js" > < / script >
2024-01-03 14:33:07 +03:00
< script src = "dist/sidebar_items-FC0072E8.js" > < / script >
2023-07-12 11:28:07 +03:00
< script src = "docs_config.js" > < / script >
2023-07-25 10:58:48 +03:00
< script async src = "dist/html-CGDDOCMI.js" > < / script >
2023-07-12 11:28:07 +03:00
< / head >
< body data-type = "modules" class = "page-module" >
< script >
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) & &
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
< / script >
< div class = "main" >
< button class = "sidebar-button sidebar-toggle" aria-label = "toggle sidebar" >
< i class = "ri-menu-line ri-lg" title = "Collapse/expand sidebar" > < / i >
< / button >
< section class = "sidebar" >
< form class = "sidebar-search" action = "search.html" >
< button type = "submit" class = "search-button" aria-label = "Submit Search" >
< i class = "ri-search-2-line" aria-hidden = "true" title = "Submit search" > < / i >
< / button >
< button type = "button" tabindex = "-1" class = "search-close-button" aria-label = "Cancel Search" >
< i class = "ri-close-line ri-lg" aria-hidden = "true" title = "Cancel search" > < / i >
< / button >
< label class = "search-label" >
< p class = "sr-only" > Search< / p >
< input name = "q" type = "text" class = "search-input" placeholder = "Search..." aria-label = "Input your search terms" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
< / label >
< / form >
< div class = "autocomplete" >
< div class = "autocomplete-results" >
< / div >
< / div >
< div class = "sidebar-header" >
< a href = "readme.html" >
< img src = "assets/logo.png" alt = "Plausible" class = "sidebar-projectImage" >
< / a >
< div class = "sidebar-projectDetails" >
< a href = "readme.html" class = "sidebar-projectName" translate = "no" >
Plausible
< / a >
< div class = "sidebar-projectVersion" translate = "no" >
v0.0.1
< / div >
< / div >
< ul class = "sidebar-listNav" >
< li > < a id = "extras-list-link" href = "#full-list" > Pages< / a > < / li >
< li > < a id = "modules-list-link" href = "#full-list" > Modules< / a > < / li >
< li > < a id = "tasks-list-link" href = "#full-list" > < span translate = "no" > Mix< / span > Tasks< / a > < / li >
< / ul >
< / div >
< div class = "gradient" > < / div >
< ul id = "full-list" > < / ul >
< / section >
< section class = "content" >
< output role = "status" id = "toast" > < / output >
< div class = "content-outer" >
< div id = "content" class = "content-inner" >
< h1 >
< button class = "icon-action display-settings" >
< i class = "ri-settings-3-line" > < / i >
< span class = "sr-only" > Settings< / span >
< / button >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L1" title = "View Source" class = "icon-action" rel = "help" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< span translate = "no" > PlausibleWeb.Api.StatsController< / span >
< small class = "app-vsn" translate = "no" > (Plausible v0.0.1)< / small >
< / h1 >
< section id = "summary" class = "details-list" >
< h1 class = "section-heading" >
< a class = "hover-link" href = "#summary" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
2023-07-25 10:58:48 +03:00
Summary
2023-07-12 11:28:07 +03:00
< / a >
< / h1 >
< div class = "summary-functions summary" >
< h2 >
< a href = "#functions" > Functions< / a >
< / h2 >
2023-07-24 17:28:39 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#all_custom_prop_values/2" translate = "no" > all_custom_prop_values(conn, params)< / a >
< / div >
< / div >
2023-07-12 11:28:07 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#browser_versions/2" translate = "no" > browser_versions(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#browsers/2" translate = "no" > browsers(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#cities/2" translate = "no" > cities(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#conversions/2" translate = "no" > conversions(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#countries/2" translate = "no" > countries(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#current_visitors/2" translate = "no" > current_visitors(conn, _)< / a >
< / div >
< / div >
2023-07-17 18:01:43 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#custom_prop_values/2" translate = "no" > custom_prop_values(conn, params)< / a >
< / div >
< / div >
2023-07-12 11:28:07 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#entry_pages/2" translate = "no" > entry_pages(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#exit_pages/2" translate = "no" > exit_pages(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#filter_suggestions/2" translate = "no" > filter_suggestions(conn, params)< / a >
< / div >
< / div >
2023-11-22 17:35:30 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#format_money/1" translate = "no" > format_money(money)< / a >
< / div >
< div class = "summary-synopsis" > < p > See < a href = "PlausibleWeb.Controllers.API.Revenue.html#format_money/1" > < code class = "inline" > PlausibleWeb.Controllers.API.Revenue.format_money/1< / code > < / a > .< / p > < / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#format_revenue_metric/1" translate = "no" > format_revenue_metric(metric_value)< / a >
< / div >
< div class = "summary-synopsis" > < p > See < a href = "PlausibleWeb.Controllers.API.Revenue.html#format_revenue_metric/1" > < code class = "inline" > PlausibleWeb.Controllers.API.Revenue.format_revenue_metric/1< / code > < / a > .< / p > < / div >
< / div >
2023-07-12 11:28:07 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#funnel/2" translate = "no" > funnel(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#main_graph/2" translate = "no" > main_graph(conn, params)< / a >
< / div >
< div class = "summary-synopsis" > < p > Returns a time-series based on given parameters.< / p > < / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#operating_system_versions/2" translate = "no" > operating_system_versions(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#operating_systems/2" translate = "no" > operating_systems(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#pages/2" translate = "no" > pages(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#referrer_drilldown/2" translate = "no" > referrer_drilldown(conn, params)< / a >
< / div >
< / div >
2023-08-07 10:32:57 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#referrers/2" translate = "no" > referrers(conn, params)< / a >
< / div >
< / div >
2023-07-12 11:28:07 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#regions/2" translate = "no" > regions(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#screen_sizes/2" translate = "no" > screen_sizes(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#sources/2" translate = "no" > sources(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#top_stats/2" translate = "no" > top_stats(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#utm_campaigns/2" translate = "no" > utm_campaigns(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#utm_contents/2" translate = "no" > utm_contents(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#utm_mediums/2" translate = "no" > utm_mediums(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#utm_sources/2" translate = "no" > utm_sources(conn, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#utm_terms/2" translate = "no" > utm_terms(conn, params)< / a >
< / div >
< / div >
< / div >
< / section >
< section id = "functions" class = "details-list" >
< h1 class = "section-heading" >
< a class = "hover-link" href = "#functions" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
Functions
2023-07-25 10:58:48 +03:00
< / a >
2023-07-12 11:28:07 +03:00
< / h1 >
< div class = "functions-list" >
2023-07-24 17:28:39 +03:00
< section class = "detail" id = "all_custom_prop_values/2" >
< div class = "detail-header" >
< a href = "#all_custom_prop_values/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > all_custom_prop_values(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L1211" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "browser_versions/2" >
< div class = "detail-header" >
< a href = "#browser_versions/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > browser_versions(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L1045" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "browsers/2" >
< div class = "detail-header" >
< a href = "#browsers/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > browsers(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L1021" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "cities/2" >
< div class = "detail-header" >
< a href = "#cities/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > cities(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L983" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "conversions/2" >
< div class = "detail-header" >
< a href = "#conversions/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > conversions(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L1145" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "countries/2" >
< div class = "detail-header" >
< a href = "#countries/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > countries(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L898" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "current_visitors/2" >
< div class = "detail-header" >
< a href = "#current_visitors/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > current_visitors(conn, _)< / h1 >
2024-01-02 15:31:46 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L1281" class = "icon-action" rel = "help" title = "View Source" >
2023-07-17 18:01:43 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "custom_prop_values/2" >
< div class = "detail-header" >
< a href = "#custom_prop_values/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > custom_prop_values(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L1194" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "entry_pages/2" >
< div class = "detail-header" >
< a href = "#entry_pages/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > entry_pages(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L807" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "exit_pages/2" >
< div class = "detail-header" >
< a href = "#exit_pages/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > exit_pages(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L838" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "filter_suggestions/2" >
< div class = "detail-header" >
< a href = "#filter_suggestions/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > filter_suggestions(conn, params)< / h1 >
2024-01-02 15:31:46 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L1292" class = "icon-action" rel = "help" title = "View Source" >
2023-11-22 17:35:30 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "format_money/1" >
< div class = "detail-header" >
< a href = "#format_money/1" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > format_money(money)< / h1 >
2024-01-02 15:31:46 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L1498" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
2023-11-22 17:35:30 +03:00
< p > See < a href = "PlausibleWeb.Controllers.API.Revenue.html#format_money/1" > < code class = "inline" > PlausibleWeb.Controllers.API.Revenue.format_money/1< / code > < / a > .< / p >
< / section >
< / section >
< section class = "detail" id = "format_revenue_metric/1" >
< div class = "detail-header" >
< a href = "#format_revenue_metric/1" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > format_revenue_metric(metric_value)< / h1 >
2024-01-02 15:31:46 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L1497" class = "icon-action" rel = "help" title = "View Source" >
2023-11-22 17:35:30 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
2023-07-12 11:28:07 +03:00
2023-11-22 17:35:30 +03:00
< p > See < a href = "PlausibleWeb.Controllers.API.Revenue.html#format_revenue_metric/1" > < code class = "inline" > PlausibleWeb.Controllers.API.Revenue.format_revenue_metric/1< / code > < / a > .< / p >
2023-07-12 11:28:07 +03:00
< / section >
< / section >
< section class = "detail" id = "funnel/2" >
< div class = "detail-header" >
< a href = "#funnel/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > funnel(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L495" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "main_graph/2" >
< div class = "detail-header" >
< a href = "#main_graph/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > main_graph(conn, params)< / h1 >
2023-11-22 17:35:30 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L98" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< p > Returns a time-series based on given parameters.< / p > < h2 id = "main_graph/2-parameters" class = "section-heading" >
2023-07-25 10:58:48 +03:00
< a href = "#main_graph/2-parameters" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
Parameters
2023-07-12 11:28:07 +03:00
< / a >
< / h2 >
< p > This API accepts the following parameters:< / p > < ul > < li > < p > < code class = "inline" > period< / code > - x-axis of the graph, e.g. < code class = "inline" > 12mo< / code > , < code class = "inline" > day< / code > , < code class = "inline" > custom< / code > .< / p > < / li > < li > < p > < code class = "inline" > metric< / code > - y-axis of the graph, e.g. < code class = "inline" > visits< / code > , < code class = "inline" > visitors< / code > , < code class = "inline" > pageviews< / code > .
See the Stats API < a href = "https://plausible.io/docs/stats-api#metrics" > " Metrics" < / a >
section for more details. Defaults to < code class = "inline" > visitors< / code > .< / p > < / li > < li > < p > < code class = "inline" > interval< / code > - granularity of the time-series data. You can think of it as
a < code class = "inline" > GROUP BY< / code > clause. Possible values are < code class = "inline" > minute< / code > , < code class = "inline" > hour< / code > , < code class = "inline" > date< / code > , < code class = "inline" > week< / code > ,
and < code class = "inline" > month< / code > . The default depends on the < code class = "inline" > period< / code > parameter. Check
< code class = "inline" > Plausible.Query.from/2< / code > for each default.< / p > < / li > < li > < p > < code class = "inline" > filters< / code > - optional filters to drill down data. See the Stats API
< a href = "https://plausible.io/docs/stats-api#filtering" > " Filtering" < / a > section for
more details.< / p > < / li > < li > < p > < code class = "inline" > with_imported< / code > - boolean indicating whether to include Google Analytics
2024-01-03 18:31:25 +03:00
imported data or not. Defaults to < code class = "inline" > false< / code > .< / p > < / li > < / ul > < p > Full example:< / p > < pre > < code class = "makeup elixir" translate = "no" > < span class = "p" data-group-id = "6328978111-1" > %{< / span > < span class = "w" >
2023-07-12 11:28:07 +03:00
< / span > < span class = "s" > " from" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "s" > " 2021-09-06" < / span > < span class = "p" > ,< / span > < span class = "w" >
< / span > < span class = "s" > " interval" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "s" > " month" < / span > < span class = "p" > ,< / span > < span class = "w" >
< / span > < span class = "s" > " metric" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "s" > " visitors" < / span > < span class = "p" > ,< / span > < span class = "w" >
< / span > < span class = "s" > " period" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "s" > " custom" < / span > < span class = "p" > ,< / span > < span class = "w" >
< / span > < span class = "s" > " to" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "s" > " 2021-12-13" < / span > < span class = "w" >
2024-01-03 18:31:25 +03:00
< / span > < span class = "p" data-group-id = "6328978111-1" > }< / span > < / code > < / pre > < h2 id = "main_graph/2-response" class = "section-heading" >
2023-07-25 10:58:48 +03:00
< a href = "#main_graph/2-response" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
Response
2023-07-12 11:28:07 +03:00
< / a >
< / h2 >
< p > Returns a map with the following keys:< / p > < ul > < li > < p > < code class = "inline" > plot< / code > - list of values for the requested metric representing the y-axis
of the graph.< / p > < / li > < li > < p > < code class = "inline" > labels< / code > - list of date times representing the x-axis of the graph.< / p > < / li > < li > < p > < code class = "inline" > present_index< / code > - index of the element representing the current date in
< code class = "inline" > labels< / code > and < code class = "inline" > plot< / code > lists.< / p > < / li > < li > < p > < code class = "inline" > interval< / code > - the interval used for querying.< / p > < / li > < li > < p > < code class = "inline" > with_imported< / code > - boolean indicating whether the Google Analytics data
was queried or not.< / p > < / li > < li > < p > < code class = "inline" > imported_source< / code > - the source of the imported data, when applicable.
Currently only Google Analytics is supported.< / p > < / li > < li > < p > < code class = "inline" > full_intervals< / code > - map of dates indicating whether the interval has been
cut off by the requested date range or not. For example, if looking at a
month week-by-week, some weeks may be cut off by the month boundaries.
It's useful to adjust the graph display slightly in case the interval is
not 'full' so that the user understands why the numbers might be lower for
2024-01-03 18:31:25 +03:00
those partial periods.< / p > < / li > < / ul > < p > Full example:< / p > < pre > < code class = "makeup elixir" translate = "no" > < span class = "p" data-group-id = "0823947114-1" > %{< / span > < span class = "w" >
< / span > < span class = "s" > " full_intervals" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "p" data-group-id = "0823947114-2" > %{< / span > < span class = "w" >
2023-07-12 11:28:07 +03:00
< / span > < span class = "s" > " 2021-09-01" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "no" > false< / span > < span class = "p" > ,< / span > < span class = "w" >
< / span > < span class = "s" > " 2021-10-01" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "no" > true< / span > < span class = "p" > ,< / span > < span class = "w" >
< / span > < span class = "s" > " 2021-11-01" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "no" > true< / span > < span class = "p" > ,< / span > < span class = "w" >
< / span > < span class = "s" > " 2021-12-01" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "no" > false< / span > < span class = "w" >
2024-01-03 18:31:25 +03:00
< / span > < span class = "p" data-group-id = "0823947114-2" > }< / span > < span class = "p" > ,< / span > < span class = "w" >
2023-07-12 11:28:07 +03:00
< / span > < span class = "s" > " imported_source" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "no" > nil< / span > < span class = "p" > ,< / span > < span class = "w" >
< / span > < span class = "s" > " interval" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "s" > " month" < / span > < span class = "p" > ,< / span > < span class = "w" >
2024-01-03 18:31:25 +03:00
< / span > < span class = "s" > " labels" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "p" data-group-id = "0823947114-3" > [< / span > < span class = "s" > " 2021-09-01" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s" > " 2021-10-01" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s" > " 2021-11-01" < / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "s" > " 2021-12-01" < / span > < span class = "p" data-group-id = "0823947114-3" > ]< / span > < span class = "p" > ,< / span > < span class = "w" >
< / span > < span class = "s" > " plot" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "p" data-group-id = "0823947114-4" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span > < span class = "w" > < / span > < span class = "mi" > 0< / span > < span class = "p" data-group-id = "0823947114-4" > ]< / span > < span class = "p" > ,< / span > < span class = "w" >
2023-07-12 11:28:07 +03:00
< / span > < span class = "s" > " present_index" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "no" > nil< / span > < span class = "p" > ,< / span > < span class = "w" >
< / span > < span class = "s" > " with_imported" < / span > < span class = "w" > < / span > < span class = "p" > => < / span > < span class = "w" > < / span > < span class = "no" > false< / span > < span class = "w" >
2024-01-03 18:31:25 +03:00
< / span > < span class = "p" data-group-id = "0823947114-1" > }< / span > < / code > < / pre >
2023-07-12 11:28:07 +03:00
< / section >
< / section >
< section class = "detail" id = "operating_system_versions/2" >
< div class = "detail-header" >
< a href = "#operating_system_versions/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > operating_system_versions(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L1099" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "operating_systems/2" >
< div class = "detail-header" >
< a href = "#operating_systems/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > operating_systems(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L1075" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "pages/2" >
< div class = "detail-header" >
< a href = "#pages/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > pages(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L778" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "referrer_drilldown/2" >
< div class = "detail-header" >
< a href = "#referrer_drilldown/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > referrer_drilldown(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L721" class = "icon-action" rel = "help" title = "View Source" >
2023-08-07 10:32:57 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "referrers/2" >
< div class = "detail-header" >
< a href = "#referrers/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > referrers(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L692" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "regions/2" >
< div class = "detail-header" >
< a href = "#regions/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > regions(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L950" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "screen_sizes/2" >
< div class = "detail-header" >
< a href = "#screen_sizes/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > screen_sizes(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L1113" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "sources/2" >
< div class = "detail-header" >
< a href = "#sources/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > sources(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L464" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "top_stats/2" >
< div class = "detail-header" >
< a href = "#top_stats/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > top_stats(conn, params)< / h1 >
2023-11-22 17:35:30 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L203" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "utm_campaigns/2" >
< div class = "detail-header" >
< a href = "#utm_campaigns/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > utm_campaigns(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L578" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "utm_contents/2" >
< div class = "detail-header" >
< a href = "#utm_contents/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > utm_contents(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L607" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "utm_mediums/2" >
< div class = "detail-header" >
< a href = "#utm_mediums/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > utm_mediums(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L549" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "utm_sources/2" >
< div class = "detail-header" >
< a href = "#utm_sources/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > utm_sources(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L663" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "utm_terms/2" >
< div class = "detail-header" >
< a href = "#utm_terms/2" class = "detail-link" title = "Link to this function" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
< h1 class = "signature" translate = "no" > utm_terms(conn, params)< / h1 >
2023-12-21 15:56:47 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible_web/controllers/api/stats_controller.ex#L635" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< / div >
< / section >
< footer class = "footer" >
< p >
< span class = "line" >
< button class = "a-main footer-button display-quick-switch" title = "Search HexDocs packages" >
Search HexDocs
< / button >
< a href = "Plausible.epub" title = "ePub version" >
Download ePub version
< / a >
< / span >
< / p >
< p class = "built-using" >
Built using
2023-07-25 10:58:48 +03:00
< a href = "https://github.com/elixir-lang/ex_doc" title = "ExDoc" target = "_blank" rel = "help noopener" translate = "no" > ExDoc< / a > (v0.30.3) for the
2023-07-12 11:28:07 +03:00
< a href = "https://elixir-lang.org" title = "Elixir" target = "_blank" translate = "no" > Elixir programming language< / a >
< / p >
< / footer >
< / div >
< / div >
< / section >
< / div >
< script src = "https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js" > < / script >
< script > mermaid . initialize ( { startOnLoad : true } ) < / script >
< / body >
< / html >
