These endpoints are designed to handle queries for high volumes of data and return results within 5 minutes. For quicker response times and low volumes of data, use the Synchronous endpoints.

📘

Note

Results from querying the asynchronous endpoints are in the form of a CSV. Refer to the CSV Response Parsing section for tips on parsing the results.

There are two options to obtain a CSV report asynchronously:

1. Submit a request to an asynchronous endpoint and immediately receive a report download link. Poll a second endpoint until your report is ready at that download link.
2. Submit a request to an asynchronous endpoint and wait to receive an email containing the report.

🚧

Limitation

Currently, CSV reports larger than 400MB will fail. Please refer to the Querying Guidelines section for tips on managing report size.

---

asyncDownloadPublisherNetworkReport

This endpoint is used in Option 1, above. This endpoint uses the same parameters as the synchronous publisherNetworkReport endpoint (without the pagination-related fields cursor and size) and responds with a download link in the form of a pre-signed S3 URL.

🚧

Limitation

The pre-signed S3 URL expires 30 minutes after it is returned.

Sample request:

Sample response:

asyncDownloadReportStatus

This is the polling endpoint mentioned in Option 1. It accepts the pre-signed S3 link in the response from asyncDownloadPublisherNetworkReport and returns one of 3 possible status strings:

• READY - the report is present in the download link
• WAITING - the report is not ready yet
• ERROR - the report request must be resubmitted

📘

Note

Please refer to the GraphQL schema for this endpoint's status refresh rate to help define your poll interval.

asyncEmailPublisherNetworkReport

This endpoint is used in Option 2. It uses in the same parameters as the synchronous publisherNetworkReport endpoint (without the pagination-related fields cursor and size), as well as a list of valid email addresses for the report recipients. It returns true if the request was successfully received, and false otherwise.

🚧

Limitation

Note that asyncEmailPublisherNetworkReport has an email size limit of 10MB. Any email exceeding the limit will fail to send.

Sample request:

Sample response: