Get an audience
Returns an audience with its status and lead count. Free.
bearerAuthAuthorizationBearer <API key>Create a key in the app under Developers. Keys start with dcd_live_.
id*stringAudience id. Starts with aud_.
^aud_Success.
application/json- response
A set of leads that match your filters. Previewing it is free. Revealing leads costs chips.
id*stringAudience id. Starts with aud_.
^aud_name*stringAudience name.
type*stringAudience type. 'b2c' is Consumers, 'b2b' is Businesses (both are built from intent topics). 'people' is a plain people search with no intent data.
"b2c""b2b""people"status*string'building' while we assemble it, 'ready' once leads can be previewed and revealed, 'failed' if the build failed.
"building""ready""failed"filters*What to look for. Pick a type, add topics for b2c and b2b, then narrow with the optional groups or with where[] clauses.
prompt*|The plain-English description it was built from, if any.
total_count*integerLeads the audience holds for preview and reveal: at most 500 from a build, plus any a watch run added. Zero until the audience is ready.
0 <= value <= 9007199254740991total_is_capped*booleanTrue when more leads match than the audience holds (it hit the build limit or the preview size); show total_count as N+, or show match_count.
match_count?|Every lead that matches the filters, counted when the audience was last built or watched. Often far more than total_count, which is what can be previewed and revealed. Null when unknown.
saved*booleanWhether the audience is saved in the app.
watch*|Watch schedule. Null when the audience is not watched.
next_run_at*|When the next watch run starts. Null when the audience is not watched.
last_run*|The most recent run.
created_at*stringWhen the audience was created.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$date-timerequest_id*stringId of the request that produced this response. A replayed idempotent response keeps the original id.
curl -X GET 'https://api.diced.si/v1/audiences/aud_7GhT2kLm9QpX4sWv1bNc8ZrY' \ -H 'Authorization: Bearer dcd_live_your_key'{ "id": "string", "name": "string", "type": "b2c", "status": "building", "filters": { "type": "b2c", "topics": [ "string" ], "intent": [ "high" ], "active_within_days": 1, "location": { "states": [ "AK" ], "zips": [ "string" ], "cities": [ "string" ] }, "demographics": { "gender": [ "male" ], "age": [ "18-24" ], "income": [ "<20k" ], "net_worth": [ "<0" ], "homeowner": true, "married": true, "children": true }, "job": { "titles": [ "string" ], "seniority": [ "c_suite" ], "departments": [ "administrative" ] }, "company": { "names": [ "string" ], "domains": [ "string" ], "industries": [ "string" ], "size": [ "1-10" ], "revenue": [ "<1m" ] }, "where": [ { "field": "active_date", "op": "eq", "value": "string", "value_to": "string" } ] }, "prompt": "string", "total_count": 0, "total_is_capped": true, "match_count": 0, "saved": true, "watch": { "interval": "day", "auto_reveal": false, "cap": 100 }, "next_run_at": "2019-08-24T14:15:22Z", "last_run": { "id": "string", "kind": "build", "status": "running", "total_count": 0, "new_count": 0, "revealed_count": 0, "started_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z" }, "created_at": "2019-08-24T14:15:22Z", "request_id": "string"}