Create raw brand posts export

Details

Runs a Raw Brand Posts export. See Analytics Reports API quickstart for more details.

👍

Tip

We support both GET and POST methods with this endpoint, although we recommend using POST. If you use the POST method, pass all parameters in the request body except for companyKey.

Export raw brand posts data from Publishing Analytics in CSV or JSON format. Learn more about the Raw Brand Posts export.

📘

Note

In the February 2019 release, we changed the endpoint from raw-brand-posts to raw_brand_posts for consistency with other export type names. We will continue supporting calls that use raw-brand-posts endpoint path.

The workflowId and the runId in the response are unique IDs specific to this export job. The IDs are used by the /reports/report/workflowId/runId/status and /reports/report/workflowId/runId/download endpoints to check the status of an export job and to download it.

Make a GET request to the /reports/report/<workflowId>/<runId>/status endpoint as shown in the statusUrl field to check the status of the job. When the result.runnerState is CLOSED and result.detail is COMPLETED in the response to /reports/report/<workflowId>/<runId>/status, you are ready to run the endpoint in the downloadUrl. An empty value for downloadUrl indicates that the export has not ready.

Make a GET request to the /reports/report/workflowId/runId/download endpoint as shown in the downloadUrl field to download the export locally.

See Using timezone with timezoneOffset when making a request with these parameters.

See Define columns to return in an export to learn how to specify a limited set of columns to return in the export.