How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Genesys

Genesys Analytics API

Analytics querying and reporting.

Documentation Provider Profile APIs.io OpenAPI GitHub

Genesys Analytics API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 121 operations across 100 paths, and defines 366 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

121 operations 100 paths 366 schemas 17 DELETE50 GET1 PATCH52 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
Contact
PureCloud Developer Evangelists
License
UNLICENSED
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Genesys Analytics API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 121

Across 100 paths, the API surfaces 121 operations — 17 DELETE, 50 GET, 1 PATCH, 52 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Analytics 121

Analytics querying and reporting.

POST
/api/v2/analytics/actions/aggregates/jobs
Query for action aggregates asynchronously
postAnalyticsActionsAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/actions/aggregates/jobs/{jobId}
Get status for async query for action aggregates
getAnalyticsActionsAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/actions/aggregates/jobs/{jobId}
Delete/cancel an async request for action aggregates
deleteAnalyticsActionsAggregatesJob 1 param → 204400401403404408409413
POST
/api/v2/analytics/actions/aggregates/query
Query for action aggregates
postAnalyticsActionsAggregatesQuery 1 param → 200400401403404408409413
GET
/api/v2/analytics/actions/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsActionsAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/agentcopilots/aggregates/query
Query for agent copilot aggregates
postAnalyticsAgentcopilotsAggregatesQuery 1 param → 200400401403404408409413
GET
/api/v2/analytics/agents/{userId}/status
Get an agent and their active sessions by user ID
getAnalyticsAgentStatus 1 param → 200400401403404408409413
POST
/api/v2/analytics/agents/status/counts
Count agents by different groupings
postAnalyticsAgentsStatusCounts 2 params → 200400401403404408409413
POST
/api/v2/analytics/agents/status/query
Retrieve the top 50 agents matching the query filters
postAnalyticsAgentsStatusQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/bots/aggregates/query
Query for bot aggregates
postAnalyticsBotsAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/bots/aggregates/jobs
Query for bot aggregates asynchronously
postAnalyticsBotsAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/bots/aggregates/jobs/{jobId}
Get status for async query for bot aggregates
getAnalyticsBotsAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/bots/aggregates/jobs/{jobId}
Delete/cancel an async request for bot aggregates
deleteAnalyticsBotsAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/bots/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsBotsAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/casemanagement/aggregates/query
Query for case management aggregates
postAnalyticsCasemanagementAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/casemanagement/aggregates/jobs
Query for case management aggregates asynchronously
postAnalyticsCasemanagementAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}
Get status for async query for case management aggregates
getAnalyticsCasemanagementAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}
Delete/cancel an async request for case management aggregates
deleteAnalyticsCasemanagementAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results
Fetch a page of results for an async case management query
getAnalyticsCasemanagementAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/conversations/aggregates/query
Query for conversation aggregates
postAnalyticsConversationsAggregatesQuery 1 param → 200400401403404408409413
GET
/api/v2/analytics/conversations/{conversationId}/details
Get a conversation by id
getAnalyticsConversationDetails 1 param → 200400401403404408409413
POST
/api/v2/analytics/conversations/aggregates/jobs
Query for conversation aggregates asynchronously
postAnalyticsConversationsAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/conversations/aggregates/jobs/{jobId}
Get status for async query for conversation aggregates
getAnalyticsConversationsAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/conversations/aggregates/jobs/{jobId}
Delete/cancel an async request for conversation aggregates
deleteAnalyticsConversationsAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/conversations/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsConversationsAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/conversations/activity/query
Query for conversation activity observations
postAnalyticsConversationsActivityQuery 3 params → 200400401403404408409413
POST
/api/v2/analytics/conversations/details/query
Query for conversation details
postAnalyticsConversationsDetailsQuery 1 param → 200400401403404408409413
GET
/api/v2/analytics/conversations/details
Gets multiple conversations by id
getAnalyticsConversationsDetails 1 param → 200400401403404408409413
POST
/api/v2/analytics/conversations/{conversationId}/details/properties
Index conversation properties
postAnalyticsConversationDetailsProperties 2 params → 202400401403404408409413
POST
/api/v2/analytics/conversations/details/jobs
Query for conversation details asynchronously
postAnalyticsConversationsDetailsJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/conversations/details/jobs/{jobId}
Get status for async query for conversation details
getAnalyticsConversationsDetailsJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/conversations/details/jobs/{jobId}
Delete/cancel an async details job
deleteAnalyticsConversationsDetailsJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/conversations/details/jobs/{jobId}/results
Fetch a page of results for an async details job
getAnalyticsConversationsDetailsJobResults 3 params → 200400401403404408409413
GET
/api/v2/analytics/conversations/details/jobs/availability
Lookup the datalake availability date and time
getAnalyticsConversationsDetailsJobsAvailability → 200400401403404408409413
POST
/api/v2/analytics/evaluations/aggregates/query
Query for evaluation aggregates
postAnalyticsEvaluationsAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/evaluations/aggregates/jobs
Query for evaluation aggregates asynchronously
postAnalyticsEvaluationsAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/evaluations/aggregates/jobs/{jobId}
Get status for async query for evaluation aggregates
getAnalyticsEvaluationsAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/evaluations/aggregates/jobs/{jobId}
Delete/cancel an async request for evaluation aggregates
deleteAnalyticsEvaluationsAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsEvaluationsAggregatesJobResults 2 params → 200400401403404408409413
GET
/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}
Get status for async query for flow execution aggregates
getAnalyticsFlowexecutionsAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}
Delete/cancel an async request for flow execution aggregates
deleteAnalyticsFlowexecutionsAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsFlowexecutionsAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/flowexecutions/aggregates/query
Query for flow execution aggregates
postAnalyticsFlowexecutionsAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/flowexecutions/aggregates/jobs
Query for flow execution aggregates asynchronously
postAnalyticsFlowexecutionsAggregatesJobs 1 param → 202400401403404408409413
POST
/api/v2/analytics/flows/aggregates/jobs
Query for flow aggregates asynchronously
postAnalyticsFlowsAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/flows/aggregates/jobs/{jobId}
Get status for async query for Flow aggregates
getAnalyticsFlowsAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/flows/aggregates/jobs/{jobId}
Delete/cancel an async request for flow aggregates
deleteAnalyticsFlowsAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/flows/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsFlowsAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/flows/observations/query
Query for flow observations
postAnalyticsFlowsObservationsQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/flows/activity/query
Query for flow activity observations
postAnalyticsFlowsActivityQuery 3 params → 200400401403404408409413
POST
/api/v2/analytics/flows/aggregates/query
Query for flow aggregates
postAnalyticsFlowsAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/journeys/aggregates/query
Query for journey aggregates
postAnalyticsJourneysAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/journeys/aggregates/jobs
Query for journey aggregates asynchronously
postAnalyticsJourneysAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/journeys/aggregates/jobs/{jobId}
Get status for async query for journey aggregates
getAnalyticsJourneysAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/journeys/aggregates/jobs/{jobId}
Delete/cancel an async request for journey aggregates
deleteAnalyticsJourneysAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/journeys/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsJourneysAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/knowledge/aggregates/query
Query for knowledge aggregates
postAnalyticsKnowledgeAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/knowledge/aggregates/jobs
Query for knowledge aggregates asynchronously
postAnalyticsKnowledgeAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/knowledge/aggregates/jobs/{jobId}
Get status for async query for knowledge aggregates
getAnalyticsKnowledgeAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/knowledge/aggregates/jobs/{jobId}
Delete/cancel an async request for knowledge aggregates
deleteAnalyticsKnowledgeAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/knowledge/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsKnowledgeAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/queues/observations/query
Query for queue observations
postAnalyticsQueuesObservationsQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/ratelimits/aggregates/query
Query for limits rate limit aggregates. Data populated when limits reach 90% of the maximum. Not a source of truth for limits hit but a best effort estimate.
postAnalyticsRatelimitsAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/resolutions/aggregates/query
Query for resolution aggregates
postAnalyticsResolutionsAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/resolutions/aggregates/jobs
Query for resolution aggregates asynchronously
postAnalyticsResolutionsAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/resolutions/aggregates/jobs/{jobId}
Get status for async query for resolution aggregates
getAnalyticsResolutionsAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/resolutions/aggregates/jobs/{jobId}
Delete/cancel an async request for resolution aggregates
deleteAnalyticsResolutionsAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/resolutions/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsResolutionsAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/routing/activity/query
Query for user activity observations
postAnalyticsRoutingActivityQuery 3 params → 200400401403404408409413
POST
/api/v2/analytics/summaries/aggregates/query
Query for summary aggregates
postAnalyticsSummariesAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/summaries/aggregates/jobs
Query for summary aggregates asynchronously
postAnalyticsSummariesAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/summaries/aggregates/jobs/{jobId}
Get status for async query for summary aggregates
getAnalyticsSummariesAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/summaries/aggregates/jobs/{jobId}
Delete/cancel an async request for summary aggregates
deleteAnalyticsSummariesAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/summaries/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsSummariesAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/surveys/aggregates/query
Query for survey aggregates
postAnalyticsSurveysAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/surveys/aggregates/jobs
Query for survey aggregates asynchronously
postAnalyticsSurveysAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/surveys/aggregates/jobs/{jobId}
Get status for async query for survey aggregates
getAnalyticsSurveysAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/surveys/aggregates/jobs/{jobId}
Delete/cancel an async request for survey aggregates
deleteAnalyticsSurveysAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/surveys/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsSurveysAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/taskmanagement/aggregates/query
Query for task management aggregates
postAnalyticsTaskmanagementAggregatesQuery 1 param → 200400401403404408409413
GET
/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}
Get status for async query for task management aggregates
getAnalyticsTaskmanagementAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}
Delete/cancel an async request for task management aggregates
deleteAnalyticsTaskmanagementAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}/results
Fetch a page of results for an async task management query
getAnalyticsTaskmanagementAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/taskmanagement/metrics/query
Query for task management observations
postAnalyticsTaskmanagementMetricsQuery 3 params → 200400401403404408409413
POST
/api/v2/analytics/taskmanagement/aggregates/jobs
Query for task management aggregates asynchronously
postAnalyticsTaskmanagementAggregatesJobs 1 param → 202400401403404408409413
POST
/api/v2/analytics/teams/activity/query
Query for team activity observations
postAnalyticsTeamsActivityQuery 3 params → 200400401403404408409413
POST
/api/v2/analytics/transcripts/aggregates/query
Query for transcript aggregates
postAnalyticsTranscriptsAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/transcripts/aggregates/jobs
Query for transcript aggregates asynchronously
postAnalyticsTranscriptsAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/transcripts/aggregates/jobs/{jobId}
Get status for async query for transcript aggregates
getAnalyticsTranscriptsAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/transcripts/aggregates/jobs/{jobId}
Delete/cancel an async request for transcript aggregates
deleteAnalyticsTranscriptsAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/transcripts/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsTranscriptsAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/users/aggregates/query
Query for user aggregates
postAnalyticsUsersAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/users/aggregates/jobs
Query for user aggregates asynchronously
postAnalyticsUsersAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/users/aggregates/jobs/{jobId}
Get status for async query for user aggregates
getAnalyticsUsersAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/users/aggregates/jobs/{jobId}
Delete/cancel an async request for user aggregates
deleteAnalyticsUsersAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/users/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsUsersAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/users/details/query
Query for user details
postAnalyticsUsersDetailsQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/users/observations/query
Query for user observations
postAnalyticsUsersObservationsQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/users/activity/query
Query for user activity observations
postAnalyticsUsersActivityQuery 3 params → 200400401403404408409413
POST
/api/v2/analytics/users/details/jobs
Query for user details asynchronously
postAnalyticsUsersDetailsJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/users/details/jobs/{jobId}
Get status for async query for user details
getAnalyticsUsersDetailsJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/users/details/jobs/{jobId}
Delete/cancel an async request
deleteAnalyticsUsersDetailsJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/users/details/jobs/{jobId}/results
Fetch a page of results for an async query
getAnalyticsUsersDetailsJobResults 3 params → 200400401403404408409413
GET
/api/v2/analytics/users/details/jobs/availability
Lookup the datalake availability date and time
getAnalyticsUsersDetailsJobsAvailability → 200400401403404408409413
GET
/api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns
Get Reporting Turns (division aware).
getAnalyticsBotflowDivisionsReportingturns 8 params → 200400401403404408409413
GET
/api/v2/analytics/botflows/{botFlowId}/reportingturnsdeprecated
Get Reporting Turns.
getAnalyticsBotflowReportingturns 8 params → 200400401403404408409413
GET
/api/v2/analytics/botflows/{botFlowId}/sessions
Get Bot Flow Sessions.
getAnalyticsBotflowSessions 6 params → 200400401403404408409413
GET
/api/v2/analytics/dataretention/settings
Get analytics data retention setting
getAnalyticsDataretentionSettings → 200400401403404408409413
PUT
/api/v2/analytics/dataretention/settings
Update analytics data retention setting
putAnalyticsDataretentionSettings 1 param → 200400401403404408409413
GET
/api/v2/analytics/reporting/settings
Get AnalyticsReportingSettings for an organization
getAnalyticsReportingSettings → 200400401403404408409413
PATCH
/api/v2/analytics/reporting/settings
Patch AnalyticsReportingSettings values for an organization
patchAnalyticsReportingSettings 1 param → 200400401403404408409413
POST
/api/v2/analytics/reporting/settings/dashboards/bulk/remove
Bulk soft delete dashboard configurations
postAnalyticsReportingSettingsDashboardsBulkRemove 1 param → 204400401403404408409413
GET
/api/v2/analytics/reporting/settings/dashboards/query
Get list of dashboard configurations
getAnalyticsReportingSettingsDashboardsQuery 7 params → 200400401403404408409413
POST
/api/v2/analytics/reporting/settings/dashboards/query
Query dashboard configurations
postAnalyticsReportingSettingsDashboardsQuery 1 param → 200400401403404408409413
GET
/api/v2/analytics/reporting/dashboards/users/{userId}
Get dashboards summary for a user
getAnalyticsReportingDashboardsUser 1 param → 200400401403404408409413
POST
/api/v2/analytics/reporting/dashboards/users/bulk/remove
Bulk soft delete dashboards owned by other user(s)
postAnalyticsReportingDashboardsUsersBulkRemove 1 param → 204400401403404408409413
GET
/api/v2/analytics/reporting/dashboards/users
Get dashboards summary for users in a org
getAnalyticsReportingDashboardsUsers 6 params → 200400401403404408409413
GET
/api/v2/analytics/reporting/settings/users/{userId}/dashboards
Get list of dashboards for an user
getAnalyticsReportingSettingsUserDashboards 8 params → 200400401403404408409413
GET
/api/v2/analytics/reporting/exports/metadata
Get all export metadata
getAnalyticsReportingExportsMetadata → 200400401403404408409413
GET
/api/v2/analytics/reporting/exports
Get all view export requests for a user
getAnalyticsReportingExports 2 params → 200400401403404408409413
POST
/api/v2/analytics/reporting/exports
Generate a view export request
postAnalyticsReportingExports 1 param → 200400401403404408409413

Schemas 366

The contract defines 366 schemas that model the data the API accepts and returns. The most detailed are ViewFilter (242 properties), AnalyticsSession (89 properties), ReportingExportJobResponse (34 properties), Widget (29 properties). Each schema is shown below with its type and property counts.

FlowActivityEntityData
object
25 properties 1 required
UserObservationQueryPredicate
object
5 properties
UserActivityQueryMetric
object
2 properties 1 required
Cursors
object
2 properties
UserAggregateDataContainer
object
2 properties
TaskManagementAsyncAggregateQueryResponse
object
2 properties
SurveyAggregateQueryResponse
object
1 property
AnalyticsDataRetentionResponse
object
3 properties
UserDetailQueryClause
object
2 properties 2 required
ConversationAggregationView
object
4 properties 3 required
StatisticalSummary
object
14 properties
ResolutionAsyncAggregateQueryResponse
object
2 properties
AnalyticsSurvey
object
13 properties
SurveyAggregateQueryClause
object
2 properties 2 required
UserActivityData
object
4 properties
ConversationActivityData
object
4 properties
AnalyticsConversationWithoutAttributes
object
22 properties
AgentCopilotAggregateDataContainer
object
2 properties
UserActivityEntityData
object
10 properties 1 required
UserAggregateQueryFilter
object
3 properties 1 required
AggregationResult
object
5 properties
ConversationAggregateDataContainer
object
2 properties
AgentCopilotAggregateQueryFilter
object
3 properties 1 required
ActionAggregateQueryFilter
object
3 properties 1 required
ConversationDetailQueryClause
object
2 properties 2 required
FlowObservationDataContainer
object
2 properties
AnalyticsScoredAgent
object
2 properties
RateLimitAggregateDataContainer
object
2 properties
TaskManagementObservationResult
object
2 properties
FlowAggregateDataContainer
object
2 properties
ObservationMetricData
object
5 properties
DashboardUserListing
object
10 properties
TaskManagementObservationDataContainer
object
3 properties
TaskManagementObservationQueryFilter
object
1 property 1 required
ConversationActivityScoredAgent
object
2 properties
DashboardConfigurationBulkRequest
object
1 property 1 required
SegmentDetailQueryPredicate
object
8 properties
AnalyticsAgentStateQueryResponse
object
1 property
EvaluationAggregationQuery
object
9 properties 2 required
AgentStateSessionQueryClause
object
2 properties 2 required
KnowledgeAggregateQueryResponse
object
1 property
ConversationActivityQueryClause
object
2 properties 2 required
AnalyticsConversationAsyncQueryResponse
object
3 properties
UpdateAnalyticsDataRetentionRequest
object
1 property 1 required
UserObservationQuery
object
3 properties 2 required
AnalyticsConversation
object
22 properties
QueueObservationQueryClause
object
2 properties 2 required
PropertyIndexRequest
object
3 properties 3 required
SummaryAsyncAggregationQuery
object
13 properties 2 required
SurveyAggregationView
object
4 properties 3 required
ConversationActivityQuery
object
4 properties 2 required
TaskManagementQueryMetric
object
2 properties 1 required
ResolutionAggregationView
object
4 properties 3 required
ConversationAggregationSort
object
2 properties 2 required
TaskManagementAggregateQueryResponse
object
1 property
JourneyAggregateQueryFilter
object
3 properties 1 required
RoutingActivityEntityData
object
10 properties 1 required
FlowExecutionAggregateQueryFilter
object
3 properties 1 required
ChartColumn
object
2 properties
TaskManagementObservationPredicate
object
2 properties 2 required
ReportingTurnKnowledgeSearch
object
3 properties
TaskManagementObservationQuery
object
4 properties 3 required
AgentStatePresenceCount
object
3 properties
TextBotUserAgent
object
Information about the caller executing a bot flow.
1 property 1 required
AgentStateUserFilter
object
3 properties 1 required
ConversationActivityEntityData
object
23 properties 1 required
FlowObservationQuery
object
3 properties 2 required
ReportingTurnKnowledge
object
3 properties
ReportingExportJobRequest
object
21 properties 8 required
TeamActivityEntityData
object
10 properties 1 required
RoutingStatusDetailQueryClause
object
2 properties 2 required
SessionsResponse
object
4 properties
UserReferenceWithName
object
3 properties
ReportingTurnKnowledgeFeedback
object
3 properties
CaseManagementAsyncAggregationQuery
object
10 properties 2 required
AnalyticsConversationWithoutAttributesMultiGetResponse
object
1 property
ErrorBody
object
11 properties
EvaluationAggregateDataContainer
object
2 properties
DashboardsSharedWith
object
2 properties
TaskManagementObservationGroupResult
object
4 properties
ReportingTurnKnowledgeEvents
object
2 properties
TaskManagementAsyncAggregationQuery
object
10 properties 2 required
RoutingActivityQuery
object
4 properties 2 required
ConversationAggregateQueryPredicate
object
5 properties
AsyncConversationQuery
object
10 properties 1 required
BotAggregationSort
object
2 properties 2 required
FlowActivityQueryClause
object
2 properties 2 required
AnalyticsSessionMetric
object
3 properties
TeamActivityQuery
object
4 properties 2 required
BotAggregateQueryPredicate
object
5 properties
EvaluationDetailQueryClause
object
2 properties 2 required
AnalyticsProperty
object
3 properties
FlowExecutionAsyncAggregateQueryResponse
object
2 properties
UserAsyncAggregationQuery
object
10 properties 2 required
FlowActivityMetricValue
object
4 properties
AnalyticsParticipantWithoutAttributes
object
10 properties
ConversationActivityMetricValue
object
5 properties
AnalyticsAgentStateCountsResponse
object
4 properties
RateLimitAggregateQueryPredicate
object
5 properties
UserObservationQueryClause
object
2 properties 2 required
SummaryAggregateQueryPredicate
object
5 properties
AgentStateSegmentTypeCount
object
2 properties
QueueObservationDataContainer
object
2 properties
Transcripts
object
4 properties
TaskManagementObservationDetailContainer
object
2 properties
WorktypeReference
object
3 properties
FlowActivityResponse
object
2 properties
KnowledgeAggregateDataContainer
object
2 properties
TeamActivityQueryClause
object
2 properties 2 required
TaskManagementObservationQueryResponse
object
4 properties
UserActivityQueryFilter
object
3 properties 1 required
FlowExecutionAggregateQueryClause
object
2 properties 2 required
ActionAsyncAggregateQueryResponse
object
2 properties
Widget
object
29 properties 1 required
TranscriptAggregateQueryResponse
object
1 property
AnalyticsParticipant
object
11 properties
AsyncQueryResponse
object
1 property
QueueObservationQueryPredicate
object
5 properties
QueueObservationQuery
object
3 properties 2 required
QueueObservationQueryResponse
object
2 properties
AgentStateSessionFilter
object
3 properties 1 required
BotFlowSession
object
10 properties
JourneyAggregationView
object
4 properties 3 required
TranscriptAggregateQueryFilter
object
3 properties 1 required
SurveyAsyncAggregateQueryResponse
object
2 properties
ObservationValue
object
19 properties 1 required
KnowledgeAggregateQueryClause
object
2 properties 2 required
TranscriptTopics
object
2 properties
EvaluationAggregateQueryResponse
object
1 property
JourneyAsyncAggregateQueryResponse
object
2 properties
EvaluationAsyncAggregateQueryResponse
object
2 properties
AgentCopilotAggregateQueryPredicate
object
5 properties
EvaluationDetailQueryFilter
object
3 properties 1 required
QueueObservationQueryFilter
object
3 properties 1 required
AgentStateCountsRequest
object
2 properties
FlowAsyncAggregateQueryResponse
object
2 properties
RateLimitAggregationView
object
4 properties 3 required
ResolutionAggregationQuery
object
9 properties 2 required
KnowledgeAsyncAggregationQuery
object
13 properties 2 required
AnalyticsUserDetailsQueryResponse
object
3 properties
TranscriptAggregateDataContainer
object
2 properties
JourneyAggregateDataContainer
object
2 properties
TeamActivityData
object
4 properties
TeamActivityQueryFilter
object
3 properties 1 required
Entity
object
1 property
RoutingStatusDetailQueryFilter
object
3 properties 1 required
FlowObservationQueryClause
object
2 properties 2 required
FlowExecutionAggregationQuery
object
9 properties 2 required
UserActivityQueryClause
object
2 properties 2 required
KnowledgeAggregateQueryFilter
object
3 properties 1 required
SummaryAsyncAggregateQueryResponse
object
2 properties
ResolutionAggregateQueryFilter
object
3 properties 1 required
RoutingActivityResponse
object
2 properties
AnalyticsFlowOutcome
object
5 properties
ActionAsyncAggregationQuery
object
10 properties 2 required
AnalyticsUserPresenceRecord
object
4 properties
AnalyticsResolution
object
4 properties
SelectedColumns
object
2 properties
FlowAggregateQueryPredicate
object
5 properties
RateLimitAggregateQueryFilter
object
3 properties 1 required
TranscriptAggregationView
object
4 properties 3 required
UserDetailQueryPredicate
object
5 properties
AnalyticsMediaEndpointStat
object
11 properties
ReportingTurnIntent
object
4 properties
PagingSpec
object
2 properties 2 required
AnalyticsEvaluation
object
18 properties
AggregationResultEntry
object
4 properties
DashboardConfigurationListing
object
10 properties
EvaluationAggregateQueryPredicate
object
5 properties
ReportingTurnKnowledgeDocument
object
4 properties
WorkitemStatusFilter
object
2 properties
AnalyticsUserDetail
object
3 properties
UserObservationQueryResponse
object
1 property
BotChannel
object
Channel information relevant to a bot flow.
4 properties 4 required
DataAvailabilityResponse
object
1 property
RoutingActivityQueryFilter
object
3 properties 1 required
Warning
object
3 properties
SurveyAggregateDataContainer
object
2 properties
TeamActivityQueryPredicate
object
4 properties
ResolutionDetailQueryFilter
object
3 properties 1 required
ResolutionDetailQueryPredicate
object
5 properties
BotAsyncAggregateQueryResponse
object
2 properties
AsyncUserDetailsQuery
object
6 properties 1 required
SurveyDetailQueryFilter
object
3 properties 1 required
TranscriptAggregationQuery
object
12 properties 2 required
AddressableEntityRef
object
2 properties
AsyncQueryStatus
object
5 properties
SegmentDetailQueryClause
object
2 properties 2 required
AgentCopilotAggregateQueryResponse
object
1 property
RateLimitAggregateQueryResponse
object
1 property
AnalyticsReportingSettings
object
3 properties
ConversationActivityQueryPredicate
object
4 properties
UserActivityQuery
object
4 properties 2 required
FlowActivityData
object
4 properties
ActionAggregateDataContainer
object
2 properties
UserAggregationView
object
4 properties 3 required
ActionAggregateQueryResponse
object
1 property
BotAggregateDataContainer
object
2 properties
PresenceDetailQueryFilter
object
3 properties 1 required
AnalyticsProposedAgent
object
2 properties
CaseManagementAsyncAggregateQueryResponse
object
2 properties
ConversationAggregateQueryFilter
object
3 properties 1 required
ResolutionAggregateDataContainer
object
2 properties
ConversationAggregationQuery
object
12 properties 2 required
ConversationActivityResponse
object
2 properties
BotAsyncAggregationQuery
object
13 properties 2 required
ReportingTurnAction
object
4 properties
FlowAggregateQueryClause
object
2 properties 2 required
UserObservationDataContainer
object
2 properties
TranscriptAggregateQueryClause
object
2 properties 2 required
ReportingTurn
object
12 properties
FlowActivityScoredAgent
object
2 properties
AnalyticsUserDetailsAsyncQueryResponse
object
3 properties
EvaluationAggregateQueryFilter
object
3 properties 1 required
AgentCopilotAggregationSort
object
2 properties 2 required
TranscriptAggregateQueryPredicate
object
5 properties
ResolutionAggregateQueryResponse
object
1 property
NumericRange
object
4 properties
BotAggregationView
object
4 properties 3 required
JourneyAggregateQueryResponse
object
1 property
AgentStateRoutingStatusCount
object
2 properties
UserObservationQueryFilter
object
3 properties 1 required
EvaluationAggregateQueryClause
object
2 properties 2 required
FlowAsyncAggregationQuery
object
10 properties 2 required
EvaluationAsyncAggregationQuery
object
10 properties 2 required
ResolutionDetailQueryClause
object
2 properties 2 required
KnowledgeAggregateQueryPredicate
object
5 properties
CaseManagementAggregationQuery
object
9 properties 2 required
RoutingActivityMetricValue
object
5 properties
JourneyAggregationQuery
object
9 properties 2 required
FlowObservationQueryFilter
object
3 properties 1 required
Detail
object
4 properties
CaseManagementAggregateQueryPredicate
object
5 properties
TaskManagementAggregateDataContainer
object
2 properties
TaskManagementObservationMetricStats
object
2 properties
SurveyAggregateQueryFilter
object
3 properties 1 required
FlowAggregationView
object
4 properties 3 required
ReportingTurnsResponse
object
4 properties
FlowExecutionAggregateQueryResponse
object
1 property
ConversationDetailQueryFilter
object
3 properties 1 required
ConversationProperties
object
12 properties
CaseManagementAggregateQueryFilter
object
3 properties 1 required
TaskManagementAggregateQueryFilter
object
3 properties 1 required
ResolutionAggregateQueryPredicate
object
5 properties
ActionAggregationQuery
object
9 properties 2 required
Limit
object
3 properties
BotAggregationQuery
object
12 properties 2 required
RateLimitAggregateQueryClause
object
2 properties 2 required
SocialKeyword
object
2 properties
UserAggregateQueryClause
object
2 properties 2 required
KnowledgeAsyncAggregateQueryResponse
object
2 properties
UserActivityQueryPredicate
object
4 properties
FlowObservationQueryResponse
object
1 property
EvaluationAggregationView
object
4 properties 3 required
KnowledgeAggregationSort
object
2 properties 2 required
CaseManagementAggregateQueryClause
object
2 properties 2 required
PresenceDetailQueryClause
object
2 properties 2 required
ConversationActivityQueryMetric
object
2 properties 1 required
SurveyDetailQueryClause
object
2 properties 2 required
UserDetailsQuery
object
8 properties 1 required
RoutingStatusDetailQueryPredicate
object
5 properties
AnalyticsAgentStateAgentResponse
object
12 properties
FlowAggregateQueryFilter
object
3 properties 1 required
SummaryAggregateDataContainer
object
2 properties
RoutingActivityQueryMetric
object
2 properties 1 required
DashboardUser
object
6 properties
RoutingActivityQueryPredicate
object
4 properties
PresenceDetailQueryPredicate
object
5 properties
AgentCopilotAggregationQuery
object
12 properties 2 required
TaskManagementAggregationQuery
object
9 properties 2 required
CaseManagementAggregateQueryResponse
object
1 property
SurveyAggregateQueryPredicate
object
5 properties
DashboardConfiguration
object
16 properties 5 required
ReportingTurnKnowledgeSearchEvent
object
5 properties
ActionAggregateQueryPredicate
object
5 properties
FlowObservationQueryPredicate
object
5 properties
SummaryAggregationView
object
4 properties 3 required
ReportingTurnIntentSlot
object
4 properties
AnalyticsConversationQueryResponse
object
3 properties
TeamActivityMetricValue
object
5 properties
ConversationAggregateQueryResponse
object
1 property
RoutingActivityData
object
4 properties
ConversationDetailQueryPredicate
object
6 properties
StatisticalResponse
object
3 properties
AggregateViewData
object
2 properties
ConversationAsyncAggregateQueryResponse
object
2 properties
RoutingActivityQueryClause
object
2 properties 2 required
FlowActivityQueryPredicate
object
4 properties
AgentStateAgentQueryClause
object
2 properties 2 required
ReportingExportJobResponse
object
34 properties 13 required
UserAggregateQueryResponse
object
2 properties
AnalyticsConversationSegment
object
25 properties
TeamActivityResponse
object
2 properties
ConversationActivityQueryFilter
object
3 properties 1 required
FlowActivityQuery
object
4 properties 2 required
SummaryAggregationSort
object
2 properties 2 required
SummaryAggregateQueryClause
object
2 properties 2 required
FlowExecutionAsyncAggregationQuery
object
10 properties 2 required
ConversationAggregateQueryClause
object
2 properties 2 required
UserActivityMetricValue
object
4 properties
DashboardConfigurationQueryRequest
object
4 properties 1 required
AnalyticsRoutingStatusRecord
object
3 properties
CaseManagementAggregationView
object
4 properties 3 required
KnowledgeAggregationQuery
object
12 properties 2 required
JourneyAggregateQueryPredicate
object
5 properties
TranscriptAsyncAggregationQuery
object
13 properties 2 required
AgentStateQueryRequest
object
6 properties
BotAggregateQueryFilter
object
3 properties 1 required
AnalyticsFlow
object
15 properties
BotAggregateQueryResponse
object
1 property
FlowExecutionAggregateQueryPredicate
object
5 properties
SocialNumericRange
object
5 properties
ConversationQuery
object
10 properties 1 required
AnalyticsSession
object
89 properties
RateLimitAggregationQuery
object
9 properties 2 required
SummaryAggregateQueryFilter
object
3 properties 1 required
UserAggregateQueryPredicate
object
5 properties
BotAggregateQueryClause
object
2 properties 2 required
AgentStateAgentQueryPredicate
object
2 properties 2 required
JourneyAggregateQueryClause
object
2 properties 2 required
ViewFilter
object
242 properties
UserActivityResponse
object
2 properties
JourneyAsyncAggregationQuery
object
10 properties 2 required
AnalyticsAgentGroup
object
2 properties
TranscriptAggregationSort
object
2 properties 2 required
AgentStateSessionQueryPredicate
object
2 properties 2 required
AgentStateIsOutOfOfficeCount
object
2 properties
TeamActivityQueryMetric
object
2 properties 1 required
CaseManagementAggregateDataContainer
object
2 properties
UserAggregationQuery
object
9 properties 2 required
SurveyDetailQueryPredicate
object
6 properties
AggregateMetricData
object
3 properties
FlowAggregationQuery
object
9 properties 2 required
SurveyAggregationQuery
object
9 properties 2 required
FlowExecutionAggregateDataContainer
object
2 properties
AnalyticsQueryAggregation
object
5 properties
TaskManagementAggregateQueryClause
object
2 properties 2 required
SummaryAggregationQuery
object
12 properties 2 required
SessionEndDetails
object
2 properties
ReportingExportJobListing
object
10 properties
SurveyAsyncAggregationQuery
object
10 properties 2 required
ReportingExportMetadataJobResponse
object
10 properties
SummaryAggregateQueryResponse
object
1 property
AgentCopilotAggregateQueryClause
object
2 properties 2 required
ReportingTurnKnowledgeFeedbackEvent
object
6 properties
TaskManagementAggregateQueryPredicate
object
5 properties
UserAsyncAggregateQueryResponse
object
3 properties
FlowActivityQueryMetric
object
2 properties 1 required
ActionAggregateQueryClause
object
2 properties 2 required
SegmentDetailQueryFilter
object
3 properties 1 required
ResolutionAsyncAggregationQuery
object
10 properties 2 required
ReportingExportMetadataJobListing
object
10 properties
KnowledgeAggregationView
object
4 properties 3 required
ActionAggregationView
object
4 properties 3 required
AnalyticsAgentStateAgentSessionResult
object
10 properties
EvaluationDetailQueryPredicate
object
6 properties
FlowExecutionAggregationView
object
4 properties 3 required
UserDetailQueryFilter
object
3 properties 1 required
ConversationAsyncAggregationQuery
object
13 properties 2 required
AgentCopilotAggregationView
object
4 properties 3 required
ResolutionAggregateQueryClause
object
2 properties 2 required
FlowAggregateQueryResponse
object
1 property
FlowActivityQueryFilter
object
3 properties 1 required
TaskManagementAggregationView
object
4 properties 3 required
AggregationRange
object
2 properties
TranscriptAsyncAggregateQueryResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-analytics-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
AE Profile APIs.io
Genesys Agent Copilot API
AE Profile APIs.io
Genesys Agent UI API
AE Profile APIs.io
Genesys AI Studio API
AE Profile APIs.io
Genesys Alerting API
AE Profile APIs.io
Genesys Architect API
AE Profile APIs.io
Genesys Assistant Copilot Variations API
AE Profile APIs.io
Genesys Audit API
AE Profile APIs.io
Genesys Authorization API
AE Profile APIs.io
Genesys Background Assistant API
AE Profile APIs.io
Genesys Billing API
AE Profile APIs.io
Genesys Business Rules API
AE Profile APIs.io
#Analytics
← Back to G APIs
API Details
ID
genesys:genesys-analytics-api
Base URL
https://api.mypurecloud.com
Docs
https://developer.genesys.cloud/platform/api/
Provider
Genesys
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=genesys-analytics-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-analytics-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Genesys Analytics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.