v1

latestOpenAPI 3.0.12026-08-06614449.8 KB
Buyer Intent

Browse sandbox buyer intent interactions for a product

No scope is required to access this sandbox endpoint

⚠️ Sandbox API: This endpoint is a sandbox endpoint and is data limited. Only data between 6 months to 1 year ago will be available.

Query buyer intent data using an analytical query interface.

Query Language

This endpoint uses an OLAP-style query language that supports:

  • Dimensions: Group and categorize data (e.g., company_name, company_domain, day)
  • Measures: Aggregate numerical values (e.g., total_activity, visitor_count)
  • Filters: Apply conditions to limit results

Filter Operators

Filters use the format dimension_filters[name_suffix] where name is the dimension name and suffix indicates the operation:

  • _eq: Equals (exact match)
  • _not_eq: Not equals
  • _cont: Contains (substring match)
  • _not_cont: Does not contain
  • _gt: Greater than
  • _gteq: Greater than or equal
  • _lt: Less than
  • _lteq: Less than or equal
  • _present: Field has a value
  • _empty: Field is empty

Time Series vs Aggregated Data

  • Aggregated: Request dimensions without day for company-level summaries
  • Time Series: Include day dimension for daily breakdowns over time

Sorting Results

Use the sort parameter to order results by any dimension or measure:

  • Ascending: sort=company_name or sort=total_activity
  • Descending: sort=-company_intent_score (prefix with -)
  • Default: Results are sorted by -company_intent_score (highest intent first)

Available sort fields include all dimensions and measures listed above.

Examples

  • Company summary: dimensions=company_name,company_domain&measures=total_activity
  • Time series: dimensions=company_name,day&measures=company_intent_score
  • Filtered: dimension_filters[company_name_cont]=Acme&dimensions=company_name
  • Sorted by activity: dimensions=company_name&measures=total_activity&sort=-total_activity
get/api/sandbox/products/{subject_product_id}/buyer_intent

Path parameters

subject_product_idstring required

Identifier for the subject product

Query parameters

dimensionsstring[]

Comma separated list of dimensions

measuresstring[]

Comma separated list of measures

sortstring

Sort field with optional direction prefix. Use "-" for descending (e.g., "-day")

page[size]integer

Number of records per page (default: 10, max: 100)

dimension_filtersobject

Filters represented as query object (e.g., dimension_filters[company_name_cont]=Acme)

{
  "company_name_cont": "Acme",
  "company_intent_score_gteq": 75,
  "day_gteq": "2024-01-01"
}

Response

Successful responses

All 61 operations