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>'

Autoryzacje

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

Parametry ścieżki

site_idstringwymagane
The id of a site from List sites.
reportstringwymagane
The report to read.

Parametry zapytania

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.

Nagłówki

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.

Odpowiedzi

The report named by report.

Nagłówki

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.
- articlesintegerwymagane
  The site's non-deleted articles, each counted once, drafts included.
- visitorsintegerwymagane
- searchesintegerwymagane
- reactionsintegerwymagane
  Article reactions, the latest one per reader and article.
object
- visitorsobjectwymagane
  Visitors. total is distinct visitors over the range, not the sum of the points.
  totalintegerwymagane
  The total over the range.
  total_previousintegerwymagane
  The total over the previous period.
  differenceintegerwymagane
  total minus total_previous.
  percentage_differencenumberwymagane
  The change from the previous period in percent, and 0.0 when the previous total is 0.
  currentobject[]wymagane
  One point per bucket of the range.
  datestringwymagane
  countintegerwymagane
  previousobject[]wymagane
  One point per bucket of the previous period.
  datestringwymagane
  countintegerwymagane
- article_viewsobjectwymagane
  Article page views.
  totalintegerwymagane
  The total over the range.
  total_previousintegerwymagane
  The total over the previous period.
  differenceintegerwymagane
  total minus total_previous.
  percentage_differencenumberwymagane
  The change from the previous period in percent, and 0.0 when the previous total is 0.
  currentobject[]wymagane
  One point per bucket of the range.
  datestringwymagane
  countintegerwymagane
  previousobject[]wymagane
  One point per bucket of the previous period.
  datestringwymagane
  countintegerwymagane
- session_durationsobjectwymagane
  The time readers spend on a page, in seconds.
  average_secondsnumberwymagane
  The mean of the current points.
  currentobject[]wymagane
  The mean time on a page during each bucket of the range.
  datestringwymagane
  secondsnumberwymagane
  previousobject[]wymagane
  The mean time on a page during each bucket of the previous period.
  datestringwymagane
  secondsnumberwymagane
- top_countriesobject[]wymagane
  The countries with the most visitors.
  countrystringwymagane
  ISO 3166-1 alpha-2 code.
  country_namestringwymagane
  visitorsintegerwymagane
object
- searchesobjectwymagane
  totalintegerwymagane
  The total over the range.
  total_previousintegerwymagane
  The total over the previous period.
  differenceintegerwymagane
  total minus total_previous.
  percentage_differencenumberwymagane
  The change from the previous period in percent, and 0.0 when the previous total is 0.
  currentobject[]wymagane
  One point per bucket of the range.
  datestringwymagane
  countintegerwymagane
  previousobject[]wymagane
  One point per bucket of the previous period.
  datestringwymagane
  countintegerwymagane
- searches_with_resultsobjectwymagane
  Searches that returned at least one article. The totals cover every query, not only the listed ones.
  totalintegerwymagane
  total_previousintegerwymagane
  differenceintegerwymagane
  percentage_differencenumberwymagane
  queriesobject[]wymagane
  Most searched first.
  querystringwymagane
  What readers typed.
  searchesintegerwymagane
  clicksintegerwymagane
  Clicks on a result.
  articles_shownnumberwymagane
  The mean number of articles each search returned.
  click_through_ratenumberwymagane
  Clicks per search, in percent.
  avg_click_positionnumber | nullwymagane
  The mean position of the clicked result; null when no result was clicked.
- searches_without_resultsobjectwymagane
  Searches that returned nothing. The totals cover every query, not only the listed ones.
  totalintegerwymagane
  total_previousintegerwymagane
  differenceintegerwymagane
  percentage_differencenumberwymagane
  queriesobject[]wymagane
  Most searched first.
  querystringwymagane
  searchesintegerwymagane
- click_through_rateobjectwymagane
  The share of searches with results that led to a click, in percent.
  currentnumberwymagane
  previousnumberwymagane
  differencenumberwymagane
  The difference in points.
  percentage_differencenumberwymagane
  The change in percent.
object
- overviewobjectwymagane
  currentobjectwymagane
  viewsintegerwymagane
  Article views.
  articles_to_reviseintegerwymagane
  Articles with more than one view whose neutral and negative reactions exceed their positive reactions by more than one.
  reaction_summaryobjectwymagane
  Reactions grouped the way the site's reaction style does.
  stylestringwymagane
  totalintegerwymagane
  All reactions.
  scoreintegerwymagane
  0 to 100: the share of positive reactions, with a neutral reaction counting half under emoji.
  groupsobject[]wymagane
  One entry per group, positive, neutral and negative for emoji, helpful and not_helpful for thumbs.
  keystringwymagane
  countintegerwymagane
  percentintegerwymagane
  previousobjectwymagane
  viewsintegerwymagane
  Article views.
  articles_to_reviseintegerwymagane
  Articles with more than one view whose neutral and negative reactions exceed their positive reactions by more than one.
  reaction_summaryobjectwymagane
  Reactions grouped the way the site's reaction style does.
  stylestringwymagane
  totalintegerwymagane
  All reactions.
  scoreintegerwymagane
  0 to 100: the share of positive reactions, with a neutral reaction counting half under emoji.
  groupsobject[]wymagane
  One entry per group, positive, neutral and negative for emoji, helpful and not_helpful for thumbs.
  keystringwymagane
  countintegerwymagane
  percentintegerwymagane
- article_viewsobjectwymagane
  totalintegerwymagane
  The total over the range.
  total_previousintegerwymagane
  The total over the previous period.
  differenceintegerwymagane
  total minus total_previous.
  percentage_differencenumberwymagane
  The change from the previous period in percent, and 0.0 when the previous total is 0.
  currentobject[]wymagane
  One point per bucket of the range.
  datestringwymagane
  countintegerwymagane
  previousobject[]wymagane
  One point per bucket of the previous period.
  datestringwymagane
  countintegerwymagane
- top_articlesobject[]wymagane
  The most viewed articles.
  titlestring | nullwymagane
  hoststring | nullwymagane
  pathnamestring | nullwymagane
  viewsintegerwymagane
- top_referrersobject[]wymagane
  Where visitors came from.
  referrerstring | nullwymagane
  The referring URL, or null for a direct visit.
  visitorsintegerwymagane
- article_engagementsobject[]wymagane
  The articles readers reacted to most positively.
  titlestring | nullwymagane
  urlstring | nullwymagane
  viewsintegerwymagane
  reaction_summaryobjectwymagane
  Reactions grouped the way the site's reaction style does.
  stylestringwymagane
  totalintegerwymagane
  All reactions.
  scoreintegerwymagane
  0 to 100: the share of positive reactions, with a neutral reaction counting half under emoji.
  groupsobject[]wymagane
  One entry per group, positive, neutral and negative for emoji, helpful and not_helpful for thumbs.
  keystringwymagane
  countintegerwymagane
  percentintegerwymagane
- articles_to_reviseobject[]wymagane
  The articles readers reacted to most negatively.
  titlestring | nullwymagane
  urlstring | nullwymagane
  viewsintegerwymagane
  reaction_summaryobjectwymagane
  Reactions grouped the way the site's reaction style does.
  stylestringwymagane
  totalintegerwymagane
  All reactions.
  scoreintegerwymagane
  0 to 100: the share of positive reactions, with a neutral reaction counting half under emoji.
  groupsobject[]wymagane
  One entry per group, positive, neutral and negative for emoji, helpful and not_helpful for thumbs.
  keystringwymagane
  countintegerwymagane
  percentintegerwymagane