DNSFilter icon

DNSFilter

**Note:** If you are a distributor integrating with DNSFilter, please check out our [Distributors Development Guide](/docs/distributors).### Authentication- Authentication is required for most, but not all, endpoints.- Authentication is done by setting the `Authorization` request header. The header value is the API key itself. For example: `Authorization: eyJ...`- An API key can be obtained through the DNSFilter dashboard under Account Settings. For additional information see [this KB article](https://help.dnsfilter.com/hc/en-us/articles/21169189058323-API-Tokens).### Rate Limiting- All endpoints are rate limited.- The limits may vary by endpoint, but are generally consistent.- When the rate limit is exceeded the API will return the standard `429` HTTP status.- The following headers will also be provided in the response: `Retry-After`, `RateLimit-Policy`, `RateLimit`, `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset`. For details on the values of these headers, see the following articles [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After), [here](https://www.ietf.org/archive/id/draft-ietf-httpapi-ratelimit-headers-08.html), and [here](https://www.ietf.org/archive/id/draft-polli-ratelimit-headers-05.html).- For additional information see [this KB article](https://help.dnsfilter.com/hc/en-us/articles/38202811088403-API-Rate-Limits).### Error Handling- The API uses standard HTTP status codes to indicate success or failure.- For _V1_ endpoints the response format is: ```json { "error": "string", "type": "string(optional)" } ```- For _V2_ endpoints the response format is: ```json { "error": { "message": "string", "type": "string(optional)" } } ```### PaginationFor the _V1_ endpoints, the pagination parameters are nested. That is to say,if passed as JSON they look like this: `{"page[number]": 1, "page[size]": 10}`.To pass this information in the URL query string, it would be formatted likethis: `...?page%5Bnumber%5D=1&page%5Bsize%5D=10`.In this guide, the UI will indicate that `page` is an `object` and if youwant to set values when trying the request, you must enter it as if it wasthe JSON above.### A Quick ExampleThe following will return information about the currentlyauthenticated user.```bash% curl -H 'Authorization: ***' https://api.dnsfilter.com/v1/users/self{ "data": { "id": "12345", "type": "users", "attributes": { "name": "John Doe", "email": "john@example.com", ...additional fields...}}}```
Join our community

Actions328

Overview

This node operation fetches the total number of requests by collection for users over a specified period of time from the DNSFilter API. It is useful for analyzing user activity within specific collections, such as monitoring network traffic or security events related to user collections. For example, a network administrator can use this to get detailed request counts for user groups to identify usage patterns or potential security issues.

Use Case Examples

  1. Retrieve total collection requests for users in a specific time range to analyze network usage.
  2. Fetch request counts filtered by agent IDs and application IDs to monitor user activity in collections.

Properties

Name Meaning
Return All Whether to return all results or only a single page. When disabled, no pagination parameters are sent and only one page of results is returned.
Additional Fields Optional filters and parameters to refine the report, such as agent IDs, agent types, application IDs, bucket size, collection IDs, date range, MAC addresses, network IDs, organization IDs, private IP range, security report flag, grouping options, traffic source, report type, and user IDs.

Output

JSON

  • debug - Debug information including actual URL, query parameters, headers, and body sent for each API request (if debug option is enabled).
  • * - The JSON response from the DNSFilter API for the total collection requests by users report.

Dependencies

  • DNSFilter API key credential

Troubleshooting

  • Ensure the DNSFilter API key credential is correctly configured and has the necessary permissions.
  • Verify that the input parameters such as collection IDs, user IDs, and date ranges are correctly formatted and valid.
  • If pagination is enabled, check the pagination settings to ensure all pages are fetched as expected.
  • Enable the debug option to get detailed request and response information for troubleshooting API call issues.

Links

Discussion