accountMetadataSchema
ChatGPTReturn the set of metadata that is available from the accounts table for each account. It is a set of . separated metadata field names to information about that field, including the type. Here is an example return value { "metadata.custom.ARR" : "float", "metadata.pendo.donotprocess" : "boolean" } PERFORMANCE: This is a fast-running tool.
accountQuery
ChatGPTRetrieve account data and metadata OR just the counts of matching accounts by running aggregation queries directly against the account dataset. Every response entity will conceptually be an account of that subscription. USE THIS TOOL FOR: Getting account information, metadata, and account counts with flexible filtering options. PERFECT FOR QUERIES LIKE: - "Get all accounts with their custom metadata fields" - "Show me accounts from a specific segment" - "How many accounts match certain criteria?" (set count=true) - "Get account metadata like ARR, company size, or custom properties" WHAT THIS TOOL RETURNS: - Account data with selected metadata fields (without select passed in, no metadata fields are returned) - Account counts when count=true is specified - Results filtered by segments, specific account IDs, or other criteria FILTERING OPTIONS: - Filter by specific account ID - Filter by account segments - Filter by metadata value for a specific metadata group and field - Select specific metadata fields to include This tool executes aggregation queries directly and returns results immediately. For available metadata fields, use the accountMetadataSchema tool. Example usage of metadata fileds is select=["metadata.agent.is_paying","metadata.auto.lastvisit"]. PERFORMANCE: This is a fast-running tool.
acquisitionTrend
ChatGPTCount new visitors or accounts per period - users whose first-ever interaction with the app (scope='app'), a specific page or feature (scope='page' or 'feature'), or a track event (scope='trackEvent') falls within the analysis window. 'New' means firstTime within the window; this measures acquisition, not retention. The window is the most recent periodCount periods of size periodType (e.g. the last 6 months). Cohorts are returned oldest to newest. USE FOR: Growth and acquisition questions - e.g. 'how many new accounts did we gain last month?', 'what's our new visitor trend?'. EXAMPLES: - How many new accounts did we gain last month? - What's our new visitor trend over the last 6 months? - How many new users signed up this quarter? - Show me account acquisition for this feature over the last 8 weeks RETURNS: - scope, entityId, unit, periodType: echoed query parameters - acquisition: list of {cohortLabel, newCount} per period, sorted oldest to newest - summary: {totalNew, peakCohort, peakCount}
activityQuery
ChatGPTQuery aggregated activity metrics (events, minutes, unique visitors, unique accounts) for pages, features, track types, accounts, or visitors within a date range. Use this tool to answer questions about usage patterns, engagement metrics, and activity counts. Supports filtering by account, visitor, segment, or specific item IDs, and grouping results by various dimensions. RANKING PATTERN: For "top N" or "most active" queries, use count=false + group by the entity to rank + sort + limit. count=true returns ONLY a single aggregate number with no entity rows. PRODUCT AREA: Pass productAreaId to scope the query to one product area (not with itemIds). For page, feature, and trackType entities, results are limited to items in that area; for visitor and account, to entities with any activity attributed to that area, including guides. USE FOR: Getting activity metrics from various sources with several filtering options. EXAMPLES: - Top 3 features by visitors → entityType='feature', count=false, group=['featureId'], sort=['-uniqueVisitorCount'], limit=3, dateRange={range:'relative', lastNDays:30} - Top 5 pages by traffic → entityType='page', count=false, group=['pageId'], sort=['-uniqueVisitorCount'], limit=5, dateRange={range:'relative', lastNDays:30} - Most active visitors → entityType='visitor', count=false, group=['visitorId'], sort=['-numEvents'], limit=10, dateRange={range:'relative', lastNDays:30} - Get account activity metrics for the account ID XYZ → dateRange={range:'relative', lastNDays:30} - What are the most active pages in the last 30 days? → entityType='page', count=false, group=['pageId'], sort=['-numEvents'], limit=10, dateRange={range:'relative', lastNDays:30} - How many visitors used feature ABC in the last 7 days? → entityType='feature', itemIds=['featureId'], group=['visitorId'], count=true, dateRange={range:'relative', lastNDays:7} - How many accounts are active? → entityType='account', group=['accountId'], count=true, dateRange={range:'relative', lastNDays:30} - Show activity for the top 5 track types → entityType='trackType', count=false, group=['trackTypeId'], sort=['-numEvents'], limit=5, dateRange={range:'relative', lastNDays:30} - How many views did page X get in the last 30 days? → entityType='page', itemIds=['pageId'], count=true, dateRange={range:'relative', lastNDays:30} - Count total events for feature X in the last week → entityType='feature', itemIds=['featureId'], count=true, dateRange={range:'relative', lastNDays:7} - Return only the total number of matching entities for a query → set count=true - Query specific date range → dateRange={range:'custom', startDate:'2024-01-01', endDate:'2024-01-31'} - Get page activity for January 2024 → entityType='page', dateRange={range:'custom', startDate:'2024-01-01', endDate:'2024-01-31'} - Which visitors used feature X in Q1 2024? → entityType='feature', itemIds=['featureId'], group=['visitorId'], dateRange={range:'custom', startDate:'2024-01-01', endDate:'2024-03-31'} - Which features have the most rage clicks → frustrationMetrics=true, entityType='feature', count=false, group=['featureId'], sort=['-rageClickCount'], limit=10, dateRange={range:'relative', lastNDays:30} - What is the count of unique events for account → entityType='account', dateRange={range:'relative', lastNDays:30} - Which visitors were active on the most days? → entityType='visitor', group=['visitorId'], sort=['-daysActive'], limit=5, dateRange={range:'relative', lastNDays:30} - Top pages in a product area → entityType='page', productAreaId='<id>', group=['pageId'], sort=['-numEvents'], limit=10, dateRange={range:'relative', lastNDays:30} - How many visitors used a product area? → entityType='visitor', productAreaId='<id>', count=true, dateRange={range:'relative', lastNDays:30} (includes guide engagement; see guide_product_area.go for guide event subtype tuning) - How many accounts used a product area? → entityType='account', productAreaId='<id>', count=true, dateRange={range:'relative', lastNDays:30} (includes guide engagement; see guide_product_area.go for guide event subtype tuning) - Filter activity by a feature flag → featureFlag={name:'myFlag', value:true}. Use value:false to filter to events where the flag is not set to true. NOT FOR: guides and polls; use guideMetrics instead. Finding unused or zero-activity entities within a product area; use productAreaMemberActivity instead. RETURNS: - Raw JSON array [{requestId, rows: [...], time, url}] - When count=true: Returns only aggregate count values (count and meta.totalCount), not ranked entity rows. Use count=false for lists/rankings. - Aggregated activity metrics for events, minutes spent, visitors, accounts, avgMinutesPerVisitor, avgDaysActivePerVisitor, and (if frustrationMetrics set) some 'frustration' metrics. - Results can be grouped by a provided field. - Results can be sorted by a provided field. - By default, results are limited at 1000. FILTERING OPTIONS: - Filter by account ID - Filter by visitor ID - Filter by item IDs (i.e. page, feature, track type) - Filter by product area ID (mutually exclusive with item IDs) - Filter by visitor metadata (current values via visitorMetadataFilter) - Filter by historical metadata (event-time visitor/account/parentAccount values via historicalMetadataFilter) SORT OPTIONS: - Any SELECT/GROUP field (accountId, day, featureId, itemId, month, pageId, trackTypeId, visitorId, week) - numEvents - total event count - numMinutes - total minutes spent - uniqueAccountCount - count of unique accounts - uniqueVisitorCount - count of unique visitors - daysActive - count of unique days active - avgMinutesPerVisitor - average minutes per visitor - avgDaysActivePerVisitor - average days active per visitor - if frustrationMetrics param is set, any frustration metric: errorClickCount, rageClickCount, uTurnCount, deadClickCount The maximum time range for this tool is 367 days. PERFORMANCE: This is a fast-running tool.
addOrchestrateJourneyConditionNode
ChatGPTAdds a Conditional Split to an existing Orchestrate journey graph after create. continueBranch (Yes or No, default Yes) picks which branch keeps whatever currently follows that edge; the other branch always gets a new Exit (Orchestrate UI parity). Edge currently goes to Exit (end of path): both branches end at Exit - continueBranch keeps the existing Exit, the opposite branch gets a new Exit. Edge goes to a message or condition (mid-path): only the non-continuing branch gets a new Exit; continueBranch keeps the downstream steps. Draft or review (pre-launch) only; active, scheduled (active with a future start date), paused, completed, and disabled journeys cannot be edited, matching the Orchestrate UI. Email steps, guide nodes, delete, connect to step, and other add-step types require addOrchestrateJourneyEmailNode or the Orchestrate map UI. Same limits as the UI: at most 20 message steps and 4 consecutive Conditional Splits in a chain (enforced on insert by the backend, same as the REST add-node API). USE FOR: Adding a Conditional Split to an existing draft or review journey graph. EXAMPLES: - User wants to split the Yes branch after Elite users and keep current steps on No: getOrchestrateJourneySteps, edgeId from Elite users outgoing Yes edge, addOrchestrateJourneyConditionNode continueBranch No - User wants a conditional split at the end of the journey (last edge goes to Exit): getOrchestrateJourneySteps, edgeId from the outgoing edge to Exit, addOrchestrateJourneyConditionNode continueBranch Yes (Yes keeps the existing Exit, No gets a new Exit) WORKFLOW: 1. Call getOrchestrateJourneySteps with journeyId. STOP unless status is draft or review. STOP if status is scheduled (future start), active, paused, completed, or disabled. STOP if the insert would exceed 4 consecutive Conditional Splits on the target edge. 2. Users will not provide edgeId - resolve it from getOrchestrateJourneySteps edges (Regular, Yes, or No) before calling. When the user names a step (for example after Welcome email), find that step in steps, then pick its outgoing edge where from equals that stepId. For a branch-specific insert, use the Yes or No edge from that step. If duplicate step names, no outgoing edge, or ambiguous branches, STOP and ask the user - never guess. Never use conditionName for placement. 3. Call addOrchestrateJourneyConditionNode once per split. Map free-form user wording (split the path, conditional split) to this tool - users never need to say tool names. Optional conditionName and conditionDescription; continueBranch defaults to Yes. 4. Re-read getOrchestrateJourneySteps only when the next step needs fresh ids (another insert changes edgeIds). A single insert with no follow-up needs only the initial read. RETURNS: - resultSummary: human-readable summary of the add - journeyId: journey id after add - journeyUrl: direct URL to the journey map in the Pendo UI - name: journey display name - status: journey lifecycle label after add - validationReport: validation result (valid true with no issues on success)
addOrchestrateJourneyEmailNode
ChatGPTAdds an HTML editor email step to an existing Orchestrate journey graph after create. Creates an empty email step (no body). Draft or review (pre-launch) only; active, scheduled (active with a future start date), paused, completed, and disabled journeys cannot be edited, matching the Orchestrate UI. Guide nodes, conditional splits, delete, connect to step, and other add-step types require addOrchestrateJourneyConditionNode or the Orchestrate map UI. emailName names the new step only (optional; defaults to New email with a timestamp, matching the Orchestrate UI). Required emailType (marketing or transactional) from the user. Optional durationInDays (whole days to wait before the next step; default 1). Re-read getOrchestrateJourneySteps after insert for messageId, then save HTML with updateOrchestrateEmailContent. USE FOR: Adding an HTML email step to an existing draft or review journey graph. EXAMPLES: - User wants a marketing follow-up after Welcome email: getOrchestrateJourneySteps, edgeId from Welcome email outgoing edge, addOrchestrateJourneyEmailNode emailName Follow up emailType marketing - User wants a transactional follow-up 3 days after Welcome email: getOrchestrateJourneySteps, edgeId from Welcome email outgoing edge, addOrchestrateJourneyEmailNode emailName Follow up emailType transactional durationInDays 3 - User said add a marketing email after Welcome email: emailName is the new step label only (not Welcome email). edgeId from Welcome email outgoing edge, addOrchestrateJourneyEmailNode emailName Follow up emailType marketing - User wants a marketing reminder email after Welcome with HTML body: getOrchestrateJourneySteps, addOrchestrateJourneyEmailNode edgeId from Welcome outgoing edge emailName Reminder emailType marketing, getOrchestrateJourneySteps for messageId, updateOrchestrateEmailContent WORKFLOW: 1. Call getOrchestrateJourneySteps with journeyId. STOP unless status is draft or review. STOP if status is scheduled (future start), active, paused, completed, or disabled. STOP if stepCount is 20. 2. Users will not provide edgeId - resolve it from getOrchestrateJourneySteps edges (Regular, Yes, or No) before calling. When the user names a step (for example after Welcome email), find that step in steps, then pick its outgoing edge where from equals that stepId. For a branch-specific insert, use the Yes or No edge from that step. If duplicate step names, no outgoing edge, or ambiguous branches, STOP and ask the user - never guess. Never use emailName for placement. 3. Call addOrchestrateJourneyEmailNode once per email insert. Map free-form user wording (add an email, follow-up email, reminder email) to this tool - users never need to say tool names. Required emailType (marketing or transactional) from the user; STOP if not specified. Optional emailName (defaults to New email with timestamp) and durationInDays (defaults to 1). 4. Re-read getOrchestrateJourneySteps only when the next step needs fresh ids: another insert (edgeIds changed) or updateOrchestrateEmailContent (messageId for the new step). A single insert with no follow-up needs only the initial read. RETURNS: - resultSummary: human-readable summary of the add - journeyId: journey id after add - journeyUrl: direct URL to the journey map in the Pendo UI - name: journey display name - status: journey lifecycle label after add - validationReport: validation result (valid true with no issues on success)
agentAnalyticsConversationAnalysis
ChatGPTLists and ranks individual AI agent conversations with per-conversation metrics. Returns one row per conversation with: conversationId, visitorId, accountId, startTime, numRagePrompts, numErrors, and firstPromptContent. Supports filtering to a specific set of conversations and sorting by rage prompt count, error count, or date. USE FOR: Drilling down from aggregate metrics to individual conversation-level investigation - surfacing which specific conversations are driving a metric such as a high rage-prompt rate. When conversationIds are provided, the list is narrowed to a specific cluster (e.g. conversations associated with a detected issue or a use case). EXAMPLES: - Show me the conversations with the most rage prompts for my chat agent - Which conversations had the most errors this week? - List the most recent conversations for agent X - Show me these specific conversations: [id1, id2, id3] NOT FOR: Aggregate volume metrics for an agent. Diagnosing an issue cluster (explanations, tools invoked, response patterns). Discovering or clustering use cases. RETURNS: - [conversations]: one row per conversation with conversationId, visitorId, accountId, startTime, numRagePrompts, numErrors, firstPromptContent. The maximum time range for this tool is 90 days.
agentAnalyticsIssueAnalysis
ChatGPTRequires startDate and endDate (YYYY-MM-DD); there is no default range. Returns issue diagnoses, flagged response tool/model usage, and user prompt content for the events of a specific detected issue cluster in AI Agent Analytics. Executes a single aggregation with two parallel spawn branches: (1) agenticConversationEvents filtered by conversationIds - deduplicated visitorIds/accountIds and sampled explanations; (2) agenticEvents - tools/models from flagged response eventIds, and prompt content from issue conversationIds. USE FOR: Diagnosing a specific detected issue cluster when agentId, conversationIds, and eventIds are already known. Use when the user wants to understand why conversations were flagged, see patterns in user prompts that triggered the issue, or identify which tools and models were involved in the flagged responses. EXAMPLES: - What patterns exist among instances of the 'incorrect answers' issue? - Which tools were called in instances of the 'timeout error' issue? - Show me what users said in conversations flagged as the 'authentication failure' issue - Why does the 'formatting problem' issue keep occurring in my agent? NOT FOR: Discovering or listing issue clusters (this tool diagnoses a cluster whose conversationIds and eventIds are already provided). Aggregate volume metrics for an agent. Topic analysis or use-case clustering of conversations (this tool is scoped to a single detected issue, not to open-ended topic modeling). RETURNS: - Four labeled CSV sections: - [issue_instances]: visitorIds, accountIds - one summary row with deduplicated lists. - [explanations]: explanation - one row per sampled issue explanation (capped for MCP size). - [flagged_response_events]: issueToolsUsed, issueModelsUsed - one summary row with deduplicated lists. - [user_prompts]: content - one row per sampled user prompt message (capped for MCP size). The maximum time range for this tool is 90 days.
agentAnalyticsKeyMetrics
ChatGPTReturns key aggregate metrics for AI agent conversations with period-over-period comparison. Includes: conversations, visitors, accounts, prompts, rage prompt rates (per-prompt and per-conversation), visitorIds, accountIds, and visitor retention. All metrics include previous-period equivalents for trend analysis. USE FOR: Getting a high-level summary of AI agent usage and engagement. Use when the user asks about overall agent performance, conversation volume, visitor engagement, rage prompt rates, or retention for a specific agent. EXAMPLES: - How many conversations has my ABC agent had in the last 30 days? - What is the rage prompt rate for Acme agent this month? - Show me key metrics and trends for my chat agent over the past 2 weeks. - How many unique visitors have used my chat agent recently? NOT FOR: Use listUseCases for topic/cluster analysis. Use listAiAgentIssues for issue detection. Use listAiAgents to get agent IDs and names first when the user has not specified an agent. RETURNS: - Current period: numConversations, numPrompts, numVisitors, numAccounts, numRagePrompts, ragePromptsRate, ragePromptsConversationRate, retention (retentionRate, retained, visitors), visitorIds, and accountIds. - Previous period (same duration, immediately prior): prevNumConversations, prevNumPrompts, prevNumVisitors, prevNumAccounts, prevNumRagePrompts, prevRagePromptsRate, prevRagePromptsConversationRate, prevRetention. - Also includes conversationsWithRagePrompts and prevConversationsWithRagePrompts. The maximum time range for this tool is 90 days.
agentAnalyticsTrackedIssueAnalysis
ChatGPTDeep-dives into a single tracked issue in AI Agent Analytics for a specific AI agent, surfacing the visitors and accounts, sampled issue explanations from detected issue clusters, the tools and models the agent invoked, and a sample of the user prompts associated with the tracked issue. USE FOR: Deep-diving into a specific tracked issue - call directly if agentId is known and conversationIds, eventIds, and trackedIssueId are passed. Use when the user wants to understand what prompts users sent for a tracked problem, which tools and models the agent invoked, or which visitors and accounts are associated with a tracked issue. EXAMPLES: - What are users actually saying when they hit the 'incorrect answer' tracked issue? - Which tools does my agent use when the 'timeout error' tracked issue occurs? - Who are the visitors affected by this tracked issue? - Show me sample prompts from this tracked issue. NOT FOR: Aggregate volume metrics, or diagnosing detected (auto-clustered) issues rather than a specific tracked issue. RETURNS: - Four labeled CSV sections: - [tracked_issue_summary]: visitorIds, accountIds - one summary row with deduplicated lists. - [explanations]: explanation - one row per sampled issue explanation from detected issue clusters (capped for MCP size). - [tools_used]: toolsUsed, modelsUsed - one summary row with deduplicated lists. - [prompt_samples]: content - one row per sampled user prompt message (capped for MCP size). The maximum time range for this tool is 90 days.
agentAnalyticsTrackedUseCaseAnalysis
ChatGPTDeep-dives into a single tracked use case in AI Agent Analytics for a specific AI agent, surfacing the visitors and accounts, the tools and models the agent invoked, sampled explanations, and a sample of the user prompts associated with the tracked use case. USE FOR: Deep-diving into a specific tracked use case - call directly if agentId is known and conversationIds, eventIds, and trackedUseCaseId are passed. Use when the user wants to understand what prompts users sent for a tracked topic, which tools and models the agent invoked, or which visitors and accounts are associated with a tracked use case. EXAMPLES: - What are users actually asking in the 'dashboard help' tracked use case? - Which tools does my agent use when handling this tracked use case? - Who are the visitors in this tracked use case? - Show me sample prompts from this tracked use case. NOT FOR: Aggregate volume metrics across use cases, or issue diagnosis - this tool deep-dives a single tracked use case. RETURNS: - Four labeled CSV sections: - [tracked_use_case_summary]: visitorIds, accountIds - one summary row with deduplicated lists. - [explanations]: explanation - one row per sampled explanation (capped for MCP size). - [tools_used]: toolsUsed, modelsUsed - one summary row with deduplicated lists. - [prompt_samples]: content - one row per sampled user prompt message (capped for MCP size). The maximum time range for this tool is 90 days.
agent_analytics_key_metrics
ChatGPTReturns key aggregate metrics for AI agent conversations with period-over-period comparison. Includes: conversations, visitors, accounts, prompts, rage prompt rates (per-prompt and per-conversation), visitorIds, accountIds, and visitor retention. All metrics include previous-period equivalents for trend analysis. USE FOR: Getting a high-level summary of AI agent usage and engagement. Use when the user asks about overall agent performance, conversation volume, visitor engagement, rage prompt rates, or retention for a specific agent. EXAMPLES: - How many conversations has my ABC agent had in the last 30 days? - What is the rage prompt rate for Acme agent this month? - Show me key metrics and trends for my chat agent over the past 2 weeks. - How many unique visitors have used my chat agent recently? NOT FOR: Use list_use_cases for topic/cluster analysis. Use list_ai_agent_issues for issue detection. Use list_ai_agents to get agent IDs and names first when the user has not specified an agent. RETURNS: - Current period: numConversations, numPrompts, numVisitors, numAccounts, numRagePrompts, ragePromptsRate, ragePromptsConversationRate, retention (retentionRate, retained, visitors), visitorIds, and accountIds. - Previous period (same duration, immediately prior): prevNumConversations, prevNumPrompts, prevNumVisitors, prevNumAccounts, prevNumRagePrompts, prevRagePromptsRate, prevRagePromptsConversationRate, prevRetention. - Also includes conversationsWithRagePrompts and prevConversationsWithRagePrompts. The maximum time range for this tool is 90 days. PERFORMANCE: This is a slow-running tool.
aggregateEntityUsage
ChatGPTRank pages, features, or track events by aggregate usage over a date range, or measure a named set of them as one population. Entities are identified by ID, never by name. Returns {meta, summary, rows}; which part answers the question depends on which of the two was asked. WHOLE TYPE - omit productArea and name the entityType. Ranks every entity of that type, shaped by sortBy, sortOrder and limit. By default only entities WITH activity are ranked, so sortOrder='asc' gives the least-used among the USED ones; add includeUnused=true when the question is about entities getting no use at all. Two cautions: a named entity missing from the rows may simply have fallen outside limit, so to ask whether one specific entity was used, scope to it with an inline productArea instead; and the summary here covers every entity of the type, not only the rows returned, so it is not a total for the top N. A NAMED SET - pass productArea to scope to saved areas or exactly the inline entities listed, which may span entity types in ONE call; that is the only way to measure a set crossing them. Read the SUMMARY for the set as a whole: it treats the set as one deduplicated population and is independent of limit, so limit=1 still summarises everything in scope, while the rows give the breakdown within it. An entity with no activity is absent from the rows rather than ranked last, but the rows are still capped by limit - so take absence to mean 'no activity' only when limit is at least as large as the list, or set includeUnused=true (single-type lists only) to get an explicit all-zero row for every entity in the scope. Add minEvents to count only the visitors whose events across the set reach a threshold - 'how many people used this bundle at least N times'. Supply entityType for an unscoped whole-type ranking; inline productArea entries carry their own types. NEVER add rows together for a set-wide figure, and use the summary instead. Counts of distinct things - uniqueVisitors, uniqueAccounts, and their current_/prior_ forms in comparison mode - count a visitor active on several entities ONCE in the summary but once per row, so summing them silently inflates the answer and the rows do not carry the overlap needed to correct it. Only the additive totals - totalEvents and the frustration counts - match the sum of the rows; avgTimePerVisitor is an average and does not. Where entityUsage returns per-visitor rows for one known entity, this returns one row per entity showing how an entire cohort, optionally scoped by a segment, uses each of them. COMPARISON MODE - supply compareToDateRange to rank by how usage CHANGED between two periods rather than by level: dateRange is the current period, compareToDateRange the earlier baseline. Sort by a change_ column (ascending = biggest drop-off, descending = biggest growth). The ranking happens in the aggregation, so no per-entity cross-referencing is needed. includeUnused is ignored when comparing. USE FOR: Ranking or comparing entities by usage (top pages by views, most-clicked features, features associated with a page, least-used track events), or measuring a named bundle of them - including one spanning entity types - as one population. EXAMPLES: - Top 5 features by clicks last month - Which page had the most views in the last 30 days? - Which features have the most rage clicks this quarter? - Which features associated with page X were clicked most in the last 30 days? - Least-used track events over the last week - Which pages got no views at all in the last 30 days? - Which features were never used by visitors in segment X last month? - Which pages in product area X have zero activity from visitors in segment Y? - Which pages dropped off in usage the most this month versus last month? - Which features grew the most in the last 30 days compared to the prior 30 days? - How many people used any of these three features last month? - How many visitors used our premium tier - these 4 features, this page and these 2 track events - at least twice last month? - How many visitors used these three features at least twic…
aggregateGuideMetrics
ChatGPTRank guides by aggregate usage over a date range, returning one row per guide. Where guideMetrics analyses a single known guide in depth, this tool compares an entire cohort's usage across every guide. Each row has entityId, entityName, appId, totalViews, totalCompletions, totalDismissals, uniqueVisitors, uniqueAccounts, and viewsPerUser. totalViews excludes continue-resumed guideSeen events to match the guide-details UI. Deleted guides surface with entityName "(Deleted Guide)". USE FOR: Cross-guide ranking - e.g. top guides by views, which guides have the most dismissals, least-used guides. EXAMPLES: - Top 10 guides by views last month - Which guides have the most dismissals? - Show me the least-completed guides over the last 30 days - Rank guides by unique visitors this quarter - Top public tooltips by views - Compare views for these three guides RETURNS: - meta.dateRange: resolved startDate and endDate (YYYY-MM-DD) - meta.totalGuideCount: total distinct guides with activity before limit - rows: one per guide with entityId, entityName, appId, totalViews, totalCompletions, totalDismissals, uniqueVisitors, uniqueAccounts, viewsPerUser FILTERING OPTIONS: - productArea: restrict the ranking to guides in saved product areas or an inline guide list - status: guide state - public, staged, scheduled, draft, pendingReview, inactive - guideType: guide type - banner, tooltip, lightbox, walkthrough, whatsnew, building-block, group, training, launcher, mobile-lightbox - activation: launch method - auto (automatic), api, badge, dom (element click), embed, launcher (resource center), page, feature, form, track - guideCategoryIds: guides belonging to those guide categories - pageIds: guides whose first step is on one of those pages ("sitewide" matches guides with no page) - appId, accountId, segmentPipeline: scope the underlying guide activity - Note: metadata filters resolve current guides, so deleted guides drop out of the results.
ai_agent_issue_analysis
ChatGPTRequires startDate and endDate (YYYY-MM-DD); there is no default range. Returns issue diagnoses, flagged response tool/model usage, and user prompt content for the events of a specific detected issue cluster in AI Agent Analytics. Executes a single aggregation with two parallel spawn branches: (1) agenticConversationEvents filtered by conversationIds — deduplicated visitorIds/accountIds and sampled explanations; (2) agenticEvents — tools/models from flagged response eventIds, and prompt content from issue conversationIds. USE FOR: Diagnosing a specific detected issue cluster — call directly if agentId is known and conversationIds and eventIds are passed; Otherwise, call after list_ai_agents is called to get available AI agents and after list_ai_agent_issues is called to get issues clusters to find match and retrieve conversationIds/eventIds. Use when the user wants to understand why conversations were flagged, see patterns in user prompts that triggered the issue, or identify which tools and models were involved in the flagged responses. EXAMPLES: - What patterns exist among instances of the 'incorrect answers' issue? - Which tools were called in instances of the 'timeout error' issue? - Show me what users said in conversations flagged as the 'authentication failure' issue - Why does the 'formatting problem' issue keep occurring in my agent? NOT FOR: Use list_ai_agent_issues to discover issue clusters and get conversation/event IDs first (not when conversationIds and eventIds are already known). Use agent_analytics_key_metrics for aggregate volume metrics. Use list_use_cases for topic analysis of conversations (not issue diagnosis). RETURNS: - Four labeled CSV sections: - [issue_instances]: visitorIds, accountIds — one summary row with deduplicated lists. - [explanations]: explanation — one row per sampled issue explanation (capped for MCP size). - [flagged_response_events]: issueToolsUsed, issueModelsUsed — one summary row with deduplicated lists. - [user_prompts]: content — one row per sampled user prompt message (capped for MCP size). The maximum time range for this tool is 90 days. PERFORMANCE: This is a slow-running tool.
appUsage
ChatGPTGet per-visitor or per-account app usage metrics for a date range. Returns {summary, rows}: summary has total active visitors/accounts, total events across the selected app scope, average daily time on apps, and totals for the four frustration counts (totalErrorClickCount, totalRageClickCount, totalUTurnCount, totalDeadClickCount); rows are per-visitor or per-account breakdowns with daysActive, totalTime and avgTimePerDay (duration objects {seconds, display}), totalEvents, and the same four frustration totals, sorted and limited. When groupBy="account" each row also includes numVisitors - the count of distinct visitors from that account who were active during the window. Rows can instead be grouped at scale by one event-time historic or current visitor/account metadata field with groupByMetadata; metadata-grouped rows include metadataValue, numVisitors, numAccounts, and the usage metrics. Optionally include metadata fields for each returned visitor or account with select. Optionally filter the usage by custom event properties, event-time historic metadata, or current visitor/account metadata with propertyFilters. Audience can be scoped via an inline segmentPipeline; scope can also be narrowed to a single app via appId, or to a group of entities via productArea - one or more saved product areas, every one of them, or an inline list of pages, features and track events that is not saved in Pendo. When productArea is supplied the same summary and rows describe headline usage metrics for that group, measured over its page, feature, and track-event activity, with a visitor active on several of its entities counted once. minEvents restricts every summary total and every row to visitors with at least that many events over the date range, counting events rather than visits - so it identifies heavy users, not returning ones; with groupBy="account" it returns the accounts containing at least one such visitor, and their metrics cover only those visitors' events. USE FOR: Per-visitor, per-account, or metadata-grouped app-level usage (events, time, days active) AND top-N ranking over a window across every app, or one app when appId is supplied, or a group of entities when productArea is supplied - saved product areas or an inline list of pages, features and track events (headline usage metrics for that group). Also counts visitors above an event threshold over the window via minEvents. EXAMPLES: - Who uses our apps the most in the last 30 days? - Top 50 accounts by app usage last quarter - Which visitors rage-click the most across our apps last week? - Top 20 visitors by total time in app X last month - Headline usage metrics for product area X over the last 30 days - Top 20 accounts by usage of product area X last quarter - Show the top 20 accounts by app usage last quarter with their ARR and company size - How many visitors generated at least 10 events last month? - Top 20 accounts by app usage last month, counting only visitors whose role was admin at the time NOT FOR: Deriving stickiness (DAU/MAU, DAU/WAU, WAU/MAU) for a product area by calling this tool at multiple date-range granularities and dividing the resulting totalNumVisitors/totalNumAccounts. That does not match how the Product Areas page computes stickiness and gives a different answer on every attempt. There is no canonical product-area-scoped stickiness metric yet - say so instead of approximating one. For app-scoped stickiness, use productEngagementScore instead. RETURNS: - meta.dateRange: resolved startDate and endDate (YYYY-MM-DD) - meta.visitorsFromGateway: whether summary.totalNumVisitors was sourced from the aggmw gateway (only attempted for a product-area request with no segment/app/minEvents/propertyFilters scope; false otherwise or on any gateway failure) - summary: totalNumVisitors or totalNumAccounts, totalNumEvents, avgDailyActiveTime (duration object {seconds, display}), totalErrorClickCount, totalRageClickCount, totalUTurnCount, totalDeadClickCount - rows: daysActive, totalTime, totalEvents, avgTimePerDay, totalErrorClickCount, totalRageClickCount, totalU…
appUsageTimeSeries
ChatGPTGet app-level usage metrics over time. Groups events into buckets of the requested period (daily/weekly/monthly) and returns one row per bucket with app-wide totals: active visitors, active accounts, events, average active time (a duration object {seconds, display}), and the four frustration counts (totalErrorClickCount, totalRageClickCount, totalUTurnCount, totalDeadClickCount). The average metric matches the requested period: avgDailyActiveTime, avgWeeklyActiveTime, or avgMonthlyActiveTime. Audience can be scoped via an inline segmentPipeline; scope can also be narrowed to a single app via appId, or to a group of entities via productArea - one or more saved product areas, every one of them, or an inline list of pages, features and track events that is not saved in Pendo. When productArea is supplied each bucket describes that group's usage, measured over its page, feature, and track-event activity, with a visitor active on several of its entities counted once in that bucket. minEvents restricts every bucket to the visitors with at least that many events in that bucket, applied independently per bucket, so one call tracks an engagement threshold across the whole range. It counts events rather than visits, so it is not a returning-visitor measure. It combines with productArea, so a per-bucket threshold over a group of entities is one call rather than one call per bucket. USE FOR: Trend questions about whole-app usage over a window - e.g. 'how did active visitors trend over the last 12 weeks?', 'are rage clicks across our apps trending up?'. Also trends a product area or an inline entity list over time via productArea. With minEvents, tracks a per-bucket event threshold over time - e.g. 'visitors with at least 2 events per month', including over a product area. EXAMPLES: - How did active visitors trend over the last 12 weeks? - Total events per week across all apps over the last quarter - Are rage clicks across our apps trending up over the last 30 days? - How many visitors had at least 2 events in each of the last twelve months? - How did weekly active visitors for product area X trend over the last quarter? - Average weekly visitors with at least 2 events across these pages and features RETURNS: - meta.dateRange: resolved startDate and endDate (YYYY-MM-DD) - meta.period: echoed bucket size (daily|weekly|monthly) - meta.metrics: list of metric names returned per bucket - rows: one entry per time period, containing a 'bucket' string (YYYY-MM-DD or YYYY-MM), a startTime (epoch ms), and metric values; numeric metrics zero-fill for empty buckets
buildPendoSegment
ChatGPTbuildPendoSegment: Purpose: Describe one visitor segment by visitor or account ID, activity on Pages, Features, TrackEvents, Guides, Poll responses, the elements inside a guide, guide-experiment variant membership, segment membership, or metadata. Input shape: pass definition as an array of rule groups. Top-level groups are ANDed together; rules within a group are ORed together. For one ANDed rule, wrap it in a single-item group. SINGLE CALL CONTRACT (important): The ENTIRE segment, including every AND clause and every OR clause, MUST be built with ONE call to this tool. Never split a segment across multiple calls. Combine all clauses into a single definition array and pass it once. Calling the tool more than once produces multiple unrelated segments, NOT one combined segment, so the AND/OR logic between the calls is lost. Mapping a request to a single definition: - Split the request into top-level AND clauses. - Each AND clause becomes one group (one inner array) in the definition. - Inside a clause, every OR alternative becomes one rule object in that group. - A clause with no OR is a group containing a single rule object. CLAUSE COVERAGE (important): Account for EVERY clause in the request. Before returning, count the AND clauses in the request and confirm the definition has exactly that many top-level groups, then confirm every OR alternative inside each clause is present as a rule object. Never drop, merge, or skip a clause. If the request mentions a page rule, a feature rule, and a track event rule joined by AND/OR, all of them must appear. A request like "(X OR Y) AND Z" has 2 top-level groups (one for "X OR Y", one for "Z") and 3 rule objects total; returning fewer groups or rules is wrong. Full example (combining AND and OR in one call): Request: "(visitors who spent > 15 minutes on page A in May OR have NOT seen page B in the last year) AND triggered track event C on fewer than 5 days in the last 7 days" Correct single definition (one tool call): [ [ { "entityType": "page", "entityId": "A", "metric": "eventTime", "operator": ">", "threshold": 15, "condition": "between", "first": "2026-05-01", "last": "2026-05-31" }, { "entityType": "page", "entityId": "B", "metric": "notseen", "condition": "withinLast", "lookbackAmount": 12, "granularity": "months" } ], [ { "entityType": "trackEvent", "entityId": "C", "metric": "daysActive", "operator": "<", "threshold": 5, "condition": "withinLast", "lookbackAmount": 7, "granularity": "days" } ] ] The first group (the two page rules) is ORed together; that group is then ANDed with the second group (the track event rule). This is ONE call, not two. REQUIRED FIELDS AND CONDITION CHOICE (important): Activity metrics with non-empty supportedConditions MUST include an explicit "condition" field. It is the discriminator that selects which time/frequency fields apply, and it is NOT optional for those metrics. Always choose condition from the chosen metric's supportedConditions. Do NOT rely on the presence of first/last, lookbackAmount/granularity, or date to imply the condition; you must still set condition explicitly for activity metrics. For example: - first + last present => you MUST also set condition: "between" - lookbackAmount + granularity => you MUST also set condition: "withinLast" - date present => you MUST also set condition: "since" Segment membership metrics are the exception: - isMemberOfSegment and isNotMemberOfSegment have supportedConditions: [] by design. - For these metrics, omit "condition" entirely. Do NOT add "ever" or infer any default condition. - supportedConditions: [] means "no condition field", not "choose a default condition". Visitor and account ID rules are conditionless and metricless: - Use entityType: "visitor" or "account". - Use operator: one of "==", "!=", "contains", "!contains", "empty", "!empty". Omit it to default to "==". - Use entityId for the comparison value with "==", "!=", "contains", and "!contains". - Use an empty entityId with "empty" and "!empty". - Example: { "entityType": "visitor", "entityId": "bob@example.com" }. - Example: { "en…
cohortRetentionCurve
ChatGPTCompute a retention curve for an app (scope='app'), a specific page or feature (scope='page' or 'feature'), a track event (scope='trackEvent'), or a whole product area (scope='productArea'). For track events: measures how many accounts/visitors continue firing the event over time. Supports visitor-level or account-level retention (unit) and all vs first cohort modes (cohortMode='all' for all active users, 'first' for first-time users only - best for onboarding effectiveness). For scope='productArea', a user counts as active in a period if they used any page, feature, or track event in that area; guides in the area are not counted. Omit appId when the entity or area spans multiple applications - passing one restricts the curve to that application. Call this tool ONCE per question. A single call returns all periods at once - do NOT call it multiple times with different periodCount values. The analysis window is anchored to now() and works backwards. Do NOT pre-filter for 'new users in the last N days' via segmentPipeline - pass cohortMode='first' instead, which restricts to users whose all-time first interaction falls within the analysis window (truly new users, not returning users re-entering the window). Period 0 = '< 1 Month' is the % of cohort active more than once in their first period - a real metric, NOT a 100% baseline (typical rates 25-60%). Period N = % of cohort still active N periods later. activeCount at higher periods decreases because users too new to have reached that period are excluded from the denominator (dynamic denominator - correct, not missing data). summary.finalRetentionRate is the most important single number - it represents the durable retained core. USE FOR: Retention and churn questions - e.g. 'what % of users return after 3 months?', 'show me our retention curve', 'what's our churn rate?'. Not for acquisition questions ('how many new accounts did we gain?') - this tool measures continued activity of existing cohorts, not new-user counts. EXAMPLES: - What % of users return after 3 months? - Show me our retention curve - What's our account churn rate over the last 6 months? - How often do accounts that created a dashboard keep creating dashboards? - How well do we retain first-time users of this feature? - What's the retention curve for our Onboarding product area? RETURNS: - scope, entityId, cohortMode, unit, periodType: echoed query parameters - retentionCurve: list of {period, periodLabel, activeCount, multiSession, retentionRate} sorted by period - summary: {totalCohortSize, avgRetentionRate, finalRetentionRate}
createFeedbackItem
ChatGPTCreates a new feedback item in Pendo Listen. Returns the ID of the created feedback item. USE FOR: Submitting product feedback, feature requests, bug reports, or user input to the Listen feedback repository EXAMPLES: - Log this user's feedback about the dashboard loading slowly - Create a feature request for dark mode support - Submit feedback that the export CSV button is confusing - Capture this bug report about broken pagination - Record this customer's request for a Slack integration NOT FOR: Reading existing feedback — use get_feedback_items instead. For AI-extracted insights use get_feedback_insights. RETURNS: - feedbackId: ID of the created feedback item PERFORMANCE: This is a fast-running tool. This tool is only available to be called for the following subscriptions: (External Customer) Pendo Experience Sandbox (4691349476737024)
createGuideFromHtml
ChatGPTCreates a new draft Pendo guide from raw HTML content. Each entry in rawHtmls becomes one step in the guide. Returns the guide ID and a direct URL to edit the guide in Pendo. USE FOR: When the user has generated HTML guide content (e.g. from the pendo-guide-creator skill) and wants to create a real Pendo guide from it EXAMPLES: - Create a guide from this HTML - Send this guide to Pendo - Publish these HTML files as a Pendo guide - Turn my generated guide steps into a real Pendo guide NOT FOR: Listing, searching, or querying existing guides - use listGuides or searchEntities instead RETURNS: - Guide ID of the newly created draft guide - Direct URL to the guide in the Pendo UI
createIdeaItem
ChatGPTCreates a new product idea - a product enhancement or new feature request - for this subscription, and returns the ID of the created idea. Every idea must be associated with at least one application; if the user hasn't said which, resolve the correct appId(s) first. Optionally assign the idea to one or more product areas by their IDs. Before submitting the idea, repeat all non-empty fields back to the user for confirmation, resolving IDs to human-readable names. USE FOR: When the user explicitly asks you to log a product idea or feature concept into the ideas backlog EXAMPLES: - Create an idea for this: [paste text] - Log a product idea for a dark mode theme - Add an idea to support CSV exports on the reports page - Capture this idea about a bulk-edit workflow RETURNS: - ID of the created idea
createOrchestrateEmail
ChatGPTCreates an empty HTML editor email (no body) as a draft Orchestrate email. Does not save HTML body. Required emailType (marketing or transactional) from the user and appId. Optional name defaults to New email with a timestamp when omitted. To add HTML body content after create, open emailUrl in the Orchestrate UI (updateOrchestrateEmailContent is for journey email steps only). USE FOR: Creating a new empty HTML editor email (draft, empty body). EXAMPLES: - User wants a new marketing HTML email: createOrchestrateEmail emailType marketing appId 100 - User wants a transactional HTML email named Product update: createOrchestrateEmail emailType transactional appId 100 name Product update NOT FOR: Template or block-builder emails. Saving HTML body content via MCP (use emailUrl from the create response to edit HTML in the Orchestrate UI; MCP HTML save is for journey email steps only). Audience, schedule, sender, or launch. WORKFLOW: 1. Required emailType (marketing or transactional) from the user; STOP if not specified - ask the user, do not guess. Confirm appId with the user. 2. Call createOrchestrateEmail. 3. Call getOrchestrateEmail to confirm emailId, emailType, and draft status. 4. To add HTML body content, open emailUrl in the Orchestrate UI (standalone emails do not support updateOrchestrateEmailContent). RETURNS: - resultSummary: human-readable summary of the create - validationReport: validation result (valid true with no issues on success) - emailId: new email campaign id - emailUrl: direct URL to the email in the Pendo UI - name: email display name - status: email lifecycle status (draft on success)
createOrchestrateJourneyFromJson
ChatGPTCreates a draft Orchestrate journey from templateJson and returns journeyId. Use when the user wants a custom multi-email journey that createOrchestrateJourneyFromTemplate cannot express (single built-in template only). Build templateJson to match the JSON Schema on the templateJson parameter in this tool's inputSchema. This tool creates the graph layout (email steps, Conditional Split nodes with Yes and No branches, wait days between steps) only; it does not set audience, schedule, goals, or email content. After create, call getOrchestrateJourneySteps to verify the draft graph, then setOrchestrateJourney* and updateOrchestrateEmailContent as needed. The condition on each Conditional Split is not set here - configure it in the Orchestrate UI. Activating or publishing the journey is UI-only (no MCP tool). USE FOR: Creating a new draft Orchestrate journey with a custom multi-step graph supplied as templateJson. EXAMPLES: - User wants a welcome email then a follow-up email 3 days later: read templateJson inputSchema, build messageGraph with two Message nodes, set messageData.durationInDays to 3 on the first Message node (the wait before the follow-up) and durationInDays to 1 on the last Message node, call createOrchestrateJourneyFromJson for app 12345 - User wants email A then a Conditional Split where the Yes branch goes to email B and the No branch to exit: add a nodeType Condition node with edgeType Yes and edgeType No edges after email A; configure the condition in the Orchestrate UI - User wants an initial email, then a Conditional Split where the Yes branch sends email 1 and the No branch sends email 2: build Start -> Message (initial) -> Condition with edgeType Yes to a Message named email 1 and edgeType No to a Message named email 2, each branch ending at its own Exit node; set messageData on all three Message nodes; configure the condition in the Orchestrate UI WORKFLOW: 1. Confirm multi-email need (not createOrchestrateJourneyFromTemplate). 2. Construct templateJson from templateJson inputSchema. 3. Create. 4. Verify the draft graph. RETURNS: - journeyId: id of the created draft journey - journeyUrl: direct URL to the journey in the Pendo UI - status: draft - validationReport: graph validation summary
createOrchestrateJourneyFromTemplate
ChatGPTCreates a draft Orchestrate journey from a built-in templateId and returns journeyId. Supply templateId only - the server applies a fixed messageGraph; do not send templateJson. Supported templateId values are listed in the templateId parameter enum in this tool's inputSchema. For custom multi-email journeys, use createOrchestrateJourneyFromJson (templateJson inputSchema on that tool). This tool only selects which built-in graph to apply; it does not set audience, schedule, goals, or email body. After create, call getOrchestrateJourneySteps to verify the draft graph, then setOrchestrateJourney* and updateOrchestrateEmailContent as needed. Activating or publishing the journey is UI-only (no MCP tool). USE FOR: Creating a new draft Orchestrate journey from a single built-in MCP template. EXAMPLES: - Create a draft Orchestrate journey named 'Welcome email' with templateId mcpSingleEmailJourneyTemplate for app 12345 WORKFLOW: 1. Confirm single built-in template is enough (not createOrchestrateJourneyFromJson). 2. Call with a templateId from inputSchema enum. 3. Verify the draft graph. RETURNS: - journeyId: id of the created draft journey - journeyUrl: direct URL to the journey in the Pendo UI - status: draft - validationReport: graph validation summary
createSegment
ChatGPTCreates a new Pendo visitor segment and returns its id. Confirm the segment name and the human-readable summary of every AND/OR clause with the user before submitting. Pendo does not enforce unique segment names - if the user cares about uniqueness, check existing segments first. USE FOR: Only call this when the user wants a persistent segment saved to Pendo. Do not call this to preview a segment or to scope a one-off analytics query. EXAMPLES: - Create a segment named "Power users" for visitors active in the last 30 days. - Save this as a segment called "Trial churn risk". RETURNS: - id: the created segment's id. Can be used as a segmentId in downstream tools (segment-membership rules, list filters, etc.). - summary: plain-English description of the persisted segment rules with entity names resolved. Reflects what was actually stored after compile-time normalization (e.g. strict > operators become >= with adjusted thresholds). EntityTypes: visitor: requiredFields: entityType: "visitor" entityId: String supportedMetrics: [] account: requiredFields: entityType: "account" entityId: String supportedMetrics: [] page: requiredFields: entityType: "page" entityId: String supportedMetrics: ["eventCount", "deadClicks", "errorClicks", "rageClicks", "daysActive", "uTurns", "eventTime", "seen", "notseen", "lastSeen"] feature: requiredFields: entityType: "feature" entityId: String supportedMetrics: ["eventCount", "deadClicks", "errorClicks", "rageClicks", "daysActive", "used", "notused", "lastused"] trackEvent: requiredFields: entityType: "trackEvent" entityId: String supportedMetrics: ["eventCount", "daysActive", "used", "notused", "lastused"] guide: requiredFields: entityType: "guide" entityId: String supportedMetrics: ["seen", "lastSeen", "notSeen"] poll: requiredFields: entityType: "poll" entityId: String pollId: String // the poll nested under the guide supportedMetrics: ["response"] guideElement: requiredFields: entityType: "guideElement" entityId: String stepId: String // the guide step the element sits on elementId: String // the element's uiElementId, e.g. "pendo-button-a1b2c3d4" supportedMetrics: ["eventCount"] segment: requiredFields: entityType: "segment" entityId: String supportedMetrics: ["isMemberOfSegment", "isNotMemberOfSegment"] metadata: requiredFields: entityType: "metadata" entityId: String supportedMetrics: [] agent: requiredFields: entityType: "agent" entityId: String supportedMetrics: ["eventCount", "daysActive", "used", "notused", "lastused"] guideExperiment: requiredFields: entityType: "guideExperiment" entityId: String experimentId: String // the experiment, from listGuideExperiments; draft experiments are not selectable. Requires guide experiments enabled for the subscription; rules that need it are refused otherwise. variantName: Enum["A", "B"] // POSITIONAL: "A" is the experiment's first variant and "B" its second, whichever is the control. Experiments have exactly two variants. experimentConverted: Enum["None", "Yes", "No"] // only when the experiment has a conversion goal; "None" means any conversion status supportedMetrics: [] Metrics: eventCount: description: Number of events for the selected entity. requiredFields: metric: "eventCount" operator: Enum["==", "!=", ">=", "<="] threshold: Integer supportedConditions: ["withinLast", "between"] deadClicks: description: Number of dead clicks for the selected page or feature. requiredFields: metric: "deadClicks" operator: Enum["==", "!=", ">=", "<="] threshold: Integer supportedConditions: ["withinLast", "between"] errorClicks: description: Number of error clicks for the selected page or feature. requiredFields: metric: "errorClicks" operator: Enum["==", "!=", ">=", "<="] threshold: Integer supportedConditions: ["withinLast", "between"] rageClicks: description: Number of rage clicks for the selected page or feature. requiredFields: metric: "rageClicks" operator: Enum["==", "!=", ">=", "<="] threshold: Integer supportedConditions: ["withinLast", "between"] daysActive: description: Number of active days for the selected entity. requiredFields: metric: "daysAc…
deleteSegment
ChatGPTPermanently deletes a saved Pendo visitor segment. Confirm the segment name and id with the user before submitting - this cannot be undone from the agent. USE FOR: Removing a segment the user no longer needs. If the segment is referenced by a guide, another segment, or a saved report, the delete is rejected and the referencing entity is named in the error so the user can detach it first. Segments that back a feature flag must be deleted via the feature-flag tools. EXAMPLES: - Delete segment abc123. - Remove the "Old trial users" segment. RETURNS: - id: the deleted segment's id.
devlogEvents
ChatGPTFetch raw devlog events for a visitor or session, including HTTP request/response details, log levels, messages, and stack traces. Accepts a clipId or the individual fields (recordingSessionId, appId, visitorId, accountId, startTime, endTime) that identify a recording. When clipId is provided, the tool looks up the clip to resolve visitorId, accountId, appId, recordingSessionId, and time range automatically. If the user provides a session replay URL, parse the recordingSessionId from the URL path and query parameters (startTime, endTime, visitorId, accountId, appId) before calling this tool. USE FOR: Investigating developer console logs, network errors, or HTTP activity captured during a session replay. Use when the user provides a session replay URL (parse the URL yourself to extract params), a clip ID, or when chaining from sessionReplayList results by passing recordingSessionId/appId/visitorId/accountId directly. EXAMPLES: - Show me devlogs for this session replay: https://<hostname>/s/123/replay/player/abc - Show network requests captured in clip https://<hostname>/s/123/replay/clip/saved/xyz - What HTTP errors occurred during visitor john's session? - Fetch devlogs for clip ID abc-123 - Find devlog errors for account acme-corp - What API calls did this visitor make during their session? - After calling sessionReplayList, pass the row's recordingSessionId/appId/visitorId/accountId/startTime/endTime directly to fetch devlogs NOT FOR: Listing session replays — use sessionReplayList instead. General page/feature analytics — use activityQuery or topEntities instead. RETURNS: - Devlog events including subType (console/network), log level, message, stack trace, HTTP method, request URL, status code, request/response headers and bodies. Limited to 100 events. The maximum time range for this tool is 31 days. PERFORMANCE: This is a slow-running tool. This tool is only available to be called for the following subscriptions: pendo-internal (5668600916475904) Pendo for Pendo Employees (5769426755780608) (Demo) Pendo Experience (6591622502678528) Pendo AI - Internal (6296072733130752) tippy_demo (6284013896335360)
entityUsage
ChatGPTGet usage analytics for one known page, feature, or track event ID over a date range, including page views, feature clicks, event counts, and unique visitor ('people') and account counts. Returns {summary, rows}: summary has total events, unique visitors, unique accounts (and for pages/features, frustration counts; pages also include uTurnCount); rows are per-visitor or per-account breakdowns with events, time on entity, and days active, sorted and limited. Optionally filter or group by custom event properties, event-time historic metadata, or current visitor/account metadata. Optionally include metadata fields for each returned visitor or account with select. Audience can be scoped via visitorIds OR an inline segmentPipeline (mutually exclusive), and/or filtered to a single accountId. USE FOR: Scalar 'how many people viewed/clicked/used it' totals and top-N visitor or account questions over a window for one known page, feature, or track event ID. EXAMPLES: - How many page views did page X get last month? - How many distinct dashboardId values fired with feature Y in the last 30 days? - Top 20 visitors by time on page X in the last 30 days - Top 50 accounts by usage of feature Y last quarter - How many rage clicks did feature Y have last week? - Show the top 20 visitors by time on page X last month with their email and role NOT FOR: Looking up an entity ID from its name, or ranking multiple entities against each other. WORKFLOW: When the user names a page, feature, or track event but does not provide its ID, call listPagesFeaturesAndEvents to resolve the name to an ID, then call entityUsage with that ID. Do not substitute aggregateEntityUsage for this lookup: its limited ranking may omit the named entity. RETURNS: - summary: totalNumEvents, totalNumVisitors, totalNumAccounts (pages/features also: totalErrorClickCount, totalRageClickCount, totalDeadClickCount; pages also: totalUTurnCount) - summary.totalPropertyGroupCount: when groupByProperties is used, the exact number of distinct populated property groups before the row limit; the count excludes (none), which may still appear in rows - rows: events, timeOnEntityInMinutes, daysActive per visitor or account (pages/features also: errorClickCount, rageClickCount, deadClickCount; pages also: uTurnCount); per-account rows also include numVisitors; select adds requested metadata fields - property-grouped rows include propertyValues plus events, visitors, and accounts - sumEventProperty optionally adds the numeric event-property total to summary and every row, independent of the row limit for summary
entityUsageTimeSeries
ChatGPTGet usage of a page, feature, or track event over time. Groups events into buckets of the requested period (daily/weekly/monthly) and returns one row per bucket with all available metrics. Pages get the full set (visitors, accounts, events, timeOnEntity, averageTimeOnEntityPerVisitor (duration object {seconds, display}), errorClickCount, rageClickCount, uTurnCount, deadClickCount). Features drop the time-derived metrics and uTurnCount. Track events drop all click-level frustration counts. minEvents restricts every bucket to the visitors with at least that many events on the entity in that bucket, applied independently per bucket. For a specific entity, the query can filter or group by custom event properties or event-time historical metadata. For whole-app usage over time (not a specific entity), use the appUsageTimeSeries tool instead. USE FOR: Trend questions over a window - e.g. 'how did feature X usage change over the last 12 weeks?', 'are rage clicks on page X trending up?'. With minEvents, tracks a per-bucket event threshold over time - e.g. 'visitors using feature X at least twice a month'. EXAMPLES: - How did feature X usage change over the last 12 weeks? - Are rage clicks on page X trending up over the last 30 days? - How did visitor counts trend for this account last month? - Total page views per week across all pages over the last quarter - How many visitors used feature X at least twice in each of the last six months? RETURNS: - meta.dateRange: resolved startDate and endDate (YYYY-MM-DD) - meta.period: echoed bucket size (daily|weekly|monthly) - meta.metrics: list of metric names returned per bucket - rows: one entry per time bucket with bucket (YYYY-MM-DD or YYYY-MM), startTime (timestamp object {iso, display}), and metric values; numeric metrics zero-fill and averageTimeOnEntityPerVisitor (duration object {seconds, display}) defaults to 0s for empty buckets - property-grouped rows contain propertyValues, with one stable range-ranked group set zero-filled across every bucket - sumEventProperty optionally adds a numeric event-property total per bucket and property group, zero-filled for empty buckets
generateFeedbackTopics
ChatGPTGenerates AI-clustered topics from customer feedback matching the given filters. Each topic contains a name, description, and count of related insights. Use this for high-level overviews of the most common themes in a feedback subset.
generate_feedback_topics
ChatGPTGenerates AI-clustered topics from customer feedback matching the given filters. Each topic contains a name, description, and count of related insights. Use this for high-level overviews of the most common themes in a feedback subset. PERFORMANCE: This is a slow-running tool. This tool is only available to be called for the following subscriptions: pendo-internal (5668600916475904) (Demo) Pendo Experience (6591622502678528) (External Customer) Pendo Experience Sandbox (4691349476737024)
getAdditionalTools
ChatGPTReport an unsupported Pendo task as capability feedback. Use only when the user asks to report a missing capability. Records a brief task summary to help improve this connector and returns an acknowledgement; does not discover, install, or execute additional tools. Send a one-sentence summary of the task.
getAgentConfig
ChatGPTReturns the configuration for a given AI agent: its name, description (a human-authored summary of the agent's role and purpose, not its LLM system prompt), model preset, type, and the tool names and descriptions it has used in the specified date range. The agent config section comes from the stored agent record. The tools section is derived from runtime events in the date range and may be empty if the agent had no activity. USE FOR: Fetching the static configuration and runtime tool inventory of an AI agent. Use before analyzing issues or generating fix briefs to understand what the agent is configured to do and which tools it calls. EXAMPLES: - What is my agent's configured role and purpose? - Which tools does my agent have access to? - What model does agent X use? - Show me the full config for this agent before I debug it NOT FOR: The agent's actual LLM system prompt - this tool does not have access to that. Aggregated usage metrics, issue clusters, or conversation analysis - use the agent analytics tools for those. RETURNS: - Two labeled CSV sections: - [agent_config]: name, description (human-authored role/purpose summary, not the LLM system prompt), preset (model), type - one row. - [tools]: toolName, toolDescription - one row per tool seen in the date range; empty section if no activity found. The maximum time range for this tool is 90 days.
getEntity
ChatGPTGet the configuration details of one page, feature, track event, or guide by ID. Does not include any usage or metrics. USE FOR: Understanding an entity before querying or acting on it. The name of any entity, reading a page's URL rules, the element a feature targets and the page it sits on, or a countable's event properties.For a guide, get its steps in order, each with its step ID and the interactive elements on it. EXAMPLES: - What is the page with ID abc123 and what URLs does it match? - Which element does feature xyz789 target, and what page is it on? - What event properties can I break down track event def456 by? - What are the step IDs and element IDs for guide ghi789? - Which buttons are on the second step of this guide and what do they do? NOT FOR: Usage, metrics or counts of any kind. Searching for an entity when you don't know its ID. RETURNS: - id, type, name, description, appIds, createdAt, lastUpdatedAt for every entity type. - eventPropertyNames: names of event properties attached to pages, features and track events. - page: rules and excludeRules (the URL rules that define the page). - feature: elementPathRules (CSS selector rules identifying the tagged element), and the pageId and pageName it is scoped to. - trackEvent: trackTypeRules (the event names that count towards it). - guide: state, launchMethod, and steps in the order they appear. Each step has id, name, and the pageId and elementPathRule it attaches to when it targets one. - guide steps[].polls: id, question and type ('PickList', 'NumberScale', 'FreeForm', 'NPSPoll', ...) per poll. For the answers given, use guidePollResponses. - guide steps[].elements: the buttons, close buttons and links on the step, each with uiElementId, text and actions ('Next Step', 'Dismiss Guide', 'External URL', 'Go to Step (2)', ...).
getFeedbackInsights
ChatGPTRetrieves key customer feedback insights extracted from raw feedback matching the given filters. Each item includes a summary, explanation, and supporting quote. Use this when the user wants to see actionable feedback insights which have been distilled from the raw customer feedback. Note: insights can also be referred to as 'highlights'
getFeedbackItems
ChatGPTRetrieves the original, raw customer feedback matching the given filters. Each item includes id, title, description, status, and info about the account and visitor which gave the feedback. status is an object with id, name, and color fields. account is an object with id and name. visitor information is available via the createdBy and onBehalfOf objects. Each item also includes: assignee (email of the assigned user); labels, apps, and productAreas (each a list of {id, name} objects); productAreas identify the product areas the feedback is tagged to; lastUpdatedAt (epoch milliseconds, same format as createdAt); linkedIdeas (a list of the ids of ideas the feedback is linked to); importance ('Must Have', 'Nice to Have', or 'Not Interested'); and source (where the feedback originated, e.g. Portal, Salesforce, NPS). Use this when the user wants the full raw feedback, as opposed to the extracted insights or clustered topics. A maximum of 30 items will be returned, however there may be more matching the filter set.
getIdeas
ChatGPTRetrieves product ideas submitted by internal product employees which describe product enhancements and new features matching the given filters. Each item includes: id, title, description, createdAt, status, effort, impact, voteCount, accountVoteCount, and votes. Each item also includes: assignee (email of the assigned user); labels, apps, and productAreas (each a list of {id, name} objects); lastUpdatedAt (epoch milliseconds, same format as createdAt); and linkedFeedbackItems (list of feedback item IDs linked to this idea). status is an object with id, name, and color fields. voteCount is the number of positive votes cast for the idea ('Must Have' and 'Nice to Have') - use this as the primary signal of demand when ranking or comparing ideas. accountVoteCount is the number of unique accounts that cast positive votes - use this to indicate breadth of interest across customers; when accountVoteCount is much lower than voteCount, it means a small number of accounts voted multiple times. 'Not Interested' votes are excluded from voteCount, accountVoteCount, and the votes list by default. Pass includeNotInterestedVotes=true when the user asks to see 'Not Interested' votes or wants all vote counts including 'Not Interested'. Each vote includes: importance ('Must Have' or 'Nice to Have'; 'Not Interested' when includeNotInterestedVotes is true); voterId (the ID of the person who cast the vote); voterType ('Visitor' in most cases, 'User' for internal users - only mention this to the user when the value is 'User'); accountId (the account associated with the vote). A maximum of 30 items will be returned, however there may be more matching the filter set.
getOrchestrateEmail
ChatGPTGet full details for a single Orchestrate email campaign by ID. Returns any orchestrate email the caller can access, including journey message emails when you already have the email ID. Use listOrchestrateEmails to discover orchestrate email campaigns; use this tool when you have a specific email ID. USE FOR: Reading full configuration for one Orchestrate email when you have its email ID. EXAMPLES: - Get email details for email 123 - Show orchestrate email config for abc - What is email xyz? - Show me full details for this orchestrate email - Get email campaign by ID NOT FOR: Discovering email IDs or browsing campaigns when you do not yet have a specific email ID. WORKFLOW: Call listOrchestrateEmails to discover email IDs, then call this tool with emailId. RETURNS: - Orchestrate email campaign configuration for agents: name, status (UI lifecycle label for standalone emails), subject, provider (Pendo, HubSpot, Marketo, or Eloqua), email settings, audience, schedule start time, and lifecycle timestamps (publishedAt, triggeredAt, executedAt) - attributes includes journeyId when the email belongs to a journey - Integration IDs (HubSpot, Marketo, Eloqua) when the email uses an external provider
getOrchestrateEmailMetrics
ChatGPTGet performance metrics for a single Orchestrate email. Returns delivery, unique opens, unique clicks, bounces, unsubscribes, and spam complaints for Pendo emails within the requested date range. Matches Orchestrate email overview metrics in the UI. Email-level aggregates only: this tool does not return per-visitor metrics or identify which visitors sent, opened, clicked, bounced, or unsubscribed. For per-visitor engagement use getOrchestrateEmailVisitors. Use listOrchestrateEmails to discover email IDs. USE FOR: Email-level performance aggregates and rates for one Orchestrate email over a date range. EXAMPLES: - How did email abc perform last month? - Show delivery and open rates for orchestrate email 123 - Get email metrics for email 123 between 2025-01-01 and 2025-01-31 NOT FOR: Per-visitor engagement (who did what); this tool returns aggregates and rates only. WORKFLOW: Call listOrchestrateEmails to discover email IDs, then call this tool with emailId and a date range. RETURNS: - Top-level emailId, startDate, endDate, plus metrics: unique-visitor counts (sent, delivered, opened, clicked, bounced, unsubscribed, complaint) and rates (deliveryRate, openRate, clickRate, clickToOpenRate, bounceRate, unsubscribeRate, complainRate). No rows or visitorId. - Rates as percentages on a 0-100 scale, not 0-1 fractions: openRate and clickRate are % of delivered; deliveryRate, bounceRate, unsubscribeRate, and complainRate are % of sent; clickToOpenRate is % of opened. Bounce counts reflect hard bounces only (Permanent). The maximum time range for this tool is 367 days.
getOrchestrateEmailVisitors
ChatGPTList per-visitor email engagement for one Orchestrate email in a date range. Returns { meta, summary, rows } (see RETURNS). Each row is visitorId plus integer sent/delivered/opened/clicked/bounced/unsubscribed/complaint counts (events matching that type in range for that visitor). Counts can exceed 1 for opens/clicks; summary.numVisitors is still the distinct-visitor count for eventType, not a sum of row counts. Timestamps, URLs, and per-link click detail are unbounded and omitted. Bounce counts reflect hard bounces only (Permanent). eventType filters which visitors appear in rows (default opened); each row still includes all event-type counts. Use getOrchestrateEmailMetrics for email-level unique-visitor totals and rates without per-visitor rows. USE FOR: Listing which visitors engaged with one Orchestrate email over a date range. EXAMPLES: - Who opened orchestrate email abc last month? - List visitors who were sent email abc last month - List visitors who clicked email 123 in January - Did visitor X open email abc? - Which visitors bounced on email abc last month? NOT FOR: Email-level unique totals and rates without a per-visitor row list. WORKFLOW: Call listOrchestrateEmails for emailId, then call with emailId, startDate, endDate, and optional eventType (default opened; use sent or delivered for recipient lists). Optional visitorId narrows to one visitor. Optional segmentPipeline scopes the audience; optional blacklist controls blacklist filtering (default apply). RETURNS: - meta: { emailId, startDate, endDate, eventType } echo of request scope - summary.numVisitors: distinct visitors with at least one event matching eventType (defaults to opened when omitted); computed before the row limit and not capped by limit; may exceed len(rows) - rows[]: { visitorId, sent, delivered, opened, clicked, bounced, unsubscribed, complaint } non-negative integer event counts; sorted by visitorId; truncated at limit (default 200, max 5000); no pagination - rows are not a complete visitor list when summary.numVisitors exceeds len(rows) The maximum time range for this tool is 367 days.
getOrchestrateJourney
ChatGPTGet full details for a single Orchestrate journey by ID. Returns curated journey configuration including audience, status, scheduling, and goal. Does not include the step graph, linked message/email IDs, or email settings (those live on each email; use getOrchestrateEmail). Use listOrchestrateJourneys to discover journey IDs. USE FOR: Reading journey-level configuration (audience, goal, schedule, status) for one journey when you have journeyId. EXAMPLES: - Get orchestrate journey details for journey 123 - Show me the full config for this orchestrate journey - What is orchestrate journey xyz? - Get orchestrate journey campaign by ID NOT FOR: Discovering journey IDs, browsing many journeys, or inspecting the step graph and linked message IDs. WORKFLOW: Call listOrchestrateJourneys to discover journey IDs, then call this tool with journeyId. RETURNS: - Journey configuration for agents: name, status (UI lifecycle label), audience, goal, and scheduling - Lifecycle timestamps (createdAt, updatedAt, publishedAt, firstPublishedAt) - App IDs, step count, audience targeting, and control-group settings
getOrchestrateJourneyMetrics
ChatGPTGet journey-level performance metrics for a single Orchestrate journey. Covers visitor entry and exit counts and - for journeys with a goal - goal attainment. Returns journey-wide aggregates only: no per-step, per-message, or per-visitor breakdown. USE FOR: Journey-wide entry, completion, and goal attainment aggregates for one Orchestrate journey. EXAMPLES: - How is orchestrate journey 123 performing? - How many visitors entered and exited orchestrate journey abc? - What is the goal attainment rate for this orchestrate journey? - Show journey metrics for journey 123 between 2025-01-01 and 2025-01-31 NOT FOR: Per-step performance, current enrollment rosters, or per-visitor engagement rows. WORKFLOW: Call listOrchestrateJourneys to discover journey IDs, then call this tool with journeyId, optionally with startDate and endDate. RETURNS: - visitorsEntered: unique visitors who entered the journey - visitorsCompleted: unique entered visitors who finished the journey by reaching an Exit step or aging out (for required-goal journeys, achieving the goal also marks completion). This is a journey-exit count, NOT goal attainment - use visitorsAchievedGoal for that. For optional-goal journeys, achieving the goal does not by itself mark a visitor completed, so an achiever is counted here only once they later reach an Exit or age out - visitorsAchievedGoal: unique entered visitors who achieved the journey goal, computed independently of completion tagging (omitted for journeys with no goal). Because attainment is tracked separately from completion, this can briefly exceed visitorsCompleted while achievers are still in-flight - it is not a stable relationship - goalAttainmentRate: visitorsAchievedGoal as a percentage of visitorsEntered on a 0-100 scale, not a 0-1 fraction - goal: the journey goal definition (type, itemType, itemId, isGoalOptional); omitted for journeys with no goal - When startDate and endDate are provided, visitorsEntered and visitorsCompleted are limited to entry/exit within that range; otherwise cumulative totals are returned - visitorsAchievedGoal and goalAttainmentRate are always cumulative (the backend goal-achievement definition is not time-bounded) and are omitted when a date range is provided; request without a date range to retrieve them The maximum time range for this tool is 367 days.
getOrchestrateJourneyStepMetrics
ChatGPTGet per-step performance metrics for a single Orchestrate journey by ID. Returns one entry per message step in execution-flow order, matching the per-step columns on the Orchestrate journey metrics page. Every count is scoped to journey entrants - visitors who entered THIS journey within the requested date range - not campaign- or guide-wide activity, so the numbers reconcile with the journey metrics page. Email steps include delivery, unique opens, unique clicks, bounces, unsubscribes, and spam complaints among those entrants. Guide steps include the journey-page guide engagement columns: viewed (entrants who saw the guide) and clicked (entrants who interacted with it), plus the derived clickRate. Survey and VOC email steps are not Orchestrate journey deliverables and carry metricUnavailableReason instead of email metrics. Other unsupported step types carry no metrics and a metricUnavailableReason instead. Use getOrchestrateJourneySteps for the full step graph, getOrchestrateEmailMetrics for a single standalone email, and getOrchestrateJourneyMetrics for journey-level goal attainment. Guide steps do not include guide-wide analytics (completions, NPS, poll breakdowns, or guide-level conversion goals). USE FOR: Per-step email or guide performance among journey entrants over a date range. EXAMPLES: - How did each step in orchestrate journey 123 perform last month? - Show per-step open and click rates for orchestrate journey abc between 2025-01-01 and 2025-01-31 - Which email step in this orchestrate journey had the best open rate? - Compare guide view and click counts across the steps of orchestrate journey 123 NOT FOR: Journey-wide entry and goal totals only, or per-visitor lists for one step. WORKFLOW: Call listOrchestrateJourneys to discover journey IDs, then call this tool with journeyId and a date range to get per-step metrics. RETURNS: - steps: an array of message steps in execution-flow order. Each step has: stepId, stepType, position, messageId, messageType, provider (plus the per-step metric fields below) - steps[].position: 0-based index of the step in the journey's execution flow across ALL nodes (start/exit/condition nodes also consume positions, so message-step positions are non-contiguous); cross-reference with getOrchestrateJourneySteps - steps[].email: per-step email metrics among journey entrants (sent, delivered, opened, clicked, bounced, unsubscribed, complaint and the derived rates on a 0-100 scale, not 0-1 fractions; openRate/clickRate are % of delivered); present only for email steps. The page surfaces opened and clicked per step; the remaining counts are the same entrant-scoped events - steps[].guide: per-step guide engagement matching the journey metrics page - viewed (journey entrants with a guide-seen event), clicked (journey entrants with a guide-interaction event), and clickRate (clicked/viewed % on a 0-100 scale, not a 0-1 fraction); present only for guide steps. Does not include guide completions, dismissals, NPS, poll breakdowns, or guide-level conversion goals; those are guide analytics, not journey per-step metrics - steps[].metricUnavailableReason: present when both email and guide are null - step_type_not_supported (unsupported step type, or survey/VOC email), or message_not_found (linked email/guide missing) - steps[]: every count is scoped to visitors who entered this journey within [startDate, endDate]; a step the caller cannot access (no view permission on the message's application) returns a zero-valued metrics block, not an error or a missing step, matching the journey metrics page - journeyId, name, status, startDate, endDate, and stepCount (number of message steps returned) are top-level fields for orientation The maximum time range for this tool is 367 days.
getOrchestrateJourneyStepVisitors
ChatGPTList per-visitor engagement for one message step of an Orchestrate journey within a date range. Scoped to journey entrants who entered this journey within [startDate, endDate] (same entrant scope as getOrchestrateJourneyStepMetrics and the journey metrics page), not standalone email sends (getOrchestrateEmailVisitors), not guide-wide analytics (guideUsage), and not current journey enrollment. Engagement events on each row must also fall within [startDate, endDate]. Returns { meta, summary, rows }. Each row is visitorId plus non-negative integer sent/delivered/opened/clicked/bounced/unsubscribed/complaint/viewed/guideClicked counts; fields that do not apply to the step type are 0; counts can exceed 1 for repeated opens/clicks while summary.numVisitors stays distinct-visitor scoped. eventType filters which entrants appear in rows (email default opened when omitted; guide default viewed when omitted). An eventType invalid for the step messageType returns invalid_request, not empty rows. summary.numVisitors is the distinct matching entrant count before limit; summary.truncated is true when numVisitors exceeds len(rows) (no pagination token yet). Survey/VOC email steps return empty rows with meta.metricUnavailableReason step_type_not_supported. Journeys not yet materialized (empty entry visitor-tag / StaticSegmentId) return empty rows with summary.numVisitors=0 and no metricUnavailableReason - not an error. A step the caller cannot view returns empty rows, not an error (unlike getOrchestrateEmailVisitors by emailId, which returns entity_not_found). USE FOR: Per-visitor engagement on one journey message step among entrants over a date range. EXAMPLES: - Who opened email <emailId> on journey <journeyId> last month? - List visitors who viewed guide <guideId> on journey <journeyId> in January - Did visitor visitor@example.com click guide <guideId> on journey <journeyId>? NOT FOR: Journey-wide aggregates or standalone email recipient lists outside journey-entrant scope. WORKFLOW: Call with journeyId, messageId (emailId or guideId - the same messageId from getOrchestrateJourneySteps or other Orchestrate tools), startDate, endDate, and optional eventType/visitorId/limit. stepId from getOrchestrateJourneySteps is accepted when messageId is unavailable. RETURNS: - meta: { journeyId, stepId, position, messageId, messageType, startDate, endDate, eventType } echo of request scope and resolved step - summary.numVisitors: distinct journey entrants matching eventType before the row limit (not capped by limit) - summary.truncated: true when summary.numVisitors exceeds len(rows); rows alone are incomplete when truncated is true (no continuation token yet) - rows[]: { visitorId, sent, delivered, opened, clicked, bounced, unsubscribed, complaint, viewed, guideClicked } non-negative integer event counts in range; irrelevant fields are 0; on guide steps guideClicked holds guide-interaction counts (getOrchestrateJourneyStepMetrics uses guide.clicked for the same concept); sorted by visitorId; capped at limit (default 200, max 5000) - meta.metricUnavailableReason when rows cannot be produced: step_type_not_supported (non-email/non-guide step, or survey/VOC email), or message_not_found (linked email/guide missing). Unmaterialized journeys (no entry segment yet) omit this field and return empty rows instead The maximum time range for this tool is 367 days.
getOrchestrateJourneySteps
ChatGPTGet the ordered step graph (nodes and edges) for a single Orchestrate journey by ID. Returns the journey's structure only: each step's type, position, and linked message IDs, plus the edges connecting the steps. Does NOT return per-step metrics (sends, opens, clicks); use getOrchestrateJourneyStepMetrics for those. Use listOrchestrateJourneys to discover journey IDs and getOrchestrateJourney for journey-level config. Before graph inserts on an existing journey, use this tool for edge ids, step ids, and journey status (inserts are allowed only in draft or review). USE FOR: One journey's step graph: ordered steps, edges (with ids for graph inserts), and message IDs on message steps. EXAMPLES: - Show the steps of orchestrate journey 123 - What messages are in this orchestrate journey? - List the steps and their order for orchestrate journey xyz - What is the structure of this orchestrate journey? - Which guide/email is sent at each step of orchestrate journey 123? WORKFLOW: Call listOrchestrateJourneys to discover journey IDs, then call this tool with journeyId to retrieve the journey's steps and how they connect. getOrchestrateJourneyStepMetrics needs only journeyId and a date range (all steps). Use messageId (emailId/guideId) from a step with getOrchestrateJourneyStepVisitors; stepId is a fallback graph node id for visitors when messageId is unknown. RETURNS: - status: UI lifecycle label for the journey (use with add-node workflows to confirm draft or review before graph inserts) - steps: journey nodes in execution-flow order (same order the Orchestrate editor renders, walking from the start node; a condition's Yes branch precedes its No branch). position is the 0-based index in that flow order - name: for message steps this is the linked email/guide's display name (as shown in the Orchestrate editor); for other steps it is the node's label and may be empty - message steps additionally include messageId, messageType (Email | Guide), provider, durationInDays (Email: days until the next step; Guide: days the guide stays active/eligible for the visitor) - edges: the connections between steps (from, to, edgeType where edgeType is Regular for linear steps or Yes/No for condition branches) - startNodeId and stepCount (number of message steps) for quick orientation
getOrchestrateJourneyVisitors
ChatGPTList who is in an Orchestrate journey and, for visitors still in progress, which step they are on. Who entered, who finished, and current step for visitors in the journey. Not email or guide opens/clicks. No date range. Use listOrchestrateJourneys for journeyId. Journeys that have not started yet return no rows (see meta.enrollmentAvailable). USE FOR: Listing who is in a journey: who entered, who finished, and the current step for visitors still in progress. EXAMPLES: - Who is in orchestrate journey abc right now? - Which step is visitor X on in journey abc? - List visitors still in journey abc - Who completed journey abc? - List everyone who ever entered journey abc NOT FOR: Historical performance over a date range, or email and guide open and click analytics. WORKFLOW: Call listOrchestrateJourneys for journeyId, then call with journeyId. Optional inputs: enrollmentFilter (default active), visitorId, limit (default 200, max 5000). No date range. RETURNS: - meta.journeyId, meta.journeyName, meta.journeyStatus (draft/active/paused/etc.), meta.enrollmentFilter (echo of enrollmentFilter input: active, completed, or all), meta.evaluatedAt (UTC time this snapshot was built) - meta.enrollmentAvailable: false when listing is not ready (no entry segment, no completion segment, or active journey with a future start date); true when listing works - numVisitors may still be 0 if nobody matches the filter. Invalid or missing visitor flow graph returns a tool error (no rows). - summary.numVisitors: visitors matching meta.enrollmentFilter; computed before the row limit and not capped by limit - summary.truncated: true when numVisitors exceeds len(rows); rows alone are incomplete when truncated is true (no pagination token) - rows[]: visitorId; enteredAt; completed (boolean); completedAt when completed; stepVisits[] (stepId, stepName, enteredAt) for each journey step segment tag visible at meta.evaluatedAt; when in progress and step is known: currentStepId, currentStepName, currentStepPosition, currentStepEnteredAt, messageId, messageType
getOrchestrateVisitorEmails
ChatGPTList per-email engagement for one visitor across accessible Orchestrate emails in a date range. Returns { meta, summary, rows }. Each row is emailId plus integer sent/delivered/opened/clicked/bounced/unsubscribed/complaint counts for that visitor. eventType filters which emails appear in rows (default opened); each row still includes all event-type counts. Counts can exceed 1 for opens/clicks. Bounce counts reflect hard bounces only (Permanent). Only Orchestrate emails you can access are included - not every email campaign in the subscription. Use getOrchestrateEmailMetrics for email-level totals without per-visitor rows. USE FOR: Which Orchestrate emails did this visitor receive, open, click, bounce, unsubscribe, or complain about in a date range - one visitor, many emails. EXAMPLES: - Which orchestrate emails did visitor abc open last month? - List emails visitor@example.com clicked in January - Which orchestrate emails did visitor abc receive last week? - Show orchestrate emails visitor X bounced on last month NOT FOR: One email and its visitors in a date range (not all emails for one visitor). Email-level totals without per-visitor rows. Journey step visitors in a date range. Journey enrollment snapshots without a date range. WORKFLOW: Call with subId, visitorId, startDate, and endDate. Optional eventType (default opened; use sent or delivered for delivery lists). Optional segmentPipeline scopes the audience; optional blacklist controls blacklist filtering (default apply). RETURNS: - meta: { startDate, endDate, eventType } echo of request scope - summary.numEmails: distinct emails with at least one event matching eventType in range; computed before the row limit and not capped by limit; may exceed len(rows) - summary.truncated: true when summary.numEmails exceeds len(rows); rows alone are incomplete when truncated is true (no pagination token) - rows[]: { emailId, emailName?, sent, delivered, opened, clicked, bounced, unsubscribed, complaint } non-negative integer counts; sorted by emailId; truncated at limit (default 200, max 5000) The maximum time range for this tool is 367 days.
getOrchestrateVisitorJourneyState
ChatGPTList which Orchestrate journeys one visitor is enrolled in and, for in-progress journeys, which step they are on. Returns { meta, summary, journeys[] } (not rows[]). Answers enrollment across journeys for a single visitor - who entered, who finished, current step. Not email or guide engagement in a date range. No startDate or endDate. Point-in-time snapshot at meta.evaluatedAt. Only journey definitions that are currently active or paused are in scope; enrollments on ended or archived definitions may not appear even when enrollmentFilter=all or enrollmentFilter=completed. USE FOR: Which journeys is this visitor in, how many active enrollments, and current step per journey - one visitor, all matching journeys. EXAMPLES: - Which orchestrate journeys is visitor abc in? - How many active journeys is visitor X enrolled in? - List completed orchestrate enrollments for visitor abc among active or paused journeys - Which step is visitor X on across their active orchestrate journeys? NOT FOR: Who is in one journey (not one visitor across journeys). One journey step with events in a date range. Journey-wide counts without per-journey rows. One email for one visitor in a date range. All emails for one visitor in a date range. WORKFLOW: Call with subId and visitorId. Optional enrollmentFilter (default active; same semantics as getOrchestrateJourneyVisitors) and limit on journeys[] (default 200, max 5000). No date range. RETURNS: - meta: enrollmentFilter (echo of input: active, completed, or all), evaluatedAt (UTC snapshot time) - summary.numJourneys: journeys matching enrollmentFilter before the row limit and not capped by limit - summary.numActiveJourneys: visitor mid-flow enrollments among journeys you can read (not filtered by enrollmentFilter); includes paused journey definitions; excludes future-scheduled active definitions only - summary.truncated: true when numJourneys exceeds len(journeys); journeys alone are incomplete when truncated is true (no pagination token) - journeys[]: journeyId, journeyName, journeyStatus (UI lifecycle label; scheduled when start is in the future), enteredAt and completedAt when present (omitted for legacy zero timestamps), completed when finished; when in progress: currentStepId, messageId, messageType, awaitingMessage, awaitingCondition; missingEntryTag on entry-tag anomalies (omitted from enrollmentFilter=all). Journeys where the visitor hit the entry throttle and never received an entry tag are omitted
getSegment
ChatGPTReturns a single Pendo visitor segment by ID, including its name, definition in LLM-friendly DSL form, and optionally the guides, Orchestrate journeys, reports, compound segments, and session-replay apps that reference it. USE FOR: Inspect or read a saved segment's rules. Use when you need the current definition before modifying it, or when you need to know where a segment is in use. EXAMPLES: - Show me the definition of segment abc123. - What guides are using segment xyz789? RETURNS: - id: the segment ID. - name: human-readable segment name. - description: optional segment description (omitted if empty). - shared: whether the segment is publicly shared. - summary: plain-English description of the segment rules with entity names resolved. - definition: the segment rules in DSL form - same format accepted by create and update Segment tools. Omitted for segments authored outside the agent workflow that use features the DSL can't represent, and for segments with no rule-based definition (e.g. segment-flag or auto-managed segments). - note: only set when definition is omitted; explains why the segment can't be represented as DSL. Such segments are readable but not editable via the agent's update path. - usedBy: guides, Orchestrate journeys, reports, compound segments, and session-replay apps that reference this segment. Only present when includeUsedBy is true.
get_agent_context
ChatGPTFetches a grounding document that describes the current contents of a Pendo product resource so the LLM can reason about it. Today the only supported resource is a Pendo Space — a collaborative canvas of product artifacts (pages, features, guides, notes, etc.) curated by a team. Pass resource_type (e.g. "space") and resource_id (the id of that resource, e.g. a space id) to retrieve the document. Call list_spaces first if you need to discover a space id. The response is JSON returned by the Spaces service and typically contains a markdown body plus a schema describing the resource's contents; do not assume a shape beyond what the response declares. Use frame_id to scope a space's context to a single frame on the canvas (and items whose parent is that frame) — useful when the user's UI is focused on that frame; omit frame_id for the full space. PERFORMANCE: This is a fast-running tool.
get_feedback_insights
ChatGPTRetrieves key customer feedback insights extracted from raw feedback matching the given filters. Each item includes a summary, explanation, and supporting quote. Use this when the user wants to see actionable feedback insights which have been distilled from the raw customer feedback. Note: insights can also be referred to as 'highlights' PERFORMANCE: This is a slow-running tool. This tool is only available to be called for the following subscriptions: pendo-internal (5668600916475904) (Demo) Pendo Experience (6591622502678528) (External Customer) Pendo Experience Sandbox (4691349476737024)
get_feedback_items
ChatGPTRetrieves the original, raw customer feedback matching the given filters. Each item includes id, title, description, and info about the account and visitor which gave the feedback. Use this when the user wants the full raw feedback, as opposed to the extracted insights or clustered topics. A maximum of 30 items will be returned, however there may be more matching the filter set. PERFORMANCE: This is a slow-running tool. This tool is only available to be called for the following subscriptions: pendo-internal (5668600916475904) (Demo) Pendo Experience (6591622502678528) (External Customer) Pendo Experience Sandbox (4691349476737024)
get_ideas
ChatGPTRetrieves product ideas submitted by internal product employees which describe product enhancements and new features matching the given filters. Each item includes id, title, and description. A maximum of 30 items will be returned, however there may be more matching the filter set. PERFORMANCE: This is a slow-running tool.
guideEffectivenessMetrics
ChatGPTDashboard-consistent, visitor-weighted Guide Effectiveness metrics for every guide, with optional comparison across up to 4 segments. Returns one row per guide plus an overview summary of averages across the matched set. Rates are visitor-weighted exactly as the Guide Effectiveness dashboard computes them: engagement = distinct visitors who interacted / distinct visitors who viewed; completion = distinct visitors who reached the last step / distinct visitors who reached the first step (multi-step guides only); goal adoption = converted visitors / total visitors (guides with a conversion goal only). Every rate ships with its raw numerator and denominator so sample size is visible. Aggregates cover the whole date range (no time-series buckets). Use sortBy to rank guides by a chosen metric, ascending or descending. IMPORTANT: When presenting results to the user, always state the active filters alongside the data: date range, app (if specified), segment(s), status filter, and activation filter. This lets users verify exactly which data scope produced the numbers. USE FOR: Reporting guide effectiveness that matches the Guide Effectiveness dashboard (engagement %, completion %, goal-adoption %), and comparing those rates across up to 4 segments. EXAMPLES: - How effective are our guides over the last 30 days? - Compare guide engagement and completion between the power-users and trial segments - Which guides have the lowest completion rate this month? - Show goal adoption for guides that have a conversion goal NOT FOR: Simple cross-guide ranking by raw views/dismissals (use aggregateGuideMetrics). Deep single-guide analysis with polls, NPS, or step funnels (use guideMetrics). RETURNS: - meta: resolved dateRange (startDate/endDate), the segments compared, and guideCount - summary: per-segment overview - totalViews, totalFirstTimeViews, totalVisitors, engagementRate, completionRate, goalAdoptionRate - rows: one per guide with entityId, entityName, state, launchMethod, and per-segment metric blocks (rate + raw numerator/denominator). completionRate is null for single-step guides; goalAdoptionRate is null for guides without a conversion goal
guideMetrics
ChatGPTGet comprehensive guide performance analysis including reach, engagement, and effectiveness metrics. USE FOR: Analyzing specific guide performance with core metrics like reach, engagement rates, and completion analysis. EXAMPLES: - How is the onboarding guide performing this month? - Show me metrics for the tooltip guide - What are the completion rates for the walkthrough guide? - How many users are dismissing the announcement guide? - Show me daily guide completion trends over the last 2 weeks - What's the weekly pattern for guide engagement? RETURNS: - Reach metrics: total views, unique viewers, unique accounts - Engagement metrics: views per user, total interactions - Effectiveness metrics: completion rate, dismissal rate - Poll unique visitor response counts and total response counts grouped by pollId (for guides with polls) - NPS metrics (for NPS guides): npsScore, avgScore, numPromoters, numNeutral, numDetractors, per-score distribution (responseCount0 through responseCount10) - Range periods (dayRange/weekRange): single aggregated values across entire date range - Iterative periods (daily/weekly): time series with metrics broken down by day/week - Raw aggregation results in JSON format The maximum time range for this tool is 93 days. PERFORMANCE: This is a fast-running tool.
guidePollResponses
ChatGPTGet per-poll response distribution and per-visitor response rows for a guide's non-NPS polls. Returns {meta, summary, rows}: summary.polls lists each poll with its question and response distribution; rows are visitor-keyed and pivoted - one column per poll, null where a visitor did not respond. limit (default 10, max 200) applies to the pivoted visitor rows after joining across all polls. USE FOR: Answering questions about how visitors responded to polls in a guide: response distributions, individual visitor answers, and per-poll breakdowns. Not for NPS guide score metrics. EXAMPLES: - What were the responses to the poll in the onboarding guide? - Show me the response distribution for guide X polls - Which visitors answered 'Yes' to the helpfulness poll? - What did visitors respond to the polls in guide G last month? RETURNS: - meta.dateRange: resolved startDate and endDate (YYYY-MM-DD) - summary.polls: array of {pollId, question, distribution: [{response, count}]} for each poll. For free-text polls (open-ended responses), freeText is true and distribution is omitted because every response is unique - refer to the per-visitor rows instead. - rows: per-visitor with visitorId, accountId, browserTime, and one column per pollId (null if no response)
guideUsage
ChatGPTGet per-visitor or per-account usage breakdown for a single guide, with time-on-guide and new vs returning viewers. totalViews excludes continue-resumed guideSeen events to match the Pendo guide-details UI. For poll guides, includes per-poll response counts and response rate in summary. USE FOR: Per-visitor or per-account guide engagement - e.g. top visitors by time on guide, which accounts are completing vs dismissing, new vs returning viewer counts. With includeElements=true, also attributes each step's clicks to the individual buttons/links on it. EXAMPLES: - Top 20 visitors by time on guide X in the last 30 days - Which accounts are dismissing the onboarding guide most? - How many new vs returning viewers did the walkthrough have this month? - Show me per-visitor completion data for the tooltip guide - Is drop-off at step 3 happening via the CTA or by dismissing the guide? - Which button on the last step of the onboarding guide gets clicked most? NOT FOR: Journey-scoped per-step entrant lists for a guide message step within an Orchestrate journey (use getOrchestrateJourneyStepVisitors). Per-step aggregate guide viewed/clicked counts across all steps (use getOrchestrateJourneyStepMetrics). RETURNS: - meta.dateRange: resolved startDate and endDate (YYYY-MM-DD) - meta.experimentIds: IDs of accessible guide experiments containing this guide - summary: totalViews, completions, dismissals, uniqueVisitors, uniqueAccounts, completionRate, dismissalRate, viewsPerUser, avgTimeOnGuide, medianTimeOnGuide (duration objects {seconds, display}), newViewers, returningViewers, isPoll - summary.polls (poll guides only): per-pollId uniqueResponseCount and totalResponseCount - rows: per-visitor or per-account rows with views, completions, dismissals, daysActive, lastSeen (timestamp object {iso, display}), timeOnGuide (duration object {seconds, display}) (per-account rows also include uniqueVisitors), sorted and limited - steps (only when includeSteps or includeElements is true): per-step array in guide step order, each with stepId, name, uniqueVisitors, viewCount. Single-step guides return one entry; step views include continue-resumed views to match the Pendo step funnel. - steps[].elements (only when includeElements=true): the step's clicked buttons/links, highest clicks first, each with uiElementId, text, type ('Button', 'Close Button', 'Link', 'Task Item', 'Image', 'Swiped Left', 'Swiped Right' or 'Unknown'), actions (what the click does, e.g. 'Next Step', 'Dismiss Guide', 'External URL', 'Go to Step (2)'), clicks, uniqueVisitors, percentOfStepClicks. Compare an element's uniqueVisitors against its step's uniqueVisitors to attribute drop-off. Only clicked elements appear, and elements since removed from the step are still counted. The maximum time range for this tool is 367 days.
linkIdeaAndFeedback
ChatGPTLinks an existing feedback item to an existing idea, associating the customer evidence with the feature request. Votes from the feedback item are propagated to the idea's vote count. USE FOR: When the user explicitly asks to link, connect, or associate a feedback item with an idea, or vice versa EXAMPLES: - Link feedback abc123 to idea xyz456 - Connect this feedback to that idea - Associate idea xyz456 with feedback abc123 RETURNS: - Confirmation that the idea and feedback item have been linked
listAccounts
ChatGPTList the accounts that match a segment or fuzzy-search account display names or IDs. Segment mode (the default) defines the cohort with a segmentPipeline - either a saved Pendo segment ID or the pipeline returned by buildPendoSegment. To find accounts by metadata or activity, call buildPendoSegment first and pass its <pipeline> output verbatim; never pass segment rules or a definition as segmentPipeline. Search mode fuzzy-matches both the configured account display-name field and account ID. USE FOR: Listing the accounts in a segment/cohort, getting the account total, reading account metadata fields for those accounts, or resolving a named account to its ID without an application ID. EXAMPLES: - List the accounts in segment X - Which accounts match these metadata criteria? - How many accounts are in this segment? - Show me accounts in segment X with their ARR and company size - Find the account called Acme Inc RETURNS: - summary: numAccounts (the full segment total in segment mode; the number of returned matches in search mode) - rows in both modes: accountId, name, description when available, and requested fields in a metadata object keyed by metadata path (for example, "metadata.auto.lastvisit"), capped by limit - Search rows also include relevance. Only sufficiently relevant fuzzy matches are returned; unrelated accounts are omitted
listAiAgentIssues
ChatGPTLists detected (emergent) issues in AI agent conversations with instance counts and conversation counts. Returns a table of issue name (clusterName), summary, instance count, and conversation count per issue, plus a sample of conversationIds/eventIds for deep-diving via agentAnalyticsIssueAnalysis. It also returns visitorIds and accountIds who experienced the issue. USE FOR: Finding what problems or issues users encountered when using AI agents (e.g., incorrect answers, refusals, errors). Use when the user asks about common issues, problems, or failures with a specific agent. Refer to an issue by its clusterName, never its numeric clusterId. EXAMPLES: - What are the common issues my users are encountering using my ABC agent in the last 30 days? - What problems have users been encountering when using Acme agent in my Acme application lately? - Have we seen reduced occurrences of issues with incorrect answers in our fooBar agent since last month? - What models are most often used when users face problems with the chat agent in ScramCorp app? NOT FOR: Use listUseCases for topic/cluster analysis of conversations. Use listAiAgents to get agent IDs and names first when the user has not specified an agent. RETURNS: - Table of issues: summary, instance count, conversation count, agentId, appId, visitorIds, and accountIds. - Sorted by conversation count descending. Limited to 500 rows. The maximum time range for this tool is 90 days.
listAiAgents
ChatGPTLists all AI agents that the user has access to. AI agents are conversational assistants that can be deployed on specific pages or app-wide. AI agents have the ability to collect conversations, cluster prompts by topics/use cases, and calculate metrics like conversation counts and rage prompt detection. This tool returns agent ids and names for usage with other related agent tools.
listAllApplications
ChatGPTPendo data is split into subscriptions, which share a set of visitors and accounts. Each subscription is split into separate applications. This call returns a list of all the names and ids of all the subscriptions this user has access to, along with the names and ids of all of the applications in that subscription. Most tools for this mcp require at least a subscription id; many also require an application id. Application ids are not unique across different subscriptions.
listBusinessObjectMetadata
ChatGPTList every metadata field declared on one already-identified designated business OBJECT (see listCustomObjects) - the fields customers send on metadata events for that object (e.g. 'type', 'isShared'), the same schema accountMetadataSchema/visitorMetadataSchema expose for accounts/visitors. Empty metadataSchema means the customer has never sent metadata events for this object. USE FOR: The user asks what metadata fields, properties, or dimensions are available on a business object; or resolveBusinessObject reported a term as unmatched (with or without a suggestion) and you need the full set of declared fields to find the right one, e.g. to offer the user a corrected choice. EXAMPLES: - What metadata fields are available on the 'reportId' object? - resolveBusinessObject said 'type' doesn't match reportId's schema - what fields does it actually have? NOT FOR: Checking whether SPECIFIC terms from a question belong to the object - use resolveBusinessObject, which also fuzzy-suggests close matches for an unmatched term without needing the full list. Listing which business objects exist in the first place - use listCustomObjects. Any per-object metric - use objectAnalyticsActiveCount, objectAnalyticsBreakdown, or objectEventBreakdown. RETURNS: - field, kind, group/metadataKind (historical objects only): the object identifier that was checked, echoed back exactly as it should be passed to objectAnalyticsActiveCount, objectAnalyticsBreakdown, or objectEventBreakdown. - metadataSchema: every declared metadata field on this object, keyed by its normalized field name, with type/cardinality/sample values - empty when the customer has never sent metadata events for it.
listCustomObjects
ChatGPTList a subscription's designated business OBJECTS - the custom event properties that have been marked as analyzable business entities (e.g. 'dashboardId', 'venueId', 'orderId'). Returns each object's underlying event property name (its field) and kind, which are exactly the objectProperty argument the objectAnalytics tools take, plus its customer-facing displayName/description when an admin has set them. Objects are NOT pages, features, or track events. USE FOR: Discovering which business objects a subscription has, and grounding an ambiguous entity name before an objectAnalytics call. Use it when a name could mean either a business object or a page/feature (e.g. 'dashboards') to confirm the object exists and get the exact objectProperty.field to pass to objectAnalyticsActiveCount or objectAnalyticsBreakdown. The search term matches the object's field name, displayName, or description, so a customer-facing label (e.g. 'Reports') resolves even when it doesn't textually overlap the underlying field key (e.g. 'rp_obj_4471'). EXAMPLES: - What business objects can I analyze in this subscription? - Is 'dashboard' a business object or a page? - List the custom objects available for Object Analytics - Which object property identifies venues? NOT FOR: Listing pages, features, or track events - use listPagesFeaturesAndEvents. Counting or ranking objects, or any per-object metric - use objectAnalyticsActiveCount or objectAnalyticsBreakdown. This returns only the object property definitions, never metrics. Confirming whether a METADATA TERM (e.g. 'size', 'region', 'category') actually belongs to a specific object's own schema - use resolveBusinessObject. WORKFLOW: To resolve a specific object by name, prefer searchType='substring' with the name as the user gave it; if that returns no match, retry with searchType='fuzzy' to survive a misspelling or a loosely-worded label. Choosing the mode is your call - the server never falls back automatically. If the question references metadata terms rather than - or in addition to - one of the object names returned here, do not assume a term belongs to whichever object seems closest. Pick the most likely candidate object from this list (asking the user first if more than one plausibly fits) and call resolveBusinessObject with that object's field (and kind/group/metadataKind for historical objects) plus the terms, to confirm they're actually part of its schema before running an objectAnalytics query. RETURNS: - One entry per designated object property: field (the event property name to pass as objectProperty.field, e.g. 'dashboardId'), and kind ('event' or 'historical'). - displayName and description: the customer-facing label and description set by an admin, when present. Absent when never set. - For historical (promoted visitor/account/parentAccount metadata) objects, group and metadataKind are also included. - promotedAt (epoch milliseconds): when the property became an analyzable object. This is the activation floor the objectAnalytics tools apply internally - events before it are excluded - so use it to caveat data availability or pick a start date that postdates promotion. - matchedFields (substring search only): which of field/displayName/description the term matched, so you can see why an object was returned. A match on field or displayName is a strong signal; a description-only match is weaker (descriptions are free-form sentences, so the term may appear incidentally) - prefer field/displayName matches when ranking candidates. - relevance (fuzzy search only): a similarity score for ranking - higher means a closer match to the search term. Rank candidates by it; matchedFields is absent in this mode.
listGuideCategories
ChatGPTReturns all guide categories for a subscription - their IDs, names, and platform (web or mobile). Each category exists as a paired web+mobile variant with distinct IDs; use the platform filter to narrow results. USE FOR: Finding a guide category ID to associate a guide with a category, or enumerating which categories exist for a subscription. Pair with listGuides to see which guides belong to each category. EXAMPLES: - What guide categories are set up for this subscription? - List all guide categories - Show me web guide categories - Which mobile guide categories exist? - What are the available guide categories and their IDs? NOT FOR: Guide analytics or engagement metrics - use guideMetrics or guideUsage instead. To search or list guides themselves, use listGuides. RETURNS: - Array of guide categories, each with: id, name, platform (web or mobile)
listGuideExperiments
ChatGPTList guide experiments (guide A/B tests) and return their IDs. A guide experiment splits an audience across two or more variants to compare which performs better. Each variant is either a guide or the control group (no guide, shown as isControl). Experiments move through states: draft (not started), active (running), needsReview (finished, awaiting a decision), completed. This is the lookup tool for resolving an experiment name to its ID, and for finding which experiment a guide is part of - filter by guideIds to answer "is this guide being A/B tested?". It returns experiment configuration only. Use guideExperimentResults for per-variant visitors, conversions, conversion-rate difference, confidence, significance, processing status, and the winning or promoted variant. USE FOR: Listing or browsing guide experiments; resolving an experiment name to its ID; checking which experiment a guide belongs to (guideIds); listing experiments in a given state, such as which experiments are currently running. EXAMPLES: - What guide experiments do we have? - Which guide experiments are currently running? - Is guide abc123 part of an experiment? - Show me guide experiments that have completed - List guide experiments for app 12345 NOT FOR: Guide content, targeting, or scheduling - use listGuides. Per-guide engagement or completion metrics - use guideEffectivenessMetrics or aggregateGuideMetrics. Experiment visitors, conversions, conversion-rate difference, confidence, significance, processing status, or winner - use guideExperimentResults. RETURNS: - Array of experiments with: id, name, description, state, appId, startTime, endTime, conversion, completionBehavior, winningVariant, audience, autoPromoteConfig, and versionInfo - variants per experiment: variant name, guideId, groupSize (percentage of the audience assigned to the variant, summing to 100), and isControl for the control group, which has no guide FILTERING OPTIONS: - guideIds: only experiments that have one of these guides as a variant - state: only experiments in this state - draft, active, needsReview, completed - appId: only experiments scoped to that application
listGuideOrdering
ChatGPTList the guide delivery order ("throttle order") for an app. When multiple guides are eligible to show at the same time, the delivery order determines which guide takes precedence. This tool returns the ordered list of guides for the given app. An app with no ordering set returns an empty list. Guides are capped by limit (default 50). totalGuides is the full ordering length; offset and returned describe the slice in guides. When returned < totalGuides the result is truncated - tell the user which range they're seeing (e.g. "showing 1-50 of 120") and use offset to page through the rest. PRESENTATION (follow exactly): For EVERY guide, show ALL SIX of these columns, always in this order: Guide Name | Status | Segment | Page | Guide Category | Product Area Show every column even when most guides share a value and even when a column has no values. Segment is the readable segment name (e.g. "Everyone", "Browser: Chrome"). Page is "Sitewide" when the guide targets no specific page. Do NOT show the raw guideId to the user. It is for your context only, to reference guides in follow-up tool calls. EXAMPLES: - What is the guide delivery order for app xxx? - Which guide shows first when several are eligible? - Show me the throttle ordering for app xxx RETURNS: - appId, appName, totalGuides, offset, returned, and the ordered guides for the app - totalGuides/offset/returned: the full ordering length and the returned slice - surface the range to the user when truncated - guides: in delivery order. Always display these six columns per guide: Guide Name, Status, Segment, Page, Guide Category, Product Area - guideId is context-only - never shown to the user
listGuides
ChatGPTList and filter in-app guides. Returns guide ID, name, description, state, and scheduling info. Use this tool to find guides by status, type, activation method, or other attributes. Guides are interactive in-app experiences (tooltips, walkthroughs, banners, lightboxes, etc.) that guide end-users through tasks in their application. EXAMPLES: - List all public guides - Show me draft guides - Find all walkthrough guides - Which guides are set to launch automatically? - List guides that have expired - Show me all tooltip guides that are currently staged RETURNS: - Summary info for each matching guide: ID, name, description, state, type, launch method, and scheduling timestamps (showsAfter, expiresAfter) FILTERING OPTIONS: - status: Filter by guide state — public, staged, draft, _pendingReview_, disabled - guideType: Filter by guide type — banner, tooltip, lightbox, walkthrough, whatsnew, building-block, group, training, launcher, mobile-lightbox - activation: Filter by launch method — auto (automatic/app launch), api (programmatic), badge, dom (element click), embed (embedded), launcher (guide/resource center), page (page view), feature (element click, mobile), form, track (track event) - expiration: Filter by expiration status — active (not expired), expired (past expiration date) PERFORMANCE: This is a fast-running tool.
listOrchestrateEmails
ChatGPTList Orchestrate email campaigns and their high-level metadata. Includes standalone and journey-linked orchestrate emails (VoC emails excluded). When a user asks to list emails or orchestrate emails, use this tool. USE FOR: Listing or browsing Orchestrate email campaigns and discovering email IDs. EXAMPLES: - List all emails - List all standalone emails - List all orchestrate emails - List all omnichannel emails - Show orchestrate email campaigns - What email campaigns do we have? - Show sent emails - Show scheduled orchestrate emails - What orchestrate emails are in draft? - List email campaigns for this subscription - List orchestrate emails for app 12345 - Find orchestrate emails named welcome NOT FOR: Reading full configuration or performance metrics for one email when you already have its ID. WORKFLOW: Use this tool to discover email IDs, then call getOrchestrateEmail for full campaign configuration. RETURNS: - Orchestrate email identifiers and names (standalone and journey-linked) - Status and lifecycle timestamps (publishedAt, triggeredAt, executedAt); status is a UI lifecycle label for standalone emails (scheduled vs public follows the same start-time rule as the Orchestrate UI) - Subject and created/updated timestamps
listOrchestrateJourneyTemplates
ChatGPTList Orchestrate journey templates shown in the UI template chooser (intent and layout metadata). These ids mirror UI layouts - many include guides not yet supported by MCP journey create tools. For MCP create from a built-in graph, use createOrchestrateJourneyFromTemplate with templateId mcpSingleEmailJourneyTemplate. Provide appId to filter to templates shown for that application platform (web vs mobile). USE FOR: Listing Orchestrate journey template options from the UI catalog. EXAMPLES: - What journey templates does Orchestrate offer? - List orchestrate journey templates for app 12345 - Show welcome and onboarding journey template options WORKFLOW: Use to show UI template options to the user. For built-in template create use createOrchestrateJourneyFromTemplate with templateId mcpSingleEmailJourneyTemplate; for custom graphs use createOrchestrateJourneyFromJson. RETURNS: - Template id, label, description, category, graphSummary, and platform support - UI layout catalog - not all ids are MCP-creatable; four platform-filtered entries when appId is provided
listOrchestrateJourneys
ChatGPTList Orchestrate journeys and their high-level metadata. Use this tool to discover journey IDs before calling getOrchestrateJourney or to browse journey lifecycle status. USE FOR: Listing Orchestrate journeys and discovering journey IDs. EXAMPLES: - List all orchestrate journeys - Show active orchestrate journeys - Show scheduled orchestrate journeys - What orchestrate journeys are paused? - List orchestrate journey campaigns for this subscription NOT FOR: Reading full configuration, the step graph, or performance metrics for one journey when you already have journeyId. WORKFLOW: Use this tool to discover journey IDs, then call getOrchestrateJourney for journey configuration and metadata (audience, goal, scheduling, step count). Use status when it narrows the list. There is no name filter parameter: when the user gave a journey name (not an id), resolve journeyId from list results (filter by appId when known). If two or more journeys could match, list candidates (id, name, status) and ask the user to pick before set or write tools; never default to the first result. Large result sets use limit and offset (see parameter descriptions). RETURNS: - Journey identifiers and names - status (UI lifecycle label; scheduled vs active follows the same start-date rule as the Orchestrate UI) - Lifecycle timestamps and primary appId
listPagesFeaturesAndEvents
ChatGPTlistPagesFeaturesAndEvents is a tool to find, search, look up, or list pages, features, or track events by name and return their entity IDs. These entities are collectively called "countables" - the tagged elements and custom events that Pendo tracks in your application. Use the type parameter to select which kind to list. This is the entity lookup tool to use before single-page, single-feature, or single-track-event usage analytics when the user provides a name instead of an ID. Relevant analytics questions include page views, feature clicks, event counts, unique visitor or "people" counts, unique account counts, time on page, frustration clicks, and other entity usage metrics. The trackEvent type corresponds to what other tools call trackType or TrackType. Supports search via the search param with a searchType selector: "semantic" for natural-language queries ranked by meaning, "fuzzy" for keyword matching on names and descriptions, or "substring" for case-insensitive containment match on name. Both search and searchType are required together. For features, pageId restricts discovery to features associated with one known page. Offset is ignored when search is used; use limit to control result count. USE FOR: Resolving a named page, feature, or track event to its ID before calling entityUsage; listing features associated with a page; listing or browsing countables by name; auditing what is tagged in an app; semantic, fuzzy, or substring search for countable entities. EXAMPLES: - List all pages - Show me features for this app - Which features are associated with page X? - List track events matching 'checkout' - Find pages with 'dashboard' in the name - What track events are defined? - Find features related to user onboarding - Search for pages about checkout flow - Find the ID for 'Page X' before checking how many people viewed it NOT FOR: Listing guides. Listing product areas. Usage analytics, click counts, visitor counts, or activity rankings. WORKFLOW: For analytics about one named entity, search here first. Prefer searchType='substring' with the entity name exactly as the user supplied it; if that finds no match, retry with searchType='fuzzy' or 'semantic'. Then pass the matching ID to entityUsage. Do not conclude that the entity does not exist merely because it was absent from an aggregateEntityUsage ranking, which returns only a limited set of ranked entities. RETURNS: - Summary info for each matching entity: ID, name, description, and eventPropertyNames (custom property names attached to the countable). Pages also include URL rules and exclude rules. Features include pageId and elementPathRules (CSS selector rules identifying the tagged UI element). - When search is used: results include a relevance score
listProductAreas
ChatGPTReturns all product areas for a subscription - their IDs, names, and descriptions. Supports optional fuzzy search and pagination. USE FOR: Enumerating all product areas, or finding a productAreaId to pass to other tools that require one. Use this when the user asks about available product areas or when you need to present them a list to choose from. EXAMPLES: - What product areas do we have? - List all product areas for this subscription - What product area should I use for onboarding? - find the matching name and get its ID - Show me all available product areas NOT FOR: Querying activity or engagement metrics within a product area. RETURNS: - Array of product areas with: id, name, description
listSurveys
ChatGPTList Surveys, optionally filtering by Survey type, displayed status, application, or product area. USE FOR: Discovering Survey IDs and metadata before requesting Survey responses or scores. EXAMPLES: - List all Surveys - List public NPS Surveys - Which Surveys are scheduled? - Show Surveys for app 123 - Show Surveys in product area 456 RETURNS: - totalCount: total matching Surveys before pagination - rows: ID, name, Survey type, status, target segment, app IDs, product area IDs, and useful metadata FILTERING OPTIONS: - surveyType: NET_PROMOTER_SCORE, PRODUCT_MARKET_FIT, CUSTOMER_SATISFACTION, USER_EXPERIENCE_LITE - status: public, staged, scheduled, draft, _pendingReview_, disabled - appId: Surveys available in one accessible application - productAreaId: Surveys associated with one product area
listThemes
ChatGPTReturns a list of themes for a subscription. Themes define the visual styling applied to guides and other in-app content. Supports optional filtering by application and fuzzy search. USE FOR: Listing available themes, finding a theme by name, or getting a theme ID to reference in other tools. Use when the user asks about available themes or visual styles for their guides. EXAMPLES: - What themes do we have? - List all themes for this subscription - Show me themes for app 12345 - Find a theme named 'Dark Mode' NOT FOR: Modifying or creating themes. Viewing guide content or guide metrics. RETURNS: - Array of themes with: id, name, appId, tags, archive status, buildingBlocks (visual styling properties), cssUrl (supplemental CSS file URL if present)
listTrackedIssues
ChatGPTReturns tracked (curated) issue definitions and their associated conversation and event IDs for a given AI agent and time window. Tracked issues are user-defined error or failure categories; conversations are attributed to them by LLM classification. USE FOR: Listing all tracked issues defined for an agent and discovering which conversations belong to each. The returned conversationIds and eventIds can be used to scope a detailed analysis of a specific tracked issue. EXAMPLES: - What tracked issues are defined for my agent? - Which conversations belong to the 'incorrect answer' tracked issue? - Show me the tracked issues for my agent over the last 30 days. NOT FOR: Detected (auto-clustered) issues or aggregate volume metrics; this tool returns only user-defined tracked issues. RETURNS: - Per tracked issue: id, name, description, severity, status, summary, numConversations, conversationIds, eventIds. LARGE DATASETS: If this tool returns too much data or times out for a given date range, do NOT simply narrow the overall date range - that silently discards data outside the narrowed window. Instead, split the request into sequential non-overlapping sub-windows (e.g., for 30 days: three ~10-day windows such as days 1-10, 11-20, 21-30). Call the tool once per sub-window, then merge results by summing conversation counts across windows. This preserves the full dataset. The maximum time range for this tool is 90 days.
listTrackedUseCases
ChatGPTReturns tracked (curated) use case definitions and their associated conversation and event IDs for a given AI agent and time window. Tracked use cases are user-defined categories; conversations are attributed to them by LLM classification. USE FOR: Listing all tracked use cases defined for an agent and discovering which conversations belong to each. Returns conversationIds and eventIds that identify the conversations attributed to each tracked use case for further analysis. EXAMPLES: - What tracked use cases are defined for my agent? - Which conversations belong to the 'billing support' tracked use case? - Show me the tracked use cases for my agent over the last 30 days. NOT FOR: Unsupervised clustering of conversations into emergent topics, or aggregate volume metrics - this tool only lists predefined tracked use cases and the conversations attributed to them. RETURNS: - Per tracked use case: id, name, summary, numConversations, conversationIds, eventIds. The maximum time range for this tool is 90 days.
listUseCases
ChatGPTGet AI agent conversation clustering analysis with comprehensive metrics. Analyzes conversations and prompts, grouping them by semantic topics/use cases. EXAMPLES: - What use cases has my AI agent been used for in the last 30 days? - What are the main topics users are asking my AI agent about? - Show me prompt clusters for my chat agent over the past 2 weeks. - Cluster recent conversations for my agent to find common themes. RETURNS: - Per-cluster metrics: clusterName, clusterSummary, numConversations, numPrompts, numVisitors, numAccounts, numRagePrompts, numRagePromptsOverNumPrompts, retentionRate, retainedVisitors, totalVisitors, visitorIds, accountIds, conversationIds, and ragePromptConversationIds. The maximum time range for this tool is 90 days.
listVisitors
ChatGPTList the visitors that match a segment and get a summary of the cohort. Returns {summary, rows}: summary has numVisitors and numAccounts (the true segment totals, independent of limit); rows is the list of matched visitors with visitorId and any requested metadata fields, capped by limit. Rows can instead be grouped at scale by one current visitor or account metadata field with groupByMetadata; grouped rows contain metadataValue, numVisitors, and numAccounts. The cohort is defined by a segmentPipeline - either a saved Pendo segment ID or the pipeline returned by buildPendoSegment. To find visitors by metadata or activity (e.g. a visitor by email, or visitors with a given role), call buildPendoSegment first and pass its <pipeline> output verbatim; never pass segment rules or a definition as segmentPipeline. USE FOR: Listing the members of a segment/cohort, getting its visitor and account totals, or calculating a current-metadata distribution across the full cohort. EXAMPLES: - List the visitors in segment X - Who are the visitors in this cohort? - How many visitors and accounts are in this segment? - Show me visitors in segment X with their email and role RETURNS: - summary: numVisitors, numAccounts (segment totals, independent of limit) - rows: visitorId plus requested fields in a metadata object keyed by metadata path (for example, "metadata.auto.lastvisit"), capped by limit; each row also includes a name (the configured visitor display name) when the visitorDisplayName setting is set - groupByMetadata rows: metadataValue, numVisitors, and numAccounts, sorted by numVisitors descending and capped by limit; missing or empty values are grouped as "(none)"
list_ai_agent_issues
ChatGPTLists detected issues in AI agent conversations with instance counts and conversation counts. Returns a table of issue summary, instance count, and conversation count per issue. It also returns visitorIds and accountIds who experienced the issue. USE FOR: Finding what problems or issues users encountered when using AI agents (e.g., incorrect answers, refusals, errors). Use when the user asks about common issues, problems, or failures with a specific agent. EXAMPLES: - What are the common issues my users are encountering using my ABC agent in the last 30 days? - What problems have users been encountering when using Acme agent in my Acme application lately? - Have we seen reduced occurrences of issues with incorrect answers in our fooBar agent since last month? - What models are most often used when users face problems with the chat agent in ScramCorp app? NOT FOR: Use list_use_cases for topic/cluster analysis of conversations. Use list_ai_agents to get agent IDs and names first when the user has not specified an agent. RETURNS: - Table of issues: summary, instance count, conversation count, agentId, appId, visitorIds, and accountIds. - Sorted by conversation count descending. Limited to 500 rows; narrow by date range if needed. The maximum time range for this tool is 90 days. PERFORMANCE: This is a slow-running tool.
list_ai_agents
ChatGPTLists all AI agents that the user has access to. AI agents are conversational assistants that can be deployed on specific pages or app-wide. AI agents have the ability to collect conversations, cluster prompts by topics/use cases, and calculate metrics like conversation counts and rage prompt detection. This tool returns agent ids and names for usage with other related agent tools. PERFORMANCE: This is a fast-running tool.
list_all_applications
ChatGPTPendo data is split into subscriptions, which share a set of visitors and accounts. Each subscription is split into separate applications. This call returns a list of all the names and ids of all the subscriptions this user has access to, along with the names and ids of all of the applications in that subscription. Most tools for this mcp require at least a subscription id; many also require an application id. Application ids are not unique across different subscriptions. PERFORMANCE: This is a fast-running tool.
list_product_areas
ChatGPTReturns all product areas for a subscription — their IDs, names, and descriptions. No search query required. USE FOR: Enumerating all product areas or finding a productAreaId to pass to productAreaMemberActivity or other tools that require a productAreaId. Use this when the user asks about available product areas or when you need to present them a list to choose from. EXAMPLES: - What product areas do we have? - List all product areas for this subscription - What product area should I use for onboarding? → call list_product_areas to find the matching name and get its ID - Show me all available product areas NOT FOR: Querying activity or engagement metrics within a product area — use productAreaMemberActivity instead. RETURNS: - Array of all product areas with: id, name, description - All product areas are returned in a single call — no pagination needed PERFORMANCE: This is a fast-running tool.
list_spaces
ChatGPTLists the Pendo Spaces the current user can access in this subscription. A Pendo Space is a collaborative canvas of product artifacts (pages, features, guides, notes, etc.) that a team curates together; think of it as a shared workspace or board inside Pendo. Returns JSON from the Spaces service (opaque shape — field names depend on the Spaces API response). Use this to discover a space id before calling get_agent_context with resource_type "space" and that id as resource_id. PERFORMANCE: This is a fast-running tool.
list_use_cases
ChatGPTUse case: Get AI agent conversation clustering analysis with comprehensive metrics. Analyzes conversations and prompts, grouping them by semantic topics/use cases. Requires: agentId which can be obtained using the list_ai_agents tool. Date range is required. Usage note: You should generally get the user to specify how many days back they want to analyze as well as for which agent. Returns: Metrics per cluster: conversation counts, visitor engagement, account usage, retention rates, rage prompt detection, and lists of visitorIds and accountIds per use case. The maximum time range for this tool is 90 days. PERFORMANCE: This is a fast-running tool.
npsScore
ChatGPTReturns NPS (Net Promoter Score) metrics for NPS surveys, including the overall NPS score (-100 to +100), average rating, and response distribution across promoters (9-10), passives (7-8), and detractors (0-6). USE FOR: Answering questions about NPS scores, NPS trends, survey response breakdowns, and promoter/detractor analysis. Supports filtering by app. If no guideId is provided, automatically discovers NPS surveys. EXAMPLES: - What is our NPS score? - What is the NPS score for app X? - Show me NPS trends over the last 30 days - What percentage of respondents are detractors? - How many promoters vs detractors did we get this month? - What is the NPS score for a specific survey? NOT FOR: General guide performance metrics like completion rates or dismissal rates — use guideMetrics for those. RETURNS: - NPS score (-100 to +100), calculated as (% promoters - % detractors) * 100 - Average rating (0-10 scale) - Response counts: numPromoters, numNeutral, numDetractors, numResponses - Per-score distribution: responseCounts object with keys '0' through '10' (count of responses for each score value) - Guide info: guideName, guideId, pollQuestion, pollId, appIds - Individual NPS responses with visitorId, npsScore, npsReason, accountId, browserTime (when includeResponses is 'promoters', 'detractors', or 'unsorted', or visitorId is provided). Requires guideId. The maximum time range for this tool is 93 days. PERFORMANCE: This is a fast-running tool.
objectAnalyticsActiveCount
ChatGPTCount how many unique business OBJECTS (e.g. dashboards, venues, documents, orders) were active over a date range, where an object is identified by one event property. Returns a single scalar count (distinct object_id) for the chosen property within the window. Use this for questions about a business object - including when a page or feature shares the same name (e.g. count 'dashboards' as the object, not the 'Dashboards' page). An object is a custom event property designated as an analyzable entity, distinct from pages, features, and track events. The aggregation is built by the Pendo analytics gateway, not in this service. USE FOR: Scalar 'how many unique <objects> were active' questions where <object> is a business object identified by a single event/metadata property over one time window - even if a page or feature shares the object's name. When the object name is ambiguous (could be a page/feature) or you don't know its event property, ground it with listCustomObjects first. EXAMPLES: - How many unique venues were active in the last 30 days? - Count distinct documents touched between 2025-01-01 and 2025-01-31 - How many unique order IDs were active last week? - How many gold-tier dashboards were active last month? NOT FOR: Ranking objects (e.g. 'which dashboards had the most visitors') - use objectAnalyticsBreakdown. Per-page, per-feature, or per-track-event usage - use entityUsage. Per-visitor or per-account app usage - use appUsage. Time series, group-by, or comparisons are not supported here. RETURNS: - activeCount: the number of distinct objects active in the window - meta.dateRange: resolved startDate and endDate (YYYY-MM-DD) - meta.objectProperty: the field and kind the count was computed over - meta.promotedAt (epoch ms) and meta.effectiveDateRange: present only when the requested range begins before the object was promoted; the window is floored to the promotion time (a range entirely before promotion returns activeCount 0) FILTERING OPTIONS: - metadataFilters: slice the objects by the object's OWN declared metadata (e.g. only gold-tier dashboards) - confirm field names via resolveBusinessObject/listBusinessObjectMetadata first
objectAnalyticsBreakdown
ChatGPTAnalyze the individual business OBJECTS (e.g. dashboards, venues, documents, orders) of one kind over a date range, where an object is identified by one event property. Use this for questions about a business object - including when a page or feature shares the same name (e.g. treat 'dashboards' as objects, not the 'Dashboards' page). An object is a custom event property designated as an analyzable entity, distinct from pages, features, and track events. Two modes, selected by the 'measures' argument: (1) RANKING - request EXACTLY ONE additive measure: 'uniqueVisitors' (default), 'totalTime', 'numAccounts', 'uTurns', 'rageClicks', 'deadClicks', or 'errorClicks'. Returns one row per object (objectId, objectName, <measure>) ranked by that measure, top-N by limit - 'which <objects> had the most visitors / most rage clicks / most total time', optionally scoped by a segment. (2) SUMMARY - request a RATIO measure ('avgObjectsPerVisitor', 'avgTimePerObject', 'avgEventsPerObject', 'avgDaysActivePerObject', 'avgDaysActive', 'avgAccountsPerObject', 'avgObjectsPerAccount', 'avgParentAccountsPerObject', 'avgObjectsPerParentAccount', 'avgVisitorsPerAccount'), OR request more than one measure at once. Returns one subscription-wide scalar per measure (the object-details 'Manage metrics' tiles) - aggregates across ALL objects of this kind, NOT per-object rows, so sortBy/limit/compareToDateRange do not apply. Ranking by more than one measure at once is not supported. RANKING can be split further by a metadata field with 'compareBy' (the UI's 'Compare by' feature) - e.g. 'break down order engagement by region' - returning one row per (object, compareBy value) pair instead of one row per object. The aggregation is built by the Pendo analytics gateway, not in this service. USE FOR: Ranking the individual objects of one business-object kind by a single additive measure - distinct visitors (uniqueVisitors), total time (totalTime), distinct accounts (numAccounts), or quality-of-experience clicks (uTurns/rageClicks/deadClicks/errorClicks) - e.g. 'which dashboards had the most visitors', 'busiest venues by total time', 'documents with the most rage clicks', even if a page or feature shares the object's name. Also the home for class-level SUMMARY questions about a business-object kind - the ratio tiles on the object-details 'Manage metrics' view (average time per object, average events or active-days per object, average objects-per-account and accounts-per-object ratios, average visitors per account), and any request asking for several measures at once. Also for splitting a ranking by a visitor/account/parentAccount/object metadata field via 'compareBy', e.g. 'break down orders by region' or 'compare dashboard engagement by account tier'. When the object name is ambiguous (could be a page/feature) or you don't know its event property, ground it with listCustomObjects first; when compareBy is a business-object metadata field ('object' kind), confirm its name with listBusinessObjectMetadata first. EXAMPLES: - Which dashboards had the most visitors last month? - Which venues had the most unique visitors in the last 30 days? - Top 10 documents by distinct visitors between 2025-01-01 and 2025-01-31 - Least-visited order IDs over the last week - Which dashboards had the most total time spent last month? - Which venues were used by the most accounts in the last 30 days? - Which dashboards had the most rage clicks last week? - On average, how many distinct dashboards does each visitor interact with over the last 30 days? - On average, how much time do visitors spend on each dashboard over the last 30 days? - On average, how many dashboards does each account use? - Break down order engagement by region - Compare dashboards by account tier - Which gold-tier dashboards had the most visitors last month? NOT FOR: A single 'how many unique objects' scalar - use objectAnalyticsActiveCount. Per-page, per-feature, or per-track-event usage - use aggregateEntityUsage. Per-visitor or per-account app usage - use appUsage. Page dwell-time or time-on-page - that is pag…
objectAnalyticsTimeSeries
ChatGPTTrack how engagement with a business OBJECT (e.g. dashboards, venues, documents, orders) changed over time, where an object is identified by one event property. Groups the date range into buckets of the requested period (daily/weekly/monthly) and returns one row per bucket. The 'metric' param chooses what each bucket measures - default avgTimePerObject (average time spent per object = "engagement"), plus event/visitor/object volume (numEvents, numVisitors, numSubjects, totalTime), account reach (numAccounts, avgObjectsPerAccount, avgAccountsPerObject, avgVisitorsPerAccount, and parent-account variants), per-object engagement (avgEventsPerObject, avgDaysActivePerObject, avgDaysActive), and quality-of-experience clicks (uTurns, rageClicks, deadClicks, errorClicks); see the 'metric' parameter for the full list. Use this for questions about a business object - including when a page or feature shares the same name (e.g. trend 'dashboards' as the object, not the 'Dashboards' page). An object is a custom event property designated as an analyzable entity, distinct from pages, features, and track events. The aggregation is built by the Pendo analytics gateway, not in this service. USE FOR: Trend questions about a business object over a window - e.g. 'how has weekly engagement with dashboards changed over the last 3 months?' (engagement -> avgTimePerObject, the default), 'event volume per venue by month' (-> numEvents), 'daily distinct visitors on documents over the last 30 days' (-> numVisitors), 'active order IDs per week' (-> numSubjects), 'total time on dashboards by week' (-> totalTime), 'monthly accounts active on venues' (-> numAccounts), 'weekly rage clicks on dashboards' (-> rageClicks) - even if a page or feature shares the object's name. When the object name is ambiguous (could be a page/feature) or you don't know its event property, ground it with listCustomObjects first. EXAMPLES: - How has weekly engagement with dashboards changed over the last 3 months? - Monthly event volume per venue over the last year - Daily distinct visitors engaging documents over the last 30 days - Active order IDs per week over the last quarter - Total time spent on dashboards by week over the last 3 months - How many accounts were active on venues each month last year? - Weekly rage clicks on dashboards over the last quarter - How has weekly engagement with gold-tier dashboards changed over the last 3 months? NOT FOR: A single scalar for one window - use objectAnalyticsActiveCount. Ranking individual objects - use objectAnalyticsBreakdown. Per-page, per-feature, or per-track-event usage over time - use entityUsageTimeSeries. Whole-app usage over time - use appUsageTimeSeries. RETURNS: - meta.dateRange: resolved startDate and endDate (YYYY-MM-DD) - meta.objectProperty: the field and kind the series was computed over - period: echoed bucket size (daily|weekly|monthly) - metrics: the metric name returned per bucket (defaults to avgTimePerObject; see the 'metric' parameter for the full set) - rows: one entry per time bucket with bucket (YYYY-MM-DD or YYYY-MM), startTime (timestamp object {iso, display}), and the metric value; buckets zero-fill empty periods - meta.promotedAt (epoch ms) and meta.effectiveDateRange: present only when the requested range begins before the object was promoted; the window is floored to the promotion time (a range entirely before promotion returns no buckets) FILTERING OPTIONS: - metadataFilters: slice the objects by the object's OWN declared metadata (e.g. only gold-tier dashboards) - confirm field names via resolveBusinessObject/listBusinessObjectMetadata first
objectEventBreakdown
ChatGPTRank or trend the events/actions on one kind of business OBJECT (e.g. dashboards, venues, documents, orders) over a date range - the event types (pages, features, track events) fired while the object's identifying property is present. Modes: (1) default - rank those events by count for 'what are the most common actions/events on a <object>'; (2) set sortBy='numSubjects' to rank events by how many distinct <objects> they occurred on instead of raw event count; (3) set trend='up' or 'down' - rank which events are TRENDING up or down on the object, comparing the requested window against the equal-length window immediately before it (rows carry currentPeriodEvents, previousPeriodEvents, pctChange, ranked by pctChange). This is THE tool for 'which events are trending up/down across my <objects>' - it scopes to the object and computes the period-over-period change for you; do not hand-compute a trend by pulling two windows of unscoped track events from another tool. An object is a custom event property designated as an analyzable entity (distinct from pages, features, and track events), including when a page or feature shares the object's name. Returns one row per event type. The aggregation is built by the Pendo analytics gateway, not in this service. USE FOR: The events/actions on a business object - either the most common ('the most common actions taken on dashboards this month', 'top interactions on a document') or, with trend='up'/'down', which are TRENDING ('which events are trending up across dashboards', 'what actions on venues are trending down vs the previous period'). When the object name is ambiguous (could be a page/feature) or you don't know its event property, ground it with listCustomObjects first. EXAMPLES: - What are the most common actions taken on dashboards this month? - Top 10 event types on venues in the last 30 days - Which actions were performed most on documents between 2025-01-01 and 2025-01-31? - Which events are trending up across dashboards in the last 30 days? - What actions on venues are trending down compared with the previous period? - What are the most common actions taken on gold-tier dashboards this month? - Which pages are used across the most guides in the last 7 days? NOT FOR: How many unique objects were active - use objectAnalyticsActiveCount. Ranking the objects themselves by visitors (which dashboards had the most visitors) or per-object averages/time - use objectAnalyticsBreakdown. Per-page, per-feature, or per-track-event usage NOT scoped to a business object - use aggregateEntityUsage. Do NOT answer 'which events are trending on <objects>' by comparing two windows of aggregateEntityUsage/entityUsage yourself - that counts ALL events unscoped to the object; set trend on this tool instead. WORKFLOW: Ranking measures: events can be ranked by event count (sortBy='numEvents', default) or by how many distinct <objects> they occurred on (sortBy='numSubjects'). Pick the one that matches the question; if it is genuinely ambiguous, default to event count. In replies, NEVER show the user the field names 'numEvents' or 'numSubjects' or the word 'subjects'. State what was ranked in plain words using the object's name as the user said it, e.g. 'top events by number of events' or 'top events by number of guide objects they occurred on'. To offer the alternative, ask in those terms, e.g. 'Would you like to see the top events by number of guide objects instead?'. RETURNS: - meta.dateRange: resolved startDate and endDate (YYYY-MM-DD) - meta.objectProperty: the field and kind analyzed - meta.trend: the trending direction, when trend mode is requested - meta.compareToDateRange: the previous equal-length window (startDate, endDate) the trend compares against, when trend mode is requested - rows (default): one per event type performed on the object, each with eventId, eventName, eventKind (page/feature/track type) and the measure it is ranked by - numEvents (default) or numSubjects (distinct objects the event occurred on) per sortBy - rows (trend mode): one per event type, each with eventId, eventName,…
productAreaMemberActivity
ChatGPTReturn all pages, features, or track types belonging to a product area, including those with zero activity in the date range. Use this tool when you need to identify unused or low-engagement entities within a product area — for example, "which features in the Onboarding product area have had no usage this quarter?" Unlike activityQuery, which only surfaces entities that have generated events, this tool fetches all members of the product area and left-joins activity data so that zero-event entities appear with numEvents: 0. Supports optional segmentId filtering: when provided, activity metrics reflect only visitors in the segment, but all product area members are still returned (zero-activity rows remain for entities with no segment activity). WHEN TO USE THIS TOOL vs. activityQuery: - Use this tool when "not in the results" must mean "zero usage", not "not in the top N" - Use activityQuery when you want ranked/sorted activity across all entities regardless of product area membership USE FOR: Listing all members of a product area with their activity metrics, including entities with zero events. EXAMPLES: - Which features in the Onboarding product area have zero usage this quarter? → entityType='feature', productAreaId='<id>', sort=['+numEvents'], dateRange={range:'custom', startDate:'2025-01-01', endDate:'2025-03-31'} - What pages in the Analytics product area should we consider sunsetting? → entityType='page', productAreaId='<id>', sort=['+numEvents'], limit=50, dateRange={range:'relative', lastNDays:90} - Which pages in product area X have zero activity from visitors in segment Y? → entityType='page', productAreaId='<id>', segmentId='<id>', sort=['+numEvents'], dateRange={range:'relative', lastNDays:30} NOT FOR: ranked activity across all entity types regardless of product area membership; use activityQuery instead. RETURNS: - All members of the product area for the given entity type - Each row includes: entity ID, name, description, numEvents, numMinutes, uniqueVisitorCount, uniqueAccountCount, daysActive, avgMinutesPerVisitor, avgDaysActivePerVisitor - Entities with no activity in the date range appear with all metrics set to 0 - When segmentId is provided, metrics reflect only activity from visitors in that segment; zero-activity rows still appear for entities with no segment activity SORT OPTIONS: - numEvents - total event count (default: ascending, to surface unused entities first) - numMinutes, uniqueVisitorCount, uniqueAccountCount, daysActive The maximum time range for this tool is 367 days. PERFORMANCE: This is a fast-running tool.
productEngagementScore
ChatGPTA tool designed for running PES (product engagement score) queries. For any score fields that aren't required or provided, default saved PES configuration options are used. USE FOR: Analyzing the PES, which is made up of scores from feature adoption, stickiness, and growth. EXAMPLES: - What is the PES for this feature? - What is adoption score for a specific feature, page, and track event? - What is the stickiness score for accounts, weekly over monthly? (This may expressed as WAA over MAA) - What is the stickiness score for visitors, daily over monthly, excluding weekends? (This may expressed as DAU over MAU) - What is the growth score for accounts? RETURNS: - PES score and component scores (adoption, stickiness, growth) - Individual component scores (adoption, stickiness, growth) The maximum time range for this tool is 180 days. PERFORMANCE: This is a fast-running tool.
queryFunnel
ChatGPTRun a funnel and return conversion and timing metrics for an ordered sequence of 2-3 steps. By default the unit of analysis is the unique VISITOR: each visitor counts toward step N only if they completed every prior step in order. Set funnelBy='object' to instead key the funnel on a business OBJECT (e.g. dashboards, venues, orders) identified by an event property - then each distinct object counts toward a step, answering how objects move through the sequence: 'of the objects that reached step A, how many went on to reach step B?', 'how long do the objects take to get from step A to step B?', or 'where do the objects drop off?'. The steps are ALWAYS phrased as visitor actions ('someone viewed a page', 'someone clicked a feature') - that phrasing is NOT a signal for visitor mode; pick the unit from what the question COUNTS, so any question about 'our <objects>' progressing, completing, or dropping off is funnelBy='object'. By default each entity is counted at most once (analyzeBy='uniqueVisitors'); set analyzeBy='totalAttempts' to instead count every pass through the funnel, where a single entity can complete it multiple times (each attempt must finish within funnelTimeout minutes). Use ONLY for sequence questions where ordering matters - one thing happening and then another. Do NOT use for unordered set-overlap questions like 'how many visitors did both X and Y?' - those are answered by building a segment instead. This is a slow-running tool. It scans raw events, so expect longer latency than the metric tools. USE FOR: Ordered funnel questions: 'of visitors who viewed page A, how many went on to click feature B?', 'of visitors who saw guide G, how many reached page B?', drop-off analysis, time-to-completion between steps. With funnelBy='object': object-keyed funnels like 'of the dashboards where event A occurred, how many went on to have event B occur?', 'how long do our dashboards take to complete the funnel from A to B?', or 'where do our venues drop off between A -> B -> C?'. EXAMPLES: - Show me the funnel from page A to feature B - What is the drop-off between step 1 and step 2? - How long does it take visitors to go from page X to track event Y? - Funnel of A -> B -> C with conversion rates - Show me the drop-off from seeing guide G to page B - Of visitors who dismissed guide G, how many still clicked feature F? - Of dashboards where someone viewed page A, how many had someone click feature B? (funnelBy=object) - How long do our dashboards take to complete the funnel from page A to feature B? (funnelBy=object) - Where do our venues drop off between steps A -> B -> C? (funnelBy=object) RETURNS: - meta.dateRange: resolved startDate and endDate for the query window - meta.promotedAt (object mode, epoch ms) and meta.effectiveDateRange: present only when funnelBy='object' and the range begins before the object was promoted; events before promotion are excluded from the funnel - meta.analyzeBy: the counting mode used (uniqueVisitors or totalAttempts); meta.funnelTimeout (minutes) is echoed only in totalAttempts mode - summary.totalVisitorsEnteringStep1: visitors who completed step 1 (visitor mode); totalObjectsEnteringStep1 in object mode; totalAttemptsEnteringStep1 when analyzeBy='totalAttempts' - summary.visitorsCompletingFunnel: visitors who completed all steps (visitor mode); objectsCompletingFunnel in object mode; attemptsCompletingFunnel when analyzeBy='totalAttempts' - summary.overallConversion: fraction (0-1) who completed the funnel - summary.steps: per-step array of index, kind, id, visitors (objects in object mode; attempts when analyzeBy='totalAttempts'), conversionFromStart, dropOffFromPrevious, plus eventType on guide steps - summary.steps[].averageTimeToNextStep / medianTimeToNextStep: elapsed time from this step to the next one, as duration objects {seconds, display}; null on the last step - summary.steps[].averageTimeFromPreviousStep / medianTimeFromPreviousStep: elapsed time from the previous step to this one; null on the first step (to-next of a step equals from-previous of the following step) - the ste…
resolveBusinessObject
ChatGPTCheck whether metadata or property terms mentioned in a question (e.g. 'size', 'region', 'category') actually belong to one already-identified designated business OBJECT (see listCustomObjects), by matching them against that object's own declared metadata schema (the fields customers send on metadata events for that object, e.g. 'type', 'isShared' - the same schema accountMetadataSchema/visitorMetadataSchema expose for accounts/visitors). Returns status 'confirmed' when at least one term matches, or 'noMatch' when none do - including when the object has no declared metadata schema at all. USE FOR: Before calling objectAnalyticsActiveCount, objectAnalyticsBreakdown, or objectEventBreakdown with metadata terms drawn from the user's question, once you have a specific candidate object in mind (its name is unambiguous, or you already narrowed it down via listCustomObjects) but are not certain those terms are actually part of its schema. EXAMPLES: - The user asked to break down 'reports' by 'type' - confirm 'type' is part of the reportId object's schema before querying - Does the 'venue' object have a 'region' field? NOT FOR: Figuring out WHICH object a question is about when more than one could plausibly apply - use listCustomObjects to see what's available and pick (or ask the user to pick) a candidate first, then call this tool to confirm its terms. Simply listing the objects that exist - use listCustomObjects directly. Ranking or counting objects, or computing any metric - use objectAnalyticsActiveCount, objectAnalyticsBreakdown, or objectEventBreakdown once the object and terms are confirmed. RETURNS: - status: 'confirmed' (at least one term matched) or 'noMatch' (none did). - field, kind, group/metadataKind (historical objects only): the object identifier that was checked, echoed back exactly as it should be passed to objectAnalyticsActiveCount, objectAnalyticsBreakdown, or objectEventBreakdown. - matchedTerms: which input terms matched the object's declared metadata schema (exact, case-insensitive). - metadataSchema: type/cardinality/sample values for each matched term (keyed by its normalized field name), when the customer has sent metadata events for it - use these to know its value type and possible values when filtering or breaking down by it. - unmatchedTerms: input terms that matched nothing. Even when status is 'confirmed', a non-empty unmatchedTerms means part of the question wasn't understood - do not silently drop it; surface it or ask the user what they meant by it. - suggestions: for each unmatched term that has one, declared field names it's a substring of or contains (e.g. 'type' suggesting 'reportType') - keyed by the original term. Offer these to the user as a correction ('did you mean X?') rather than guessing silently or giving up. Absent when no unmatched term has a substring match - that does not rule out a misspelling; call listBusinessObjectMetadata to see every declared field and check for one yourself.
resolveObjectInstance
ChatGPTResolve a business OBJECT instance by name: given ONE already-identified designated object type (e.g. the dashboardId object) and a name or partial name, return the matching concrete object instances as {id, name} candidates. Matches case-insensitively as a substring against each instance's id and its configured display name. An object is a custom event property designated as an analyzable entity, distinct from pages, features, and track events. The match is built by the Pendo analytics gateway, not in this service. USE FOR: Turning a name or phrase that refers to a specific object instance (e.g. 'the Q3 revenue dashboard', 'the acme order') into its concrete object id(s), before scoping an objectAnalytics* query to that instance. Once listCustomObjects has told you WHICH object type the question is about, use this to resolve the named instance within it. EXAMPLES: - Which dashboard instance does 'Q3 revenue' refer to? - Find the order whose name contains 'acme' - Resolve the venue called 'Madison Square' to its id NOT FOR: Listing the object TYPES that exist - use listCustomObjects. Confirming a metadata FIELD belongs to an object type - use resolveBusinessObject. Counting, ranking, or any metric over objects - use objectAnalyticsActiveCount, objectAnalyticsBreakdown, or objectEventBreakdown. Finding pages, features, guides, or accounts by name - use searchEntities or listAccounts. RETURNS: - matches: up to limit {id, name} candidates whose id or configured display name contains the query (case-insensitive). Empty when nothing matches - not an error. - meta.objectProperty: the field and kind the match was computed over. - meta.query and meta.limit: the normalized query and the applied cap.
searchEntities
ChatGPTLook up the names and descriptions of product entities, such as: accounts, pages, features, track types, guides, starred replays (SessionRecording), saved clips, playlists or product areas. Guide results include a permalink URL that can launch the guide directly in the application. Saved clip and starred Replay results include a permalink URL that links directly to the saved clip in Session Replay. Playlist results include a permalink URL that links directly to the playlist in Session Replay. When users ask "How do I..." or "Help me with..." questions, search for Guide entities to find relevant step-by-step walkthroughs. Useful for: finding relevant entities in the customer's product for follow-up analysis with other tools, learning more about specific entities, or answering how-to questions by finding relevant guides with direct launch links. Uses semantic search to find entities by conceptual meaning and relevance to natural language queries, with fuzzy search for broad matching. Tool may be used in one of three ways: 1. Get specific entities: itemIds and exactly one itemType are specified; search_fallback and search are not allowed in this case. 2. Search for relevant entities: search_fallback AND search are BOTH specified, along with one or more itemType; itemIds is not allowed in this case. 3. Get starred entities: starredItemTypes lists one or more entity types and matching itemType are specified; returns only entities of those types starred by the current user. ALWAYS combine multiple starred entity types into a single call (e.g., starred replays AND starred guides in one call, not separate calls). IMPORTANT: The search parameter should contain only the core query terms (e.g., "onboarding features", "Bridgeway Logistics"), not instructions or meta-commentary. EXAMPLES: - What features should I look at to track onboarding success? - What parts of my app provide administrator functions? - What communications do we have to end users advertising our annual conference? - What instrumentation events do we collect for end-user performance? - Which pages should I measure user activity on to see how much time users are spending in setup? - What accounts contain 'acme' in their name? - Do I have any accounts involved in steel manufacturing? - How do I set up single sign-on? - Help me configure user permissions in my app - Show me saved clips about checkout errors - Show me all my starred items RETURNS: - Entity ID, name, description, and search method for each match - For Guide entities: a permalink URL that launches the guide in-app (when the guide is public and has audience set to everyone) - For SessionRecording (Replay) entities: a permalink URL that links to the replay player - For Saved Clip entities: a permalink URL linking directly to the saved clip in Session Replay - For Playlist entities: a permalink URL linking directly to the playlist in Session Replay PERFORMANCE: This is a fast-running tool.
segmentList
ChatGPTList all the segments. The name and the id of each segment is returned, along with the flagName if the segment defines a feature flag. These segments can be used for query build tools. Only publicly shared segments are returned. PERFORMANCE: This is a fast-running tool.
sessionReplayList
ChatGPTGet session replay recordings with filtering by duration, activity percentage, date range, frustration types, and track events. Returns detailed session metadata including frustration events, activity scores, and app information. When referencing a page, feature, or guide in a filter in association with a frustration type, defer to use occurredOn/notOccurredOn facts on frustration type filters over pageIds, featureIds, or guideIds filtering. USE FOR: Finding session replays with specific criteria, analyzing user session quality, identifying high-activity or problematic sessions, scoping replays to specific apps, segments, accounts, features, or guides, filtering for sessions with specific frustration signals, or filtering by track events and their properties EXAMPLES: - Show me recordings that occur on page 1234 - Show me session replays from the last week with high activity - Find session replays longer than 5 minutes - Show me session replays for visitor 1234 - Show me session replays for account acme-corp - Show me session replays for app 5678 - Show me session replays where users interacted with feature abc123 - Show me session replays where users saw guide xyz789 - Show me session replays with rage clicks - Show me session replays where the checkout-completed track event fired RETURNS: - Session replay recordings with their URL and metadata including duration, activity percentage, frustration events, and app details. Limited to 50 replays returned. The maximum time range for this tool is 31 days. PERFORMANCE: This is a fast-running tool. This tool is only available to be called for the following subscriptions: pendo-internal (5668600916475904) Pendo for Pendo Employees (5769426755780608) (Demo) Pendo Experience (6591622502678528) Pendo AI - Internal (6296072733130752) tippy_demo (6284013896335360)
sessionReplaySummarize
ChatGPTRequest an AI-generated summary for a session replay recording. Returns a structured summary with a title and a chronological timeline of key moments, errors, and frustration signals. On a first call the summary job is enqueued and the current status is returned. Each call always attempts to generate a fresh summary; if a job for the same session is already PENDING or RUNNING, the tool polls that job instead of starting a duplicate. Pass a consistent set of session-context fields (recordingSessionId, appId, visitorId, startTime, endTime) for the specific recording so the summary is generated from the correct session. USE FOR: Summarizing a specific session replay to extract key moments, errors, and frustration signals, once the session's identifiers and time range are known. EXAMPLES: - Summarize this session replay for me - What happened during this user's session? - Give me an AI summary of session replay abc123 NOT FOR: Listing or searching session replays. Fetching raw devlog events. RETURNS: - status: PENDING, RUNNING, DONE, or FAILED - jobId: identifier for the summary job (use to poll if status is not DONE) - data: structured summary with a title and a chronological timeline (present when status is DONE). Each timeline entry has a type (keyMoment, error, or frustrationSignal), timestamp, description, and a url linking directly to that moment in the session replay player. - reason: failure reason (present when status is FAILED)
setGuideSegment
ChatGPTChanges the segment (audience) a guide is targeted to. Assigning a segment restricts the guide to visitors in that segment; leaving the segment empty targets all visitors. Before calling this tool, always tell the user the guide's name and the exact segment change (current -> target) and get explicit confirmation. USE FOR: When the user explicitly asks to assign, change, or clear the segment/audience of a specific guide. EXAMPLES: - Target the xxx guide to the yyy segment - Change guide xxx to segment yyy - Show this guide to everyone RETURNS: - A confirmation of the guide and its new segment, or an error describing why the change was rejected.
setGuideState
ChatGPTChanges the state/status of a guide (public, staged, draft, disabled, archived). Setting a guide to 'public' makes it live to end users. Setting a guide to 'archived' hides it from the guide list and is not shown to end users. Before calling this tool, always tell the user the guide's name and the exact state change (current -> target) and get explicit confirmation. USE FOR: When the user explicitly asks to publish, unpublish, disable, stage, draft, or set the state of a specific guide. EXAMPLES: - Publish the xxx guide - Disable guide xxx - Set this guide back to draft RETURNS: - A confirmation of the guide and its new state, or an error describing why the change was rejected.
setOrchestrateJourneyDescription
ChatGPTSets the description on an existing Orchestrate journey header. Only the journey header description changes. Same edit rules as the journey header in the Pendo UI: allowed on any journey status when the caller has journey edit permission (enforced before this tool runs). USE FOR: Updating the header description on an existing Orchestrate journey. EXAMPLES: - Set description on journey xyz to explain the campaign purpose WORKFLOW: 1. Load the journey (getOrchestrateJourney or the journeyId from a createOrchestrateJourneyFromTemplate / createOrchestrateJourneyFromJson response) for journeyId. 2. Call setOrchestrateJourneyDescription with description. 3. Confirm with getOrchestrateJourney. RETURNS: - journeyId: updated journey id - journeyUrl: direct URL to the journey in the Pendo UI - name: journey title after update - description: journey header description after update - status: journey lifecycle label after update
setOrchestrateJourneyGoal
ChatGPTSets or clears the conversion goal on an existing Orchestrate journey. Only the goal fields change. Works on draft and review journeys only. Cannot update goal on active, paused, completed, or disabled journeys. USE FOR: Setting or clearing the conversion goal on an existing draft or review journey. EXAMPLES: - User wants goal 'home page': listPagesFeaturesAndEvents or searchEntities on journey app, one match -> setOrchestrateJourneyGoal with that id - User wants goal 'Settings', search returns Account Settings and App Settings -> ask user which one, then setOrchestrateJourneyGoal with the chosen id only - Clear the conversion goal on journey xyz (itemType noGoal, no itemId) WORKFLOW: 1. Load the journey (getOrchestrateJourney or the journeyId from a createOrchestrateJourneyFromTemplate / createOrchestrateJourneyFromJson response) to get journeyId and appId. 2. For Page, Feature, or TrackType goals, call listPagesFeaturesAndEvents or searchEntities first with the user's phrase (e.g. "home page") and appId scoped to the journey app - do not guess itemId. 3. If exactly one match, use its id. If two or more matches, STOP: list each candidate (id and name) and ask the user which one is the goal - do not call setOrchestrateJourneyGoal until they choose; never default to the first result. If zero matches, tell the user and refine search or ask for a different name. 4. Call setOrchestrateJourneyGoal with itemType and the chosen id. 5. To clear, call with itemType noGoal and omit itemId. RETURNS: - journeyId: updated journey id - journeyUrl: direct URL to the journey in the Pendo UI - status: journey lifecycle label after update
setOrchestrateJourneyName
ChatGPTSets the display name on an existing Orchestrate journey header. Only the journey title changes. Same edit rules as the journey header in the Pendo UI: allowed on any journey status when the caller has journey edit permission (enforced before this tool runs). USE FOR: Renaming an existing Orchestrate journey. EXAMPLES: - Rename journey xyz to Welcome onboarding flow WORKFLOW: 1. Load the journey (getOrchestrateJourney or the journeyId from a createOrchestrateJourneyFromTemplate / createOrchestrateJourneyFromJson response) for journeyId. 2. Call setOrchestrateJourneyName with name. 3. Confirm with getOrchestrateJourney. RETURNS: - journeyId: updated journey id - journeyUrl: direct URL to the journey in the Pendo UI - name: journey title after update - status: journey lifecycle label after update
setOrchestrateJourneySchedule
ChatGPTSets the start date on an existing Orchestrate journey schedule. Only startDate can be changed via MCP. Timezone always comes from the subscription. Start times must land on 15-minute boundaries (for example 2:00, 2:15, 2:30, 2:45). Existing endDate, constraints, and ignoreThrottling are preserved. Cannot update schedule on active, paused, completed, or disabled journeys. USE FOR: Setting the launch start date on an existing Orchestrate journey schedule. EXAMPLES: - Set journey abc123 to start on March 15, 2026 at 9:00 AM subscription time - Schedule journey xyz to start next Monday - User asks for 2:14 PM start -> explain only :00/:15/:30/:45 are valid, propose 2:15 PM, wait for confirmation, then call setOrchestrateJourneySchedule WORKFLOW: 1. Load the journey (getOrchestrateJourney or the journeyId from a createOrchestrateJourneyFromTemplate / createOrchestrateJourneyFromJson response). 2. Resolve startDate to a future instant on a 15-minute boundary in the subscription timezone (:00, :15, :30, :45). 3. If the user gives an off-grid time (for example 2:14 PM), STOP: explain the 15-minute grid, propose the nearest valid slot (2:15 PM or 2:00 PM), and ask the user to confirm before calling setOrchestrateJourneySchedule - do not silently round or retry with a different time. 4. Call setOrchestrateJourneySchedule with journeyId and the confirmed on-grid startDate. 5. Confirm with getOrchestrateJourney. RETURNS: - journeyId: updated journey id - journeyUrl: direct URL to the journey in the Pendo UI - status: journey lifecycle label after update
setOrchestrateJourneySegment
ChatGPTSets journey audience from a saved segment id on an existing Orchestrate journey. Requires segmentId from segmentList - not inline audience JSON. Allowed on draft, review, and paused journeys only (same as Orchestrate UI segment card). Cannot update on active (includes UI scheduled journeys), completed, or disabled journeys. Optional reachInactiveVisitors and retainVisitorsAfterEntry preserve existing journey values when omitted. USE FOR: Setting or changing the saved-segment audience on an existing Orchestrate journey. EXAMPLES: - User wants audience 'power users': segmentList with substring power users, one match -> setOrchestrateJourneySegment with that id - User wants 'Active accounts', segmentList returns Active accounts (sub) and Active accounts (prod) -> ask user which one, then setOrchestrateJourneySegment with the chosen id only - Update journey xyz segment and enable reachInactiveVisitors - Set journey xyz audience to seg-123 and turn on retain visitors after entry (retainVisitorsAfterEntry: true) WORKFLOW: 1. Load the journey (getOrchestrateJourney or the journeyId from a createOrchestrateJourneyFromTemplate / createOrchestrateJourneyFromJson response) to get journeyId. 2. Call segmentList first with substring set to the user's segment name or phrase (e.g. "power users") - do not guess segmentId and do not pass a segment name as segmentId. 3. If exactly one match, use its id. If two or more matches, STOP: list each candidate (id and name) and ask the user which one is the audience segment - do not call setOrchestrateJourneySegment until they choose; never default to the first result. If zero matches, tell the user and refine substring or ask for a different name. 4. Call setOrchestrateJourneySegment with journeyId and the chosen segmentId. Pass reachInactiveVisitors or retainVisitorsAfterEntry only when the user explicitly asked to change them; otherwise omit them. RETURNS: - journeyId: updated journey id - journeyUrl: direct URL to the journey in the Pendo UI - status: journey lifecycle label after update
surveyResponses
ChatGPTGet per-visitor survey responses for a single survey (VOC: CSAT, PMF, UMUX) or NPS guide. limit (default 100, max 500) applies to the pivoted visitor rows. USE FOR: Pulling per-visitor responses for a specific survey or NPS guide - individual answers, response distributions per question, and the most-recent answer per visitor across all of the survey's questions. EXAMPLES: - Show me the per-visitor responses to NPS guide guide-nps-q4 - What did visitors answer on the CSAT survey survey-csat-onboarding? - Pull the response distribution and per-visitor answers for our PMF survey last quarter - Show NPS rating + reason responses for guide guide-nps-h1 from the last 30 days RETURNS: - meta.dateRange: resolved startDate and endDate (YYYY-MM-DD) - summary: {surveyId, surveyName, surveyType, items: [{itemId, question, distribution: [{response, count}]}]}. For free-text items (NPS reason, OpenAnswer) freeText is true and distribution is omitted - every response is unique, so refer to per-visitor rows instead. - rows: per-visitor with visitorId, accountId, browserTime (timestamp object {iso, display}), and one column per itemId (null if the visitor did not answer that item).
surveyScores
ChatGPTGet survey scores over a date range for NPS (Net Promoter Score), CSAT (Customer Satisfaction), PMF (Product-Market Fit), and UMUX (Usability Metric for User Experience). Returns {meta, summary, rows}: rows are one PER SURVEY (scores are never pooled across different surveys), each with surveyId, surveyName, surveyType, score, and numResponses; NPS, CSAT, and PMF rows also break out numPositive, numNeutral, numNegative. summary is keyed by survey type and gives an equal-weighted mean of that type's per-survey scores (avgScore, numSurveys, totalResponses) - the business roll-up across surveys of that type. Audience can be scoped via an inline segmentPipeline and/or a single accountId; surveyId narrows to one survey (or a single NPS guide); appId narrows to surveys in one app; surveyTypes selects which types to include. USE FOR: Per-survey NPS/CSAT/PMF/UMUX scores over a window, the positive/neutral/negative breakdown per survey, and the average score across all surveys of a type - optionally scoped to an account, app, or segment. EXAMPLES: - What is our NPS score? - Show me NPS trends over the last 30 days - What's our CSAT score for each survey over the last 30 days? - Give me the score for every CSAT survey and the overall average - What's the CSAT score for account X this quarter? - Show the positive/neutral/negative breakdown for each PMF survey last month - What's our UMUX score over the last 90 days? RETURNS: - meta.dateRange: resolved startDate and endDate (YYYY-MM-DD) - summary: keyed by survey type, each with avgScore (equal-weighted mean of that type's per-survey scores), numSurveys, totalResponses - rows: one per survey with surveyId, surveyName, surveyType, score, numResponses. NPS score is -100 to +100; CSAT/PMF/UMUX score is 0-100. NPS/CSAT/PMF rows also include numPositive, numNeutral, numNegative.
unlinkIdeaFeedback
ChatGPTRemoves the link between an existing feedback item and an existing idea, detaching the customer evidence from the idea. Votes propagated from the feedback item are removed from the idea's vote count. USE FOR: When the user explicitly asks to unlink, disconnect, or remove the association between a feedback item and an idea, or vice versa EXAMPLES: - Unlink feedback abc123 from idea xyz456 - Disconnect this feedback from that idea - Remove the association between idea xyz456 and feedback abc123 RETURNS: - Confirmation that the idea and feedback item have been unlinked
updateFeedbackItem
ChatGPTUpdates an existing feedback item. Only fields that are explicitly provided are modified; omitted fields are left unchanged. Returns the ID of the updated feedback item. USE FOR: When the user wants to edit an existing feedback item's title, description, status, application, product area, labels, assignee, or importance EXAMPLES: - Update the title of feedback 123 to 'New title' - Change the status of feedback 456 to 'Under Review' - Set the importance of feedback 789 to 'Must Have' - Clear all labels on feedback 123 - Assign feedback 123 to user@example.com RETURNS: - ID of the updated feedback item
updateIdeaItem
ChatGPTUpdates an existing product idea. Only fields that are explicitly provided are modified; omitted fields are left unchanged. Returns the ID of the updated idea. USE FOR: When the user wants to edit an existing idea's title, description, status, application, product area, labels, assignee, effort, or impact EXAMPLES: - Update the title of idea 123 to 'New title' - Change the status of idea 456 to 'In Progress' - Set the effort for idea 789 to 3 - Replace the labels on idea 123 with Enterprise and Beta in category Release - Assign idea 123 to user@example.com RETURNS: - ID of the updated idea
updateOrchestrateEmailContent
ChatGPTSaves HTML email body content for an email step inside an Orchestrate journey (use messageId from getOrchestrateJourneySteps). Journey email steps only (messageId from getOrchestrateJourneySteps). Standalone HTML emails are not supported via MCP. Only HTML editor emails can be updated (raw HTML body). Template or block-builder emails (guide-based layouts) are not supported. Running emails are blocked; scheduled public emails remain editable (same as the HTTP content API). When emailType is unset, it is treated as marketing. Unsubscribe: use the exact literal {{ UnsubscribeURI }} in the HTML (spacing matters). Required for marketing emails and when emailType is unset; optional for transactional. Missing token on marketing emails returns a validation error. Personalization is optional. Any {visitor.../} or {account.../} token requires visitorMetadataSchema (and accountMetadataSchema for account fields) first - every token key must exactly match a key returned by those tools for this subscription. Never invent, guess, or assume field names (including common names like firstname, email, company, or role). Map each returned key to a single-brace email token (e.g. visitor.agent.email -> {visitor.agent.email/}, visitor.agent.firstname -> {visitor.agent.firstname|Friend/}). Personalization token names are not validated at save (same as the HTTP content API); calling the schema tools first is the only way to avoid invalid tokens. USE FOR: Saving HTML body content for a journey email step. EXAMPLES: - Save static HTML for journey email step abc123 including {{ UnsubscribeURI }} (no personalization tokens - schema tools not required) - User wants Hi {firstname}: call visitorMetadataSchema first; only if visitor.agent.firstname (or another returned key) exists, use {visitor.agent.firstname|there/}; if no name field exists, tell the user - do not invent firstname - User wants account industry in the email: accountMetadataSchema first, find exact key (e.g. account.salesforce.industry), then {account.salesforce.industry/} - never guess account.custom.industry NOT FOR: Standalone HTML emails (open emailUrl from the create response in the Orchestrate UI to edit HTML body; this tool does not support standalone emails). Template or block-builder emails (guide-based layouts, not raw HTML). Adding a new email step to the journey graph (add the email node to the journey first, then resolve messageId from journey steps). Changing email settings such as sender, subject, or status (use the Orchestrate UI). Running emails. Empty HTML body. Adding any {visitor.../} or {account.../} token without calling visitorMetadataSchema and accountMetadataSchema first (never invent or guess metadata field names). Substituting a different metadata key when the user requested field is not in the schema response. WORKFLOW: 1. Use getOrchestrateJourney and getOrchestrateJourneySteps to get the existing email step messageId (emailId). This tool updates HTML only - it does not create email steps. Confirm the step is an HTML editor email (not a template or block-builder email) and is not running. 2. If the HTML will include any {visitor.../} or {account.../} personalization token, STOP: call visitorMetadataSchema first (and accountMetadataSchema for any account token) before writing HTML - do not call updateOrchestrateEmailContent until schema tools have returned. Use only keys present in those responses; each token must exactly match a returned key (visitor.agent.email -> {visitor.agent.email/}). Never invent, guess, or assume field names - not even common ones like firstname, email, company, or role. If the user asked for a field that is not in the schema response, tell them it is not available on this subscription; do not substitute a similar-sounding key. If not personalizing, skip this step. Build HTML; for marketing emails or when emailType is unset, include the exact literal {{ UnsubscribeURI }} (optional for transactional). 3. Call updateOrchestrateEmailContent with emailId and htmlContent. RETURNS: - resultSummary: human-readable summary of the update - val…
updateSegment
ChatGPTUpdates an existing Pendo visitor segment. Only the fields you provide are changed; omitted fields are left as-is. Confirm the segment id, updated name (if any), and a human-readable summary of every AND/OR clause with the user before submitting. USE FOR: Editing a saved segment's name, description, sharing, or rules. Fetch the current definition with getSegment first if the user wants to tweak specific rules - this tool replaces the whole rule set when a definition is provided. EXAMPLES: - Rename segment abc123 to "Power users". - Make segment xyz789 public. - Update the rules on segment abc123 to only include visitors active in the last 14 days. RETURNS: - id: the updated segment's id. - summary: plain-English description of the persisted segment rules with entity names resolved. Reflects what was actually stored after compile-time normalization. EntityTypes: visitor: requiredFields: entityType: "visitor" entityId: String supportedMetrics: [] account: requiredFields: entityType: "account" entityId: String supportedMetrics: [] page: requiredFields: entityType: "page" entityId: String supportedMetrics: ["eventCount", "deadClicks", "errorClicks", "rageClicks", "daysActive", "uTurns", "eventTime", "seen", "notseen", "lastSeen"] feature: requiredFields: entityType: "feature" entityId: String supportedMetrics: ["eventCount", "deadClicks", "errorClicks", "rageClicks", "daysActive", "used", "notused", "lastused"] trackEvent: requiredFields: entityType: "trackEvent" entityId: String supportedMetrics: ["eventCount", "daysActive", "used", "notused", "lastused"] guide: requiredFields: entityType: "guide" entityId: String supportedMetrics: ["seen", "lastSeen", "notSeen"] poll: requiredFields: entityType: "poll" entityId: String pollId: String // the poll nested under the guide supportedMetrics: ["response"] guideElement: requiredFields: entityType: "guideElement" entityId: String stepId: String // the guide step the element sits on elementId: String // the element's uiElementId, e.g. "pendo-button-a1b2c3d4" supportedMetrics: ["eventCount"] segment: requiredFields: entityType: "segment" entityId: String supportedMetrics: ["isMemberOfSegment", "isNotMemberOfSegment"] metadata: requiredFields: entityType: "metadata" entityId: String supportedMetrics: [] agent: requiredFields: entityType: "agent" entityId: String supportedMetrics: ["eventCount", "daysActive", "used", "notused", "lastused"] guideExperiment: requiredFields: entityType: "guideExperiment" entityId: String experimentId: String // the experiment, from listGuideExperiments; draft experiments are not selectable. Requires guide experiments enabled for the subscription; rules that need it are refused otherwise. variantName: Enum["A", "B"] // POSITIONAL: "A" is the experiment's first variant and "B" its second, whichever is the control. Experiments have exactly two variants. experimentConverted: Enum["None", "Yes", "No"] // only when the experiment has a conversion goal; "None" means any conversion status supportedMetrics: [] Metrics: eventCount: description: Number of events for the selected entity. requiredFields: metric: "eventCount" operator: Enum["==", "!=", ">=", "<="] threshold: Integer supportedConditions: ["withinLast", "between"] deadClicks: description: Number of dead clicks for the selected page or feature. requiredFields: metric: "deadClicks" operator: Enum["==", "!=", ">=", "<="] threshold: Integer supportedConditions: ["withinLast", "between"] errorClicks: description: Number of error clicks for the selected page or feature. requiredFields: metric: "errorClicks" operator: Enum["==", "!=", ">=", "<="] threshold: Integer supportedConditions: ["withinLast", "between"] rageClicks: description: Number of rage clicks for the selected page or feature. requiredFields: metric: "rageClicks" operator: Enum["==", "!=", ">=", "<="] threshold: Integer supportedConditions: ["withinLast", "between"] daysActive: description: Number of active days for the selected entity. requiredFields: metric: "daysActive" operator: Enum["==", "!=", ">=", "<="] threshold: Integer supportedConditio…
viewGuide
ChatGPTView a Pendo guide as a preview in the chat: renders the guide's steps and shows an Open in Pendo button that links to the guide in Pendo. USE FOR: Previewing a specific Pendo guide's steps and content in context, with a link to open it in Pendo. Offer it once, unprompted, after answering about a single guide, and call it only after the user accepts. EXAMPLES: - View guide abc123 - Show me the steps of this guide NOT FOR: Listing guides, guide analytics, or creating a guide from scratch. WORKFLOW: If the client cannot render the preview card, report the guide name, step count, and editUrl; never echo dom, buildingBlocks, or content. RETURNS: - Renders the guide's steps as a preview with an Open in Pendo button that links to the guide. - steps[].content: a step's code block HTML, for the preview widget only.
visitorActivity
ChatGPTReturns comprehensive activity timeline for a specific visitor, including page views, feature clicks, guide interactions, and custom track events. Provides detailed chronological analysis of user behavior with rich entity context. USE FOR: Detailed visitor behavior analysis, timeline reconstruction, debugging user journeys EXAMPLES: - Complete timeline for visitor X - What did user Y do on January 15th? - Which pages did visitor Z view? - Which features did visitor A click? - Which guides did visitor B complete? - Which polls did visitor C respond to? NOT FOR: Bulk visitor analysis across many visitors, or ranking visitors by event participation - this tool reconstructs the timeline of a single specified visitor. WORKFLOW: Use listPagesFeaturesAndEvents to find entity ID by name, then use this tool for detailed analysis RETURNS: - Chronologically sorted activity timeline with entity context. Large results automatically stored with signed URL for polling. The maximum time range for this tool is 31 days.
visitorMetadataSchema
ChatGPTReturn the set of metadata that is available from the visitors table for each visitor. It is a set of . separated metadata field names to information about that field, including the type. Here is an example return value { "metadata.auto.lastvisit" : "time", "metadata.pendo.donotproces" : "boolean" } PERFORMANCE: This is a fast-running tool.
visitorQuery
ChatGPTRetrieve visitor data and metadata OR just the counts of matching visitors by running aggregation queries directly against the visitor dataset. Every response entity will conceptually be a visitor (a person who visited the application) and their associated metadata if you use select to ask for them. USE FOR: Getting visitor information, metadata, and visitor counts with flexible filtering options. EXAMPLES: - Get all visitors with their last visit time - Show me visitors from a specific segment - How many visitors match certain criteria? (set count=true) - Get visitor metadata like browser, location, or custom fields - Find visitors with a specific metadata value WORKFLOW: Use the visitorMetadataSchema tool to explore available metadata fields, then use this tool for detailed analysis RETURNS: - Visitor data with selected metadata fields (without select passed in, no metadata fields are returned) - Visitor counts when count=true is specified - Results filtered by segments, specific visitor IDs, metadata, or other criteria - Results are sorted by last visit time descending - By default, results are limited to 10,000 visitors per request. If 10,000 visitors are returned, assume there are more visitors and consider refining your filters or increasing the limit. FILTERING OPTIONS: - Filter by specific visitor ID - Filter by visitor segments - Filter by metadata value for a specific metadata group and field - Automatically filters out anonymous visitors (unless subscription allows them) PERFORMANCE: This is a fast-running tool.
accountMetadataSchema
ClaudeaccountQuery
ClaudeactivityQuery
ClaudeguideMetrics
Claudelist_all_applications
Claudepes
ClaudesearchEntities
ClaudesegmentList
ClaudesessionReplayList
ClaudevisitorMetadataSchema
ClaudevisitorQuery
Claude
