Skip to main content
POST
/
v1
/
intent
/
audiences
/
preview
Preview an intent audience
curl --request POST \
  --url https://api.aws53.cloud/v1/intent/audiences/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "topicIds": [
    502909,
    502955
  ],
  "minScore": 50,
  "maxScore": 99,
  "minTopicOverlap": 1,
  "filters": {
    "role": {
      "isDecisionMaker": true
    },
    "contact": {
      "hasBusinessEmail": true
    },
    "jobTitle": {
      "include": [
        "chief financial officer",
        "cfo"
      ],
      "includeMode": "any"
    }
  },
  "sourceUrl": "https://example.com"
}
'
{
  "data": {
    "configHash": "<string>",
    "dataDate": "2023-12-25",
    "strategy": "serving_table_in",
    "totalCount": 123,
    "breakdowns": {
      "industries": [
        {
          "value": "<string>",
          "label": "<string>",
          "count": 123
        }
      ],
      "seniorities": [
        {
          "value": "<string>",
          "label": "<string>",
          "count": 123
        }
      ],
      "departments": [
        {
          "value": "<string>",
          "label": "<string>",
          "count": 123
        }
      ],
      "companySizes": [
        {
          "value": "<string>",
          "label": "<string>",
          "count": 123
        }
      ],
      "states": [
        {
          "value": "<string>",
          "label": "<string>",
          "count": 123
        }
      ],
      "exportGrades": [
        {
          "value": "<string>",
          "label": "<string>",
          "count": 123
        }
      ],
      "contactTiers": [
        {
          "value": "<string>",
          "label": "<string>",
          "count": 123
        }
      ]
    },
    "sample": [
      {
        "hashedEmail": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "fullName": "<string>",
        "businessEmail": "<string>",
        "personalEmail": "<string>",
        "email": "<string>",
        "primaryContactEmail": "<string>",
        "phone": "<string>",
        "mobilePhone": "<string>",
        "directPhone": "<string>",
        "personalPhone": "<string>",
        "linkedinUrl": "<string>",
        "headline": "<string>",
        "jobTitle": "<string>",
        "roleBucket": "<string>",
        "seniority": "<string>",
        "department": "<string>",
        "profile": {
          "profilePidAll": "<string>",
          "duplicateProfileCount": 123,
          "sourcePriority": 123,
          "hemRecordRank": 123,
          "isBestProfileForHem": true
        },
        "company": {
          "name": "<string>",
          "domain": "<string>",
          "linkedinUrl": "<string>",
          "domainTld": "<string>",
          "industry": "<string>",
          "industryGroup": "<string>",
          "naics": "<string>",
          "sic": "<string>",
          "description": "<string>",
          "revenueRange": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "<string>",
          "zip": "<string>"
        },
        "geo": {
          "city": "<string>",
          "state": "<string>",
          "stateCode": "<string>",
          "country": "<string>",
          "countryCode": "<string>",
          "zip": "<string>",
          "region": "<string>"
        },
        "contact": {
          "hasBusinessEmail": true,
          "hasPersonalEmail": true,
          "hasAnyPhone": true,
          "businessEmailStatus": "<string>",
          "personalEmailStatus": "<string>",
          "phoneStatus": "<string>"
        },
        "demographics": {
          "gender": "<string>",
          "ageRange": "<string>",
          "incomeRange": "<string>",
          "netWorth": "<string>"
        },
        "role": {
          "signals": {}
        },
        "profileSignals": {},
        "companySignals": {},
        "geoSignals": {},
        "compliance": {},
        "source": {},
        "intent": {
          "score": 123,
          "topicOverlap": 123,
          "matchedTopics": [
            {
              "topicId": 123,
              "topicName": "<string>",
              "type": "<string>",
              "industry": "<string>",
              "category": "<string>"
            }
          ]
        }
      }
    ],
    "appliedFilters": [
      "<string>"
    ],
    "normalizedConfig": {
      "topicIds": [
        123
      ],
      "minScore": 49,
      "maxScore": 99,
      "minTopicOverlap": 1,
      "filters": {},
      "sourceUrl": "<string>"
    }
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.leadpipe.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Dashboard access token. Send as Authorization: Bearer .

Body

application/json
topicIds
integer[]
required
Required array length: 1 - 250 elements
Example:
[502909, 502955]
minScore
integer | null

perc_score minimum. Values below 50 are accepted and clamped to 50.

Required range: 0 <= x <= 99
Example:

50

maxScore
integer
Required range: 50 <= x <= 99
Example:

99

minTopicOverlap
integer
Required range: 1 <= x <= 250
Example:

1

filters
object
Example:
{
"role": { "isDecisionMaker": true },
"contact": { "hasBusinessEmail": true },
"jobTitle": {
"include": ["chief financial officer", "cfo"],
"includeMode": "any"
}
}
sourceUrl
string<uri>
Example:

"https://example.com"

Response

Audience preview with masked sample rows

data
object
required
meta
object
required