Skip to main content
POST
Preview the Pendo survey job

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
surveys
PendoSurveySettings · object
required

The settings to try. They are not saved

days
integer
default:7

How many days back from now to read

Required range: 1 <= x <= 30

Response

200 - application/json

Successful Response

failed_surveys
string[]
required

One entry per survey that could not be read

known_people
integer
required

Responses read from a person who is already in Statisfy

matched_by_crm_id
integer
required

Responses read whose Pendo account value finds a Statisfy account, by the chosen match

rows
PendoSurveyPreviewRow · object[]
required

The newest responses, at most 20

skipped_guides
PendoSkippedGuide · object[]
required

Guides the preview did not read: it reads at most 5, and none after its time limit. A run of the job reads them all

skipped_sentiment_survey_ids
string[]
required

Sentiment survey IDs the preview did not read to the end: it reads at most 5, none after its time limit, and a survey the time limit cut between two pages is here too (its responses read so far are counted). A run of the job reads them all

total_responses
integer
required

All the responses that were read

without_email
integer
required

Responses with no email. A run cannot find a person for them