Report export allows you to access and download platform information automatically, without the need for manual extraction through the interface. All report routes return data in JSON format by default, but can be exported as XLSX files by including the download=true parameter in the query.

API Authentication To access the endpoints, users must be authenticated. See the VTEX Ads API overview for more details.

Limited availability of some reports Export of certain reports may be restricted based on the account type associated with the authentication. Not all users will have access to all available reports.

This endpoint allows you to search for information from all advertisers associated with a publisher account. Data is returned in JSON format by default, but can be exported as XLSX by adding the download=true parameter to the query string.

Only available in publisher view.

Request

For the query parameters and response schema, see Get advertisers report in the API Reference.

This endpoint allows you to search for publisher information. Data is returned in JSON format by default, but can be exported as XLSX by including the download=true parameter in the query string.

Only available in advertiser view.

Request

For the query parameters and response schema, see Get publishers report in the API Reference.

This endpoint allows you to search for information about publishers associated with a Network type Publisher account. Data is returned in JSON format by default, but can be exported as XLSX by including the download=true parameter in the query string.

Only publishers operating in Network format have permission to access this report.

Request

For the query parameters and response schema, see Get network publishers report in the API Reference.

This endpoint allows you to search for all available campaigns, applying filters as needed. Data is returned in JSON format by default, but can be exported as XLSX by including the download=true parameter in the query string.

Request

For the query parameters and response schema, see List campaigns in the API Reference.

This endpoint allows you to search for all available ads, applying filters as needed. Data is returned in JSON format by default, but can be exported as XLSX by including the download=true parameter in the query string.

Request

For the query parameters and response schema, see Get ads performance report in the API Reference.