Download audience files

get

https://api.delivr.ai/api/v1/audiences/{id}/download

Return presigned S3 links for the audience's output files. If the files are not yet ready, the response indicates the current status and an unload is triggered automatically. Keep polling until status is ready or failed; large builds can take longer than a fixed client timeout. Preparation continues on the server if a client stops polling.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Audience ID.

Query Params

project_id

uuid

Project ID (UUID). Every audience operation except GET /api/v1/audiences/schema is scoped to a project: send this parameter or the X-Project-Id header. Without either the request returns 400 with project_id is required.

format

string

enum

Defaults to parquet

Output format. parquet (default) returns presigned links to the raw parquet files. csv returns a presigned link to a server-converted, gzipped CSV of the whole audience (built on the server, so it works for audiences of any size). While the CSV is being converted the response status is converting; keep polling until status is ready. The ready response echoes format so you can tell a CSV link from a parquet fallback.

Allowed:

dry_run

boolean

Defaults to false

When true, returns the cost of this download instead of starting it: the meter and the records a live download would charge. Nothing is built, billed or changed. Combine with record_limit to price the exact download you intend to run.

record_limit

integer

0 to 10000000

Cap the audience at this many records, from 0 to 10,000,000; 0 removes the cap. Supported on intents, contact and list audiences. A value that differs from the audience's current limit is saved and rebuilds the audience, so the response reports it is still preparing. Refused on a paused audience. With dry_run=true it only changes the quote and is never saved.

Headers

X-Project-Id

uuid

Project ID (UUID). Equivalent to the project_id query parameter; send one or the other.

Responses

400

Invalid request, such as a record_limit outside 0 to 10,000,000 or on an unsupported type.

401

Missing or invalid authentication.

403

Forbidden.

404

Audience not found.

500

Internal server error.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Download links or status. With dry_run=true, the cost preview instead.

409The audience uses partner data that cannot be delivered: partner_price_not_accepted (a dataset's price was never accepted) or partner_dataset_disabled (the dataset is not enabled for the project). Accept the price and enable the dataset in the dashboard, then retry.