Skip to main content
POST
Preview 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
limit
integer
default:10

The most rows to return

Required range: 1 <= x <= 100
period
enum<string> | null

Fills the date tokens with the latest complete period. Weekly when left out

Available options:
HOURLY,
TWO_HOURS,
FOUR_HOURS,
SIX_HOURS,
TWELVE_HOURS,
DAILY,
WEEKLY,
MONTHLY
week_start_day
integer | null

0 = Monday … 6 = Sunday. The config's week start day when left out

Required range: 0 <= x <= 6

Response

200 - application/json

Successful Response

columns
string[]
required

The column names of the first row

row_count
integer
required

How many rows are returned

rows
Rows · object[]
required

The rows, flattened. They can hold any Pendo data, emails included

truncated
boolean
required

True when Pendo had more rows than limit