Pendo

App · 25 actions

Read Pendo product pages, features, visitors, accounts, guides, reports and metadata; update individual metadata values.

Actions

ActionWhat it does
Get accountGet account.
Get featureGet feature.
Get feedback optionsGet feedback options.
Get guideGet guide.
Get guide historyGet guide history.
Get guide orderGet guide order.
Get metadata schemaGet metadata schema.
Get metadata valueGet metadata value.
Get pageGet page.
Get report resultsGet report results.
Get segmentGet segment.
Get segment statusGet segment status.
Get survey responsesGet survey responses.
Get track typeGet track type.
Get visitorGet visitor.
Get visitor historyGet visitor activity for the 24 hours starting at the selected time, within the past 180 days.
List featuresList features.
List guidesList guides.
List metadata dependenciesList metadata dependencies.
List pagesList pages.
List reportsList reports.
List segmentsList segments.
List track typesList track types.
Set metadata valueSet metadata value.
Verify keyVerify key.

Get account

Get account.

Inputs

AccountIdaccountIdtextRequired
Accountid.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": ""
}

Get feature

Get feature.

Inputs

IDidtextRequired
Resource ID from the corresponding List action.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

Get feedback options

Get feedback options.

Inputs

None.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": ""
}

Get guide

Get guide.

Inputs

IDidtextRequired
Resource ID from the corresponding List action.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

Get guide history

Get guide history.

Inputs

GuideIdguideIdtextRequired
Guideid.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

Get guide order

Get guide order.

Inputs

None.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": ""
}

Get metadata schema

Get metadata schema.

Inputs

Resource kindresource_kindtextRequired
Kind.One of: visitor, account.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": ""
}

Get metadata value

Get metadata value.

Inputs

Resource kindresource_kindtextRequired
Kind.One of: visitor, account.
GroupgrouptextRequired
Group.One of: agent, custom, pendo.
IDidtextRequired
Id.
FieldNamefieldNametextRequired
Fieldname.

Outputs

dataobject
Complete Pendo response.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Get page

Get page.

Inputs

IDidtextRequired
Resource ID from the corresponding List action.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

Get report results

Get report results.

Inputs

ReportIdreportIdtextRequired
Reportid.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

Get segment

Get segment.

Inputs

IDidtextRequired
Id.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": ""
}

Get segment status

Get segment status.

Inputs

SegmentIdsegmentIdtextRequired
Segmentid.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": ""
}

Get survey responses

Get survey responses.

Inputs

SurveyIdsurveyIdtextRequired
Surveyid.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": ""
}

Get track type

Get track type.

Inputs

IDidtextRequired
Resource ID from the corresponding List action.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

Get visitor

Get visitor.

Inputs

VisitorIdvisitorIdtextRequired
Visitorid.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": ""
}

Get visitor history

Get visitor activity for the 24 hours starting at the selected time, within the past 180 days.

Inputs

VisitorIdvisitorIdtextRequired
Visitorid.
Starttimestarttimedate and timeRequired
Start of the history period; converted to Unix milliseconds.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

List features

List features.

Inputs

None.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

List guides

List guides.

Inputs

None.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

List metadata dependencies

List metadata dependencies.

Inputs

None.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": ""
}

List pages

List pages.

Inputs

None.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

List reports

List reports.

Inputs

None.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

List segments

List segments.

Inputs

None.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

List track types

List track types.

Inputs

None.

Outputs

datalist
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": ""
}

Set metadata value

Set metadata value.

Inputs

Resource kindresource_kindtextRequired
Kind.One of: visitor, account.
GroupgrouptextRequired
Group.One of: agent, custom.
IDidtextRequired
Id.
FieldNamefieldNametextRequired
Fieldname.
ValuevaluetextRequired
New value as JSON, for example true, 42, or "Gold".

Outputs

dataobject
Complete Pendo response.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": ""
}

Verify key

Verify key.

Inputs

None.

Outputs

dataobject
Complete response from the service, including its pagination and job status fields.
has_moretrue/false
Whether the service reports another page.
next_cursortext
Cursor for the next page, when supplied by the service.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": ""
}

On this page