Download only people not yet delivered this month

The /download flow, delivering only the people not already delivered to the audience's project this UTC calendar month at the audience's people meter. Each person is billed once per project, per meter, per month; /download bills the whole audience.

Until the file is ready the response is converting, as on /download: keep polling until status is ready. When ready, output_links holds only the new people and new_only says who was delivered and billed. Polling or re-fetching the same build in the same month never bills twice.

Billed people. new_only.billed_people is what you are charged for: people new this month plus people this same build already delivered. already_delivered people are left out of the files and not billed.

Cost preview. dry_run=true returns the same preview as /download, with records_fidelity: upper_bound: records_to_charge is the audience's people, the most this download can bill. People already delivered to the project this month are not billed again, and who is new is decided at delivery, so the actual charge is at most the preview. Nothing is built, claimed or billed.

Not available here. page returns 400. Audiences with partner data, and audiences that deliver intent or add-on columns, return 409: use /download, which bills every delivery.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Audience ID.

Query Params
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.

string
enum
Defaults to parquet

Output format, as on /download.

Allowed:
boolean

Return an upper-bound cost preview instead of building the file.

Headers
uuid

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

Responses

400

page was sent.

401

Missing or invalid authentication.

403

Forbidden.

404

Audience not found.

409

The audience delivers intent or add-on columns or partner data, which bill on every delivery, or it must be refreshed first. Use GET /api/v1/audiences/{id}/download.

503

New-only delivery is temporarily unavailable. Retry.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json