list_pages
List Pages
List all tagged pages in Pendo. Returns page names, IDs, and URL rules. Optionally filter by application ID for multi-app subscriptions.
list_pages
List all tagged pages in Pendo. Returns page names, IDs, and URL rules. Optionally filter by application ID for multi-app subscriptions.
create_segment
Create a new API-managed segment in Pendo from a list of visitor IDs. Segments are created instantly, but adding visitors is processed asynchronously.
update_visitor_metadata
Create or update custom metadata fields on a visitor record in Pendo. If the visitor does not exist, a new visitor record will be created with the provided metadata. Custom metadata fields will be automatically created if they don't exist.
list_features
List all tagged features in Pendo. Returns feature names, IDs, and click selectors. Optionally filter by application ID for multi-app subscriptions.
bulk_delete
Permanently delete visitor or account records from Pendo in bulk. All events associated with the specified IDs will be deleted. Deletion is processed in batches and may take up to 21 days for GDPR compliance.
get_account
Retrieve an account record from Pendo by account ID. Returns account metadata including custom fields, first and last visit timestamps, and associated visitor information.
get_metadata_schema
Retrieve the metadata schema for visitors or accounts in Pendo. Shows all configured metadata fields (both auto and custom), their types, and configuration. Useful for understanding available fields before running aggregations or updating metadata.
get_visitor
Retrieve a visitor record from Pendo by visitor ID. Returns visitor metadata including custom fields, first and last visit timestamps, and associated account information.
update_account_metadata
Create or update custom metadata fields on an account record in Pendo. If the account does not exist, a new account record will be created with the provided metadata. Custom metadata fields will be automatically created if they don't exist.
delete_segment
Delete a segment from Pendo by segment ID. This permanently removes the segment definition. Requires an integration key with write access.
run_aggregation
Execute an aggregation query against Pendo's analytics data. Aggregations use a MongoDB-like pipeline to query data sources such as page events, feature events, guide events, poll responses, and track events. Common data sources: **visitors**, **pageEvents**, **featureEvents**, **guideEvents**, **guidesSeen**, **pollsSeen**, **pollEvents**, **trackEvents**, **events**. Pipeline steps include **source** (required first step), **filter**, **group**, **sort**, **limit**, **select**, **bulkExpand**, and **identified**.
get_report
Retrieve results from a Pendo visitor or account report by report ID. JSON results are returned inline; CSV results are returned as a Slate attachment.
get_guide
Retrieve a specific guide from Pendo by ID. Returns full guide configuration including steps, targeting rules, launch method, and deployment status.
list_guides
List all guides in Pendo. Returns guide names, IDs, deployment status, and step details. Optionally filter by application ID for multi-app subscriptions.
list_segments
List all segments defined in Pendo. Returns segment names, IDs, and types. Segments are used to group visitors and accounts for analytics filtering and guide targeting.
send_track_event
Send a server-side Track Event to Pendo for an action that is not captured automatically by the Pendo agent. Requires the app-specific Track Event shared secret, which is different from the Engage integration key.
update_segment
Update an API-managed Pendo segment's name or visitor list. Pendo only allows this for segments created through the API.
patch_segment_visitors
Add or remove small batches of visitors from an API-managed Pendo segment. Pendo limits each patch call to 10 operations and 1000 total visitors.
list_reports
List public Pendo visitor and account reports available through the API. Use this to discover report IDs before calling Get Report.
get_track_type
Retrieve a specific Pendo track event type by track type ID.
start_segment_visitor_export
Start an asynchronous export of visitors in a Pendo segment. Use Get Segment Visitor Export with the returned job ID to check status and retrieve CSV results.
get_page
Retrieve a specific tagged page from Pendo by page ID. Returns the page name, rules, and raw page configuration.
get_bulk_delete_status
List outstanding Pendo bulk deletion requests or retrieve the preserved status receipt for a specific deletion request ID.
get_segment_visitor_export
Check the status of a Pendo segment visitor export job or retrieve completed CSV export results as a Slate attachment.
list_track_types
List custom track event types known to Pendo. Optionally filter by application ID or expand across all applications in a multi-app subscription.
verify_integration_key
Verify the configured Pendo integration key and return Pendo's key capability details, including write access when provided by the API.
get_feature
Retrieve a specific tagged feature from Pendo by feature ID. Returns the feature name and raw feature configuration.
Manage product analytics data, in-app guidance, and user feedback. Retrieve, create, and update visitor and account records with custom metadata. Create and manage in-app guides (tooltips, modals, walkthroughs) and segments for targeting users. Query aggregated product usage data including page events, feature events, guide interactions, poll responses, and track events using a flexible aggregation pipeline. Send custom track events from client-side and server-side sources. Manage legacy feedback requests and product roadmap data. Receive real-time webhook notifications for events like guide displays, NPS surveys, poll submissions, visitor creation, and account creation.
Common questions about connecting Pendo to AI agents with Metorial.