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

Autorizaciones

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

Parámetros de ruta

site_idstringobligatorio
The id of a site from List sites.
reportstringobligatorio
The report to read.

Parámetros de consulta

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.

Encabezados

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.

Respuestas

The report named by report.

Encabezados

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.
- articlesintegerobligatorio
  The site's non-deleted articles, each counted once, drafts included.
- visitorsintegerobligatorio
- searchesintegerobligatorio
- reactionsintegerobligatorio
  Article reactions, the latest one per reader and article.
object
- visitorsobjectobligatorio
  Visitors. total is distinct visitors over the range, not the sum of the points.
  totalintegerobligatorio
  The total over the range.
  total_previousintegerobligatorio
  The total over the previous period.
  differenceintegerobligatorio
  total minus total_previous.
  percentage_differencenumberobligatorio
  The change from the previous period in percent, and 0.0 when the previous total is 0.
  currentobject[]obligatorio
  One point per bucket of the range.
  datestringobligatorio
  countintegerobligatorio
  previousobject[]obligatorio
  One point per bucket of the previous period.
  datestringobligatorio
  countintegerobligatorio
- article_viewsobjectobligatorio
  Article page views.
  totalintegerobligatorio
  The total over the range.
  total_previousintegerobligatorio
  The total over the previous period.
  differenceintegerobligatorio
  total minus total_previous.
  percentage_differencenumberobligatorio
  The change from the previous period in percent, and 0.0 when the previous total is 0.
  currentobject[]obligatorio
  One point per bucket of the range.
  datestringobligatorio
  countintegerobligatorio
  previousobject[]obligatorio
  One point per bucket of the previous period.
  datestringobligatorio
  countintegerobligatorio
- session_durationsobjectobligatorio
  The time readers spend on a page, in seconds.
  average_secondsnumberobligatorio
  The mean of the current points.
  currentobject[]obligatorio
  The mean time on a page during each bucket of the range.
  datestringobligatorio
  secondsnumberobligatorio
  previousobject[]obligatorio
  The mean time on a page during each bucket of the previous period.
  datestringobligatorio
  secondsnumberobligatorio
- top_countriesobject[]obligatorio
  The countries with the most visitors.
  countrystringobligatorio
  ISO 3166-1 alpha-2 code.
  country_namestringobligatorio
  visitorsintegerobligatorio
object
- searchesobjectobligatorio
  totalintegerobligatorio
  The total over the range.
  total_previousintegerobligatorio
  The total over the previous period.
  differenceintegerobligatorio
  total minus total_previous.
  percentage_differencenumberobligatorio
  The change from the previous period in percent, and 0.0 when the previous total is 0.
  currentobject[]obligatorio
  One point per bucket of the range.
  datestringobligatorio
  countintegerobligatorio
  previousobject[]obligatorio
  One point per bucket of the previous period.
  datestringobligatorio
  countintegerobligatorio
- searches_with_resultsobjectobligatorio
  Searches that returned at least one article. The totals cover every query, not only the listed ones.
  totalintegerobligatorio
  total_previousintegerobligatorio
  differenceintegerobligatorio
  percentage_differencenumberobligatorio
  queriesobject[]obligatorio
  Most searched first.
  querystringobligatorio
  What readers typed.
  searchesintegerobligatorio
  clicksintegerobligatorio
  Clicks on a result.
  articles_shownnumberobligatorio
  The mean number of articles each search returned.
  click_through_ratenumberobligatorio
  Clicks per search, in percent.
  avg_click_positionnumber | nullobligatorio
  The mean position of the clicked result; null when no result was clicked.
- searches_without_resultsobjectobligatorio
  Searches that returned nothing. The totals cover every query, not only the listed ones.
  totalintegerobligatorio
  total_previousintegerobligatorio
  differenceintegerobligatorio
  percentage_differencenumberobligatorio
  queriesobject[]obligatorio
  Most searched first.
  querystringobligatorio
  searchesintegerobligatorio
- click_through_rateobjectobligatorio
  The share of searches with results that led to a click, in percent.
  currentnumberobligatorio
  previousnumberobligatorio
  differencenumberobligatorio
  The difference in points.
  percentage_differencenumberobligatorio
  The change in percent.
object
- overviewobjectobligatorio
  currentobjectobligatorio
  viewsintegerobligatorio
  Article views.
  articles_to_reviseintegerobligatorio
  Articles with more than one view whose neutral and negative reactions exceed their positive reactions by more than one.
  reaction_summaryobjectobligatorio
  Reactions grouped the way the site's reaction style does.
  stylestringobligatorio
  totalintegerobligatorio
  All reactions.
  scoreintegerobligatorio
  0 to 100: the share of positive reactions, with a neutral reaction counting half under emoji.
  groupsobject[]obligatorio
  One entry per group, positive, neutral and negative for emoji, helpful and not_helpful for thumbs.
  keystringobligatorio
  countintegerobligatorio
  percentintegerobligatorio
  previousobjectobligatorio
  viewsintegerobligatorio
  Article views.
  articles_to_reviseintegerobligatorio
  Articles with more than one view whose neutral and negative reactions exceed their positive reactions by more than one.
  reaction_summaryobjectobligatorio
  Reactions grouped the way the site's reaction style does.
  stylestringobligatorio
  totalintegerobligatorio
  All reactions.
  scoreintegerobligatorio
  0 to 100: the share of positive reactions, with a neutral reaction counting half under emoji.
  groupsobject[]obligatorio
  One entry per group, positive, neutral and negative for emoji, helpful and not_helpful for thumbs.
  keystringobligatorio
  countintegerobligatorio
  percentintegerobligatorio
- article_viewsobjectobligatorio
  totalintegerobligatorio
  The total over the range.
  total_previousintegerobligatorio
  The total over the previous period.
  differenceintegerobligatorio
  total minus total_previous.
  percentage_differencenumberobligatorio
  The change from the previous period in percent, and 0.0 when the previous total is 0.
  currentobject[]obligatorio
  One point per bucket of the range.
  datestringobligatorio
  countintegerobligatorio
  previousobject[]obligatorio
  One point per bucket of the previous period.
  datestringobligatorio
  countintegerobligatorio
- top_articlesobject[]obligatorio
  The most viewed articles.
  titlestring | nullobligatorio
  hoststring | nullobligatorio
  pathnamestring | nullobligatorio
  viewsintegerobligatorio
- top_referrersobject[]obligatorio
  Where visitors came from.
  referrerstring | nullobligatorio
  The referring URL, or null for a direct visit.
  visitorsintegerobligatorio
- article_engagementsobject[]obligatorio
  The articles readers reacted to most positively.
  titlestring | nullobligatorio
  urlstring | nullobligatorio
  viewsintegerobligatorio
  reaction_summaryobjectobligatorio
  Reactions grouped the way the site's reaction style does.
  stylestringobligatorio
  totalintegerobligatorio
  All reactions.
  scoreintegerobligatorio
  0 to 100: the share of positive reactions, with a neutral reaction counting half under emoji.
  groupsobject[]obligatorio
  One entry per group, positive, neutral and negative for emoji, helpful and not_helpful for thumbs.
  keystringobligatorio
  countintegerobligatorio
  percentintegerobligatorio
- articles_to_reviseobject[]obligatorio
  The articles readers reacted to most negatively.
  titlestring | nullobligatorio
  urlstring | nullobligatorio
  viewsintegerobligatorio
  reaction_summaryobjectobligatorio
  Reactions grouped the way the site's reaction style does.
  stylestringobligatorio
  totalintegerobligatorio
  All reactions.
  scoreintegerobligatorio
  0 to 100: the share of positive reactions, with a neutral reaction counting half under emoji.
  groupsobject[]obligatorio
  One entry per group, positive, neutral and negative for emoji, helpful and not_helpful for thumbs.
  keystringobligatorio
  countintegerobligatorio
  percentintegerobligatorio