Genesys

Genesys Analytics API

Analytics querying and reporting.

GitHub OpenAPI

Operations 121

POST /api/v2/analytics/actions/aggregates/jobs Query for action aggregates asynchronously #
GET /api/v2/analytics/actions/aggregates/jobs/{jobId} Get status for async query for action aggregates #
DELETE /api/v2/analytics/actions/aggregates/jobs/{jobId} Delete/cancel an async request for action aggregates #
POST /api/v2/analytics/actions/aggregates/query Query for action aggregates #
GET /api/v2/analytics/actions/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/agentcopilots/aggregates/query Query for agent copilot aggregates #
GET /api/v2/analytics/agents/{userId}/status Get an agent and their active sessions by user ID #
POST /api/v2/analytics/agents/status/counts Count agents by different groupings #
POST /api/v2/analytics/agents/status/query Retrieve the top 50 agents matching the query filters #
POST /api/v2/analytics/bots/aggregates/query Query for bot aggregates #
POST /api/v2/analytics/bots/aggregates/jobs Query for bot aggregates asynchronously #
GET /api/v2/analytics/bots/aggregates/jobs/{jobId} Get status for async query for bot aggregates #
DELETE /api/v2/analytics/bots/aggregates/jobs/{jobId} Delete/cancel an async request for bot aggregates #
GET /api/v2/analytics/bots/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/casemanagement/aggregates/query Query for case management aggregates #
POST /api/v2/analytics/casemanagement/aggregates/jobs Query for case management aggregates asynchronously #
GET /api/v2/analytics/casemanagement/aggregates/jobs/{jobId} Get status for async query for case management aggregates #
DELETE /api/v2/analytics/casemanagement/aggregates/jobs/{jobId} Delete/cancel an async request for case management aggregates #
GET /api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results Fetch a page of results for an async case management query #
POST /api/v2/analytics/conversations/aggregates/query Query for conversation aggregates #
GET /api/v2/analytics/conversations/{conversationId}/details Get a conversation by id #
POST /api/v2/analytics/conversations/aggregates/jobs Query for conversation aggregates asynchronously #
GET /api/v2/analytics/conversations/aggregates/jobs/{jobId} Get status for async query for conversation aggregates #
DELETE /api/v2/analytics/conversations/aggregates/jobs/{jobId} Delete/cancel an async request for conversation aggregates #
GET /api/v2/analytics/conversations/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/conversations/activity/query Query for conversation activity observations #
POST /api/v2/analytics/conversations/details/query Query for conversation details #
GET /api/v2/analytics/conversations/details Gets multiple conversations by id #
POST /api/v2/analytics/conversations/{conversationId}/details/properties Index conversation properties #
POST /api/v2/analytics/conversations/details/jobs Query for conversation details asynchronously #
GET /api/v2/analytics/conversations/details/jobs/{jobId} Get status for async query for conversation details #
DELETE /api/v2/analytics/conversations/details/jobs/{jobId} Delete/cancel an async details job #
GET /api/v2/analytics/conversations/details/jobs/{jobId}/results Fetch a page of results for an async details job #
GET /api/v2/analytics/conversations/details/jobs/availability Lookup the datalake availability date and time #
POST /api/v2/analytics/evaluations/aggregates/query Query for evaluation aggregates #
POST /api/v2/analytics/evaluations/aggregates/jobs Query for evaluation aggregates asynchronously #
GET /api/v2/analytics/evaluations/aggregates/jobs/{jobId} Get status for async query for evaluation aggregates #
DELETE /api/v2/analytics/evaluations/aggregates/jobs/{jobId} Delete/cancel an async request for evaluation aggregates #
GET /api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
GET /api/v2/analytics/flowexecutions/aggregates/jobs/{jobId} Get status for async query for flow execution aggregates #
DELETE /api/v2/analytics/flowexecutions/aggregates/jobs/{jobId} Delete/cancel an async request for flow execution aggregates #
GET /api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/flowexecutions/aggregates/query Query for flow execution aggregates #
POST /api/v2/analytics/flowexecutions/aggregates/jobs Query for flow execution aggregates asynchronously #
POST /api/v2/analytics/flows/aggregates/jobs Query for flow aggregates asynchronously #
GET /api/v2/analytics/flows/aggregates/jobs/{jobId} Get status for async query for Flow aggregates #
DELETE /api/v2/analytics/flows/aggregates/jobs/{jobId} Delete/cancel an async request for flow aggregates #
GET /api/v2/analytics/flows/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/flows/observations/query Query for flow observations #
POST /api/v2/analytics/flows/activity/query Query for flow activity observations #
POST /api/v2/analytics/flows/aggregates/query Query for flow aggregates #
POST /api/v2/analytics/journeys/aggregates/query Query for journey aggregates #
POST /api/v2/analytics/journeys/aggregates/jobs Query for journey aggregates asynchronously #
GET /api/v2/analytics/journeys/aggregates/jobs/{jobId} Get status for async query for journey aggregates #
DELETE /api/v2/analytics/journeys/aggregates/jobs/{jobId} Delete/cancel an async request for journey aggregates #
GET /api/v2/analytics/journeys/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/knowledge/aggregates/query Query for knowledge aggregates #
POST /api/v2/analytics/knowledge/aggregates/jobs Query for knowledge aggregates asynchronously #
GET /api/v2/analytics/knowledge/aggregates/jobs/{jobId} Get status for async query for knowledge aggregates #
DELETE /api/v2/analytics/knowledge/aggregates/jobs/{jobId} Delete/cancel an async request for knowledge aggregates #
GET /api/v2/analytics/knowledge/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/queues/observations/query Query for queue observations #
POST /api/v2/analytics/ratelimits/aggregates/query Query for limits rate limit aggregates. #
POST /api/v2/analytics/resolutions/aggregates/query Query for resolution aggregates #
POST /api/v2/analytics/resolutions/aggregates/jobs Query for resolution aggregates asynchronously #
GET /api/v2/analytics/resolutions/aggregates/jobs/{jobId} Get status for async query for resolution aggregates #
DELETE /api/v2/analytics/resolutions/aggregates/jobs/{jobId} Delete/cancel an async request for resolution aggregates #
GET /api/v2/analytics/resolutions/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/routing/activity/query Query for user activity observations #
POST /api/v2/analytics/summaries/aggregates/query Query for summary aggregates #
POST /api/v2/analytics/summaries/aggregates/jobs Query for summary aggregates asynchronously #
GET /api/v2/analytics/summaries/aggregates/jobs/{jobId} Get status for async query for summary aggregates #
DELETE /api/v2/analytics/summaries/aggregates/jobs/{jobId} Delete/cancel an async request for summary aggregates #
GET /api/v2/analytics/summaries/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/surveys/aggregates/query Query for survey aggregates #
POST /api/v2/analytics/surveys/aggregates/jobs Query for survey aggregates asynchronously #
GET /api/v2/analytics/surveys/aggregates/jobs/{jobId} Get status for async query for survey aggregates #
DELETE /api/v2/analytics/surveys/aggregates/jobs/{jobId} Delete/cancel an async request for survey aggregates #
GET /api/v2/analytics/surveys/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/taskmanagement/aggregates/query Query for task management aggregates #
GET /api/v2/analytics/taskmanagement/aggregates/jobs/{jobId} Get status for async query for task management aggregates #
DELETE /api/v2/analytics/taskmanagement/aggregates/jobs/{jobId} Delete/cancel an async request for task management aggregates #
GET /api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}/results Fetch a page of results for an async task management query #
POST /api/v2/analytics/taskmanagement/metrics/query Query for task management observations #
POST /api/v2/analytics/taskmanagement/aggregates/jobs Query for task management aggregates asynchronously #
POST /api/v2/analytics/teams/activity/query Query for team activity observations #
POST /api/v2/analytics/transcripts/aggregates/query Query for transcript aggregates #
POST /api/v2/analytics/transcripts/aggregates/jobs Query for transcript aggregates asynchronously #
GET /api/v2/analytics/transcripts/aggregates/jobs/{jobId} Get status for async query for transcript aggregates #
DELETE /api/v2/analytics/transcripts/aggregates/jobs/{jobId} Delete/cancel an async request for transcript aggregates #
GET /api/v2/analytics/transcripts/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/users/aggregates/query Query for user aggregates #
POST /api/v2/analytics/users/aggregates/jobs Query for user aggregates asynchronously #
GET /api/v2/analytics/users/aggregates/jobs/{jobId} Get status for async query for user aggregates #
DELETE /api/v2/analytics/users/aggregates/jobs/{jobId} Delete/cancel an async request for user aggregates #
GET /api/v2/analytics/users/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/users/details/query Query for user details #
POST /api/v2/analytics/users/observations/query Query for user observations #
POST /api/v2/analytics/users/activity/query Query for user activity observations #
POST /api/v2/analytics/users/details/jobs Query for user details asynchronously #
GET /api/v2/analytics/users/details/jobs/{jobId} Get status for async query for user details #
DELETE /api/v2/analytics/users/details/jobs/{jobId} Delete/cancel an async request #
GET /api/v2/analytics/users/details/jobs/{jobId}/results Fetch a page of results for an async query #
GET /api/v2/analytics/users/details/jobs/availability Lookup the datalake availability date and time #
GET /api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns Get Reporting Turns (division aware) #
GET /api/v2/analytics/botflows/{botFlowId}/reportingturns Get Reporting Turns #
GET /api/v2/analytics/botflows/{botFlowId}/sessions Get Bot Flow Sessions #
GET /api/v2/analytics/dataretention/settings Get analytics data retention setting #
PUT /api/v2/analytics/dataretention/settings Update analytics data retention setting #
GET /api/v2/analytics/reporting/settings Get AnalyticsReportingSettings for an organization #
PATCH /api/v2/analytics/reporting/settings Patch AnalyticsReportingSettings values for an organization #
POST /api/v2/analytics/reporting/settings/dashboards/bulk/remove Bulk soft delete dashboard configurations #
GET /api/v2/analytics/reporting/settings/dashboards/query Get list of dashboard configurations #
POST /api/v2/analytics/reporting/settings/dashboards/query Query dashboard configurations #
GET /api/v2/analytics/reporting/dashboards/users/{userId} Get dashboards summary for a user #
POST /api/v2/analytics/reporting/dashboards/users/bulk/remove Bulk soft delete dashboards owned by other user(s) #
GET /api/v2/analytics/reporting/dashboards/users Get dashboards summary for users in a org #
GET /api/v2/analytics/reporting/settings/users/{userId}/dashboards Get list of dashboards for an user #
GET /api/v2/analytics/reporting/exports/metadata Get all export metadata #
GET /api/v2/analytics/reporting/exports Get all view export requests for a user #
POST /api/v2/analytics/reporting/exports Generate a view export request #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/authentication/genesys-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-analytics-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/scopes/genesys-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/conventions/genesys-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/errors/genesys-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/data-model/genesys-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/agentic-access/genesys-agentic-access.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/genesys-analytics-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

genesys-analytics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Analytics API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
servers:
- url: https://api.mypurecloud.com
tags:


# --- truncated at 32 KB (1374 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-analytics-api-openapi.yml