Skip to contentDevelopersPrezly website
Campaigns

Export Campaign Report

Start a CSV export for a selected campaign report view.

Personal tokens are not supported for this endpoint. Use an integration API key. Your account must also have access to the requested data. Authentication

Returns 202 with background-job progress. Poll Jobs with an integration key; an accepted request does not contain the completed CSV.

Read the guide

POST
/campaigns/{campaign_id}/reports/{view}/export

Start a CSV export for the selected campaign report view. Returns background job progress; poll using an integration key. Personal access tokens are not supported.

Personal access tokens are not supported for this endpoint. Use an integration API key with the required permissions.

Authorization

API_key
headerAuthorizationBearer <token>

Bearer authentication using an integration API key, or a personal access token only where the operation explicitly supports it. Every listed personal-token scope is required; owner permissions and newsroom access still apply.

Path Parameters

campaign_id*integer
view*string
Value in"recipients""sent""delivered""clicked""opened""unopened""undelivered""unsubscribed"

Query Parameters

sort?string
Match[-+]?(\w+\.)*\w+

Response Body

Export accepted for background processing

application/json
  1. response

Such responses are returned when the request was validated and understood, but is too large to fulfill within the response timeout. In that case a background job is pushed and a 202 Accepted response is generated containing Job ID. Job ID can be used with Jobs API to check status for.

status*"accepted"
Value in"accepted"
progress*

Background Job Reference object

Example Request
curl -X POST 'https://api.prezly.com/v2/campaigns/0/reports/recipients/export'
Example Response202
{  "status": "accepted",  "progress": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "links": [      "http://example.com"    ]  }}