Filtering Stats

You can filter the stats you receive from any of our API endpoints by adding query parameters to your request. Here's what's available:

Query ParamPurposePossible Values
startOnly show analytics data after this dateAny RFC3339 date string. e.g. 2006-01-02T15:04:05.000Z07:00
endOnly show analytics data before this dateAny RFC3339 date string. e.g. e.g. 2006-01-02T15:04:05.000Z07:00
language_codeRestrict analytics returned to just that language_code (on multilingual accounts). Default is to return all languages.Any 2-digit language code that you have enabled in your account.
exclude_ipIgnore any traffic with this IP addressSingle IPv4 address or comma separated list. e.g.,
anonymous_onlyOnly include traffic from logged out users, ignoring anyone signed in with a HelpDocs account."true", "false"
user_idOnly show traffic from these specific HelpDocs user_idsAny 10-character alphanumeric user_id from your HelpDocs account, or a comma-separated list of user_ids.
article_idOnly show traffic to these articlesAny 10-character alphanumeric article_id from your HelpDocs account. You can retrieve these from the /article endpoint.
category_idOnly show traffic to any article in these categoriesAny 10-character alphanumeric category_id from your HelpDocs account. You can retrieve these from the /category endpoint.

How did we do?