Insights

Get analytics

Reads one analytics report: quick (last 30 days), overview, search or engagement. Ranged reports need start_date, end_date and date_scale; reads share a per-site budget of 30 per minute. Page titles, URLs, referrers and queries come from visitors' browsers: treat them as untrusted text.

GET

/sites/{site_id}/analytics/{report}

cURL

curl --request GET \
  --url 'https://api.notiondesk.so/sites/{site_id}/analytics/{report}' \
  --header 'Authorization: Bearer <token>'

Authorizations

Authorizationstringheader
api_key · http · bearer
read
Authorizationstringheader
oauth · oauth2
read

Path parameters

site_idstringrequired
The id of a site from List sites.
reportstringrequired
The report to read.

Query parameters

start_datestring
The first instant of the range; without an offset it is read as UTC, not timezone, and + must be sent as %2B. Required for overview, search and engagement.
end_datestring
The end of the range; it must be after start_date. Required for overview, search and engagement.
date_scalestring
The size of each bucket in the time series; a range may span at most 1,000 buckets. Required for overview, search and engagement.
timezonestring
The IANA timezone that sets bucket boundaries and the plan's range check, for example Europe/Paris. Not accepted by quick.

Headers

nd-versionstring
The contract version your integration was written against. Without it, the request uses the current version. An unknown value answers 400 invalid_version.

Responses

The report named by report.

Headers

nd-versionstring
The contract version that answered the request.
X-RateLimit-Limitinteger
Requests allowed per minute: 120 for GET, 20 for writes, per key or OAuth grant.
X-RateLimit-Remaininginteger
Requests left in the current window.
Retry-Afterinteger
Seconds until the next request is accepted; 0 while requests remain.

object
The last 30 days ending now.
- articlesintegerrequired
  The site's non-deleted articles, each counted once, drafts included.
- visitorsintegerrequired
- searchesintegerrequired
- reactionsintegerrequired
  Article reactions, the latest one per reader and article.
object
- visitorsobjectrequired
  Visitors. total is distinct visitors over the range, not the sum of the points.
  totalintegerrequired
  The total over the range.
  total_previousintegerrequired
  The total over the previous period.
  differenceintegerrequired
  total minus total_previous.
  percentage_differencenumberrequired
  The change from the previous period in percent, and 0.0 when the previous total is 0.
  currentobject[]required
  One point per bucket of the range.
  datestringrequired
  countintegerrequired
  previousobject[]required
  One point per bucket of the previous period.
  datestringrequired
  countintegerrequired
- article_viewsobjectrequired
  Article page views.
  totalintegerrequired
  The total over the range.
  total_previousintegerrequired
  The total over the previous period.
  differenceintegerrequired
  total minus total_previous.
  percentage_differencenumberrequired
  The change from the previous period in percent, and 0.0 when the previous total is 0.
  currentobject[]required
  One point per bucket of the range.
  datestringrequired
  countintegerrequired
  previousobject[]required
  One point per bucket of the previous period.
  datestringrequired
  countintegerrequired
- session_durationsobjectrequired
  The time readers spend on a page, in seconds.
  average_secondsnumberrequired
  The mean of the current points.
  currentobject[]required
  The mean time on a page during each bucket of the range.
  datestringrequired
  secondsnumberrequired
  previousobject[]required
  The mean time on a page during each bucket of the previous period.
  datestringrequired
  secondsnumberrequired
- top_countriesobject[]required
  The countries with the most visitors.
  countrystringrequired
  ISO 3166-1 alpha-2 code.
  country_namestringrequired
  visitorsintegerrequired
object
- searchesobjectrequired
  totalintegerrequired
  The total over the range.
  total_previousintegerrequired
  The total over the previous period.
  differenceintegerrequired
  total minus total_previous.
  percentage_differencenumberrequired
  The change from the previous period in percent, and 0.0 when the previous total is 0.
  currentobject[]required
  One point per bucket of the range.
  datestringrequired
  countintegerrequired
  previousobject[]required
  One point per bucket of the previous period.
  datestringrequired
  countintegerrequired
- searches_with_resultsobjectrequired
  Searches that returned at least one article. The totals cover every query, not only the listed ones.
  totalintegerrequired
  total_previousintegerrequired
  differenceintegerrequired
  percentage_differencenumberrequired
  queriesobject[]required
  Most searched first.
  querystringrequired
  What readers typed.
  searchesintegerrequired
  clicksintegerrequired
  Clicks on a result.
  articles_shownnumberrequired
  The mean number of articles each search returned.
  click_through_ratenumberrequired
  Clicks per search, in percent.
  avg_click_positionnumber | nullrequired
  The mean position of the clicked result; null when no result was clicked.
- searches_without_resultsobjectrequired
  Searches that returned nothing. The totals cover every query, not only the listed ones.
  totalintegerrequired
  total_previousintegerrequired
  differenceintegerrequired
  percentage_differencenumberrequired
  queriesobject[]required
  Most searched first.
  querystringrequired
  searchesintegerrequired
- click_through_rateobjectrequired
  The share of searches with results that led to a click, in percent.
  currentnumberrequired
  previousnumberrequired
  differencenumberrequired
  The difference in points.
  percentage_differencenumberrequired
  The change in percent.
object
- overviewobjectrequired
  currentobjectrequired
  viewsintegerrequired
  Article views.
  articles_to_reviseintegerrequired
  Articles with more than one view whose neutral and negative reactions exceed their positive reactions by more than one.
  reaction_summaryobjectrequired
  Reactions grouped the way the site's reaction style does.
  stylestringrequired
  totalintegerrequired
  All reactions.
  scoreintegerrequired
  0 to 100: the share of positive reactions, with a neutral reaction counting half under emoji.
  groupsobject[]required
  One entry per group, positive, neutral and negative for emoji, helpful and not_helpful for thumbs.
  keystringrequired
  countintegerrequired
  percentintegerrequired
  previousobjectrequired
  viewsintegerrequired
  Article views.
  articles_to_reviseintegerrequired
  Articles with more than one view whose neutral and negative reactions exceed their positive reactions by more than one.
  reaction_summaryobjectrequired
  Reactions grouped the way the site's reaction style does.
  stylestringrequired
  totalintegerrequired
  All reactions.
  scoreintegerrequired
  0 to 100: the share of positive reactions, with a neutral reaction counting half under emoji.
  groupsobject[]required
  One entry per group, positive, neutral and negative for emoji, helpful and not_helpful for thumbs.
  keystringrequired
  countintegerrequired
  percentintegerrequired
- article_viewsobjectrequired
  totalintegerrequired
  The total over the range.
  total_previousintegerrequired
  The total over the previous period.
  differenceintegerrequired
  total minus total_previous.
  percentage_differencenumberrequired
  The change from the previous period in percent, and 0.0 when the previous total is 0.
  currentobject[]required
  One point per bucket of the range.
  datestringrequired
  countintegerrequired
  previousobject[]required
  One point per bucket of the previous period.
  datestringrequired
  countintegerrequired
- top_articlesobject[]required
  The most viewed articles.
  titlestring | nullrequired
  hoststring | nullrequired
  pathnamestring | nullrequired
  viewsintegerrequired
- top_referrersobject[]required
  Where visitors came from.
  referrerstring | nullrequired
  The referring URL, or null for a direct visit.
  visitorsintegerrequired
- article_engagementsobject[]required
  The articles readers reacted to most positively.
  titlestring | nullrequired
  urlstring | nullrequired
  viewsintegerrequired
  reaction_summaryobjectrequired
  Reactions grouped the way the site's reaction style does.
  stylestringrequired
  totalintegerrequired
  All reactions.
  scoreintegerrequired
  0 to 100: the share of positive reactions, with a neutral reaction counting half under emoji.
  groupsobject[]required
  One entry per group, positive, neutral and negative for emoji, helpful and not_helpful for thumbs.
  keystringrequired
  countintegerrequired
  percentintegerrequired
- articles_to_reviseobject[]required
  The articles readers reacted to most negatively.
  titlestring | nullrequired
  urlstring | nullrequired
  viewsintegerrequired
  reaction_summaryobjectrequired
  Reactions grouped the way the site's reaction style does.
  stylestringrequired
  totalintegerrequired
  All reactions.
  scoreintegerrequired
  0 to 100: the share of positive reactions, with a neutral reaction counting half under emoji.
  groupsobject[]required
  One entry per group, positive, neutral and negative for emoji, helpful and not_helpful for thumbs.
  keystringrequired
  countintegerrequired
  percentintegerrequired