Merge API Documentation

Authentication: API key. See Application credentials for setup.

Sample use cases

Pull page view activity for all features in a product area over the last 90 days.
Find accounts that have visited the onboarding guide but haven’t completed it.
Update visitor metadata after a user completes a key workflow in your app.

get_account_metadata_schema

View available metadata fields for Pendo accounts, including field names and types

query_accounts

Retrieve Pendo account records matching metadata criteria. Max 50,000 results. Use offset for pagination

get_account

Get a single Pendo account by ID. Returns all metadata fields. Use query_accounts to search for account IDs

bulk_delete_accounts

Delete up to 500 Pendo accounts and all their associated data. Use for GDPR right-to-erasure requests

upsert_account_metadata

Set custom metadata fields on a Pendo account. Pass metadata as a dict of field names to values

query_activity

Query Pendo usage metrics by source: pageEvents, featureEvents, guideEvents, trackEvents, or pollEvents

get_product_area_activity

Get page view activity for all pages in a Pendo product area. Max 367-day range. Defaults to last 90 days

search_entities

Find Pendo items (Pages, Features, Track Events, guides) by name substring

list_segments

List all publicly shared Pendo segments with names and IDs. Segments define visitor/account cohorts

list_pages

List all tagged pages in Pendo with their IDs, names, and URL rules

get_page

Get a single Pendo page definition by ID, including URL rules and app association

list_features

List all tagged features (click targets) in Pendo with their IDs, names, and selectors

get_feature

Get a single Pendo feature definition by ID, including CSS selector and page association

list_track_types

List all custom track event types instrumented in Pendo. Returns event names and IDs

list_guides

List Pendo guides, optionally filtered by state or type. Returns ID, name, description, state, and scheduling info

get_guide

Get a single Pendo guide by ID. Returns full definition including steps, targeting, and scheduling

get_guide_metrics

Get performance data for a Pendo guide: views, completions, dismissals. Max 93-day range

get_visitor_metadata_schema

View available metadata fields for Pendo visitors, including field names and types

query_visitors

Retrieve Pendo visitor records matching metadata criteria. Max 50,000 results. Always excludes anonymous visitors

get_visitor

Get a single Pendo visitor by ID. Returns all metadata fields. Use query_visitors to search for visitor IDs

bulk_delete_visitors

Delete up to 500 Pendo visitors and all their associated events. Use for GDPR right-to-erasure requests

upsert_visitor_metadata

Set custom metadata fields on a Pendo visitor. Pass metadata as a dict of field names to values