For the complete documentation index, see llms.txt. This page is also available as Markdown.

Changelog

[v3] New endpoints: Job Management

When you need to export a large amount of data from impact.com, such as a detailed performance report, requesting all the data at once can lead to timeouts or API rate-limiting errors. You can use the Jobs endpoint to schedule a job to extract data and fetch the results once complete. Jobs will protect you from hitting rate limits and will ensure a smoother data retrieval experience.

[v3] Scoped Tokens

impact.com lets you create scoped tokens: API credentials with detailed, fine-tuned permissions that limit or allow access to specific API endpoints. This improves security, enhances access control, and simplifies token management.

To get started, explore:

[v3] Migrate to ReportExport

If you export large volumes of report data via the impact.com API, now is the time to switch to the more efficient ReportExport API endpoint—especially with upcoming limits to the legacy Reports API on September 1, 2025.

[v3] Ensure your data is always fresh!

Previously, you may have run the risk of receiving incorrect or outdated information if your client cached data in your API requests, especially for dynamic, user-specific, or time-sensitive data. You will now receive the following header values to indicate to your client that the response data from your queries should not be cached, and ensure that you always fetch the latest data:

Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0

Ensure that your data is always fresh by checking that your API client expects these new header values. This update will affect all headers.

[v3] Changes to the Reports endpoint pagination

After 2 October 2023, any requests made to the /Reports API endpoint that specify a page size other than 20,000 will return a page size of exactly 20,000 records. If any of your integrations with the /Reports API specifies a page size less than 20,000, we recommend either of the following updates:

  • Specify a PageSize of 20,000.

  • Remove the PageSize parameter from the request altogether.

[v2] New endpoint: Export a Report

There is a new endpoint in the reports section of our API reference documentation.

The ReportExport endpoint schedules a job to export reports asynchronously.

Last updated