Stats API 
To get aggregated statistics out of our API we created a Stats API. Basically it’s the data you see in our dashboard. This API is useful for when you want to integrate Simple Analytics into your own systems. For example when embedding your data into a customized dashboard within your own website.
The data you get through this API is aggregated. If you are looking for raw data you can use our Export page views API.
For this API you need to be autenticated with an API key. If your website is set to public you can get the JSON data without any credentials.
You can find the Stats API by adding .json
to the URL of your dashboard in Simple Analytics. For example for our website it will be https://simpleanalytics.com/simpleanalytics.com.json?version=5&fields=histogram
.
Query parameters
We have a list of query parameters that you can use with this API:
version
the version of the API (the latest version is5
)start
the start date with this formatYYYY-MM-DD
(defaults to 1 month ago)end
the end data with above format (defaults to today)limit
a limit for the fields (1-1000)timezone
a valid time zone likeEurope/Amsterdam
(with capitals)info
shows more information about fields in the response (defaults to true)callback
wraps the response in a callback for JSONPfields
a comma seperated list of fields you want to get returned:pageviews
the total amount of page views in the specified periodvisitors
the total amount of visitors (unique page views) in the specified periodhistogram
an array with page views and visitors per daypages
a comma seperated list of pages you want to get stats forcountries
a list of country codesreferrers
a list of referrers (normalized)utm_sources
a list of UTM sourcesutm_mediums
a list of UTM mediumsutm_campaigns
a list of UTM campaignsutm_contents
a list of UTM contentsutm_terms
a list of UTM termsbrowser_names
a list of browser namesos_names
a list of OS namesdevice_types
a list of device types (mobile, tablet, desktop, tv)seconds_on_page
the median of seconds a visitor spent on the page (see more)
For filtering you can use:
page
filter by a pagepages
filter by a comma separated list of pages (/contact,/product/*
)country
filter by a country codereferrer
filter by a referrer (normalized)utm_source
filter by a UTM sourceutm_medium
filter by a UTM mediumutm_campaign
filter by a UTM campaignutm_content
filter by a UTM contentutm_term
filter by a UTM termbrowser_name
filter by a browser nameos_name
filter by a OS namedevice_type
filter by a device type (mobile, tablet, desktop, tv)
Get data for specific pages
With the Stats API you can also retrieve data for a specific page of your website. You can specify this via the pages
parameter: https://simpleanalytics.com/simpleanalytics.com.json?version=5&fields=histogram&pages=/contact
).
You can also add the path to the URL and Simple Analytics returns the data for only that path. For example if you want to know how many visits you got on simpleanalytics.com/contact
, you can get the JSON with this URL: https://simpleanalytics.com/simpleanalytics.com/contact.json?version=5&fields=histogram
).
Wildcards
The filtering parameters support wildcard searches. It’s as easy as adding an *
at the end of your parameter value. If you want to search for pages that have a path that starts with /web
you can get it via https://simpleanalytics.com/simpleanalytics.com.json?version=5&fields=pages&pages=/web*
). If you want all pages that contains a word in their path you should use https://simpleanalytics.com/simpleanalytics.com.json?version=5&fields=pages&pages=*terms*
).
Time on page
To get the median of time on page you can use the field seconds_on_page
. This field is a bit more special than the rest. It also includes the seconds_on_page
within results you select with other fields. For example, when you select some pages with it:
https://simpleanalytics.com/simpleanalytics.com.json?version=5&fields=pages,seconds_on_page&pages=/,/contact
It returns:
{
...
"seconds_on_page": 26,
"pages": [
{
"value": "/",
"pageviews": 100,
"visitors": 50,
"seconds_on_page": 25
},
{
"value": "/contact",
"pageviews": 60,
"visitors": 30,
"seconds_on_page": 20
}
]
}
Note the seconds_on_page
being part of the pages
and part of the root of the JSON response. We have an explainer on time on page which goes into more detail about the metric and why we did choose to make it a median instead of average.
CORS and JSONP
By default we allow requests from any website. Some customers want to use JSONP for their requests. Learn more about how to use JSONP with Simple Analytics.