Retrieve reader feedback statistics
Example request
Generated- cURL
- JavaScript
- TypeScript
- Python
- PHP
- Go
- Java
- Ruby
- C#
Responses
Reader reactions for the account as a whole and per article, over the window.
Authentication
-
-
ApiKeyBearerhttpbearerAn API key sent as
Authorization: Bearer <key>. A key holds scopes, the same ones OAuth uses, and an operation needs the scope listed for it under OAuth2. A key may also expire, or be revoked or rotated in Settings > API, after which it is refused with a 401.
-
-
-
OAuth2oauth2An OAuth 2.0 access token for an app acting on behalf of a HelpDocs user, sent as
Authorization: Bearer <token>. The authorization code flow requires PKCE (S256). Each operation names the one scope it needs.
-
Query parameters
-
startstringStart of the window (RFC 3339). Defaults to the last 30 days.
-
endstringEnd of the window (RFC 3339).
-
limitintegerMaximum number of articles to return.
-
category_idstringRestrict to articles in this category.
-
language_codestringRestrict to this translation.
See more 9
-
is_botbooleanInclude views attributed to bots.
-
spam_filterbooleanExclude views classified as spam.
-
article_idstringRestrict to these articles. Accepts a comma-separated list of ids.
-
user_idstringRestrict to views by these users. Accepts a comma-separated list of ids.
-
group_idstringRestrict to readers in this permission group.
-
group_bystringThe dimension to group by. Defaults to date_string, which gives a daily series; article_id, category_id, user_id, user_agent_browser, user_agent_os, and ip_range group by that field instead.
-
anonymous_onlybooleanOnly views by readers who were not signed in.
-
exclude_ipstringIgnore views from these addresses. Accepts a comma-separated list.
-
data_sourcestringOnly count events from this surface. An unrecognised value is ignored, which counts every surface.
Responses
The aggregate and per-article breakdowns.
application/json
AnalyticsFeedbackResponse
Authentication failed or no API key was supplied.
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
The key lacks read permission, or the account’s plan does not include API access.
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
Rate limited. Wait the number of seconds in Retry-After before trying again. X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset say which allowance was spent and when it refills.
-
Retry-Afterinteger -
X-RateLimit-Limitinteger -
X-RateLimit-Remaininginteger -
X-RateLimit-Resetinteger
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.