Skip to main content
POST
Check a Pendo query

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Body

application/json
query
string
required

The Pendo aggregation JSON, as text. A request body with a request.pipeline. It may use {START_DATE_MS}, {END_DATE_MS} and {PENDO_ACCOUNT_ID_FIELD}, which each run fills in

Required string length: 1 - 100000
query_type
enum<string>
required

Decides how the date tokens are filled: a custom_object query has no dates

Available options:
custom_field,
product_usage,
custom_object

Response

200 - application/json

Successful Response

errors
string[]
required

Why it is not valid

valid
boolean
required

True when the text is a valid Pendo aggregation body