Download the people in a signals state

Streams every person in one signals state of an intents or persona audience as one CSV file, with CCPA opt-outs removed. Use it instead of paging GET /api/v1/signals/audiences/{id}/members when you want the whole list.

Only intents and persona audiences have member lists. Any other audience returns 400.

Columns. hem (SHA-256 of the lowercased email), intent_trend, active_days_14d, topic_ids (topic ids separated by ;) and company_domain. A value the person does not have is an empty cell. The file name is audience-{id}-{state}-{day}.csv.

Billing. One predictive_signal unit per member, for every caller. A state and day is billed once per audience: downloading the same list again is free. The response header X-Record-Count holds the row count that was billed. Compare it with the rows you received to detect a stream that ended early.

Check the cost first. Add dry_run=true to get the row count and the cost as JSON. Nothing is billed. The preview carries the day it quoted, so pass that day on the real download. When the list is already billed, records_to_charge is 0.

Parameters. This route accepts only project_id, state, day and dry_run. Any other query parameter returns 400.

A test API key gets a fixed sample file with the response header X-Delivr-Mode: test. Nothing is billed.

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

Audience ID.

Query Params
uuid
required

Project ID (UUID). The X-Project-Id header is equivalent.

string
enum
required

The signals state to download. The values are the same as on GET /api/v1/signals/audiences/{id}/members.

Allowed:
string

Signals day, YYYYMMDD. Defaults to the latest day.

boolean
Defaults to false

When true, return the cost as JSON and bill nothing.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Invalid request. A missing project, a missing or unknown state, a bad day or dry_run, an unknown query parameter, or an audience without member lists.

401

Missing or invalid authentication.

402

The organization cannot be billed. Read error for the cause. A dry_run is never refused for this reason.

404

Audience not found in this project.

503

Member lists are temporarily unavailable. Retry shortly. Nothing is billed.

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