Skip to main content
POST
/
audiences
/
preview
Preview Audience
curl --request POST \
  --url https://api.audiencelab.io/audiences/preview \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data @- <<EOF
{
  "filters": {
    "age": {
      "minAge": 25,
      "maxAge": 45
    },
    "city": [
      "<string>"
    ],
    "state": [
      "<string>"
    ],
    "personalState": [
      "<string>"
    ],
    "zip": [
      "<string>"
    ],
    "gender": [],
    "businessProfile": {
      "industry": [
        "<string>"
      ],
      "seniority": [
        "<string>"
      ],
      "companyName": [
        "<string>"
      ],
      "jobTitle": [
        "<string>"
      ],
      "excludeJobTitle": [
        "<string>"
      ]
    },
    "attributes": {
      "education": [
        "bachelor's",
        "master's"
      ],
      "excludeEducation": [
        "high school"
      ]
    }
  },
  "segment": [
    "b2c_1253"
  ],
  "days_back": 123,
  "score": [
    "<string>"
  ]
}
EOF
{
  "count": 140,
  "field_coverage": {
    "first_name": 0.95,
    "last_name": 0.94,
    "company": 0.62,
    "company_domain": 0.58,
    "job_title": 0.41,
    "b2b_email": 0.33,
    "b2b_phone": 0.29,
    "personal_email": 0.71,
    "valid_phones": 0.44
  },
  "result": [
    {
      "company": "Acme Corp",
      "first_name": "John",
      "last_name": "Doe",
      "b2b_email": "jdoe@example.com",
      "sha256": "46f7b9bf9b2d7c35bd900490b2b8d4d4210e9f32ed117b5b688391e1dc85f053"
    }
  ]
}

Authorizations

​
X-Api-Key
string
header
required

Body

application/json
​
filters
object

Filter criteria for audience selection. All array fields must be passed as arrays even for single values.

​
segment
string[]

Optional list of audience segment IDs. Use the full exact ID including its prefix in the current taxonomy nomenclature:

  • b2c_<number> — consumer (B2C) segments, e.g. b2c_1253
  • b2b_<number> — business (B2B) segments, e.g. b2b_1042

Pass the complete ID with its prefix. Bare numbers (1253) and the legacy Delivr format (al_XXXXXX) are not supported.

Example:
["b2c_1253"]
​
days_back
integer

Number of days back to search

​
score
string[]

Optional scores to filter by (low, medium, high)

Response

Successful preview

​
count
integer

Total number of records matching the criteria

Example:

140

​
field_coverage
object

Percentage of matching records that have each field populated, computed over the full dataset

Example:
{
  "first_name": 0.95,
  "last_name": 0.94,
  "company": 0.62,
  "company_domain": 0.58,
  "job_title": 0.41,
  "b2b_email": 0.33,
  "b2b_phone": 0.29,
  "personal_email": 0.71,
  "valid_phones": 0.44
}
​
result
object[]

A sample list of enriched profiles matching the criteria

Example:
[
  {
    "company": "Acme Corp",
    "first_name": "John",
    "last_name": "Doe",
    "b2b_email": "jdoe@example.com",
    "sha256": "46f7b9bf9b2d7c35bd900490b2b8d4d4210e9f32ed117b5b688391e1dc85f053"
  }
]