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 Param	Purpose	Possible Values
start	Only show analytics data after this date	Any RFC3339 date string. e.g. 2006-01-02T15:04:05.000Z07:00
end	Only show analytics data before this date	Any RFC3339 date string. e.g. e.g. 2006-01-02T15:04:05.000Z07:00
language_code	Restrict 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_ip	Ignore any traffic with this IP address	Single IPv4 address or comma separated list. e.g. 192.168.0.1,255.255.255.0
anonymous_only	Only include traffic from logged out users, ignoring anyone signed in with a HelpDocs account.	"true", "false"
user_id	Only show traffic from these specific HelpDocs user_ids	Any 10-character alphanumeric user_id from your HelpDocs account, or a comma-separated list of user_ids.
article_id	Only show traffic to these articles	Any 10-character alphanumeric article_id from your HelpDocs account. You can retrieve these from the /article endpoint.
category_id	Only show traffic to any article in these categories	Any 10-character alphanumeric category_id from your HelpDocs account. You can retrieve these from the /category endpoint.

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 Param Purpose Possible Values start Only show analytics d…