{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Analytics API", "version": "v2" }, "items": [ { "info": { "name": "Analytics", "type": "folder" }, "items": [ { "info": { "name": "Query for action aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/actions/aggregates/jobs" }, "docs": "Query for action aggregates asynchronously" }, { "info": { "name": "Get status for async query for action aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/actions/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for action aggregates" }, { "info": { "name": "Delete/cancel an async request for action aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/actions/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for action aggregates" }, { "info": { "name": "Query for action aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/actions/aggregates/query" }, "docs": "Query for action aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/actions/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for agent copilot aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/agentcopilots/aggregates/query" }, "docs": "Query for agent copilot aggregates" }, { "info": { "name": "Get an agent and their active sessions by user ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/agents/:userId/status", "params": [ { "name": "userId", "value": "", "type": "path", "description": "userId" } ] }, "docs": "Get an agent and their active sessions by user ID" }, { "info": { "name": "Count agents by different groupings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/agents/status/counts", "params": [ { "name": "groupBy", "value": "", "type": "query", "description": "Include to choose which groupings to count by and return. If not included it will return only counts grouped by segmentType" } ] }, "docs": "Count agents by different groupings" }, { "info": { "name": "Retrieve the top 50 agents matching the query filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/agents/status/query" }, "docs": "Retrieve the top 50 agents matching the query filters" }, { "info": { "name": "Query for bot aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/bots/aggregates/query" }, "docs": "Query for bot aggregates" }, { "info": { "name": "Query for bot aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/bots/aggregates/jobs" }, "docs": "Query for bot aggregates asynchronously" }, { "info": { "name": "Get status for async query for bot aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/bots/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for bot aggregates" }, { "info": { "name": "Delete/cancel an async request for bot aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/bots/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for bot aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/bots/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for case management aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/casemanagement/aggregates/query" }, "docs": "Query for case management aggregates" }, { "info": { "name": "Query for case management aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/casemanagement/aggregates/jobs" }, "docs": "Query for case management aggregates asynchronously" }, { "info": { "name": "Get status for async query for case management aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/casemanagement/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for case management aggregates" }, { "info": { "name": "Delete/cancel an async request for case management aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/casemanagement/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for case management aggregates" }, { "info": { "name": "Fetch a page of results for an async case management query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/casemanagement/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async case management query" }, { "info": { "name": "Query for conversation aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/conversations/aggregates/query" }, "docs": "Query for conversation aggregates" }, { "info": { "name": "Get a conversation by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/:conversationId/details", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Get a conversation by id" }, { "info": { "name": "Query for conversation aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/conversations/aggregates/jobs" }, "docs": "Query for conversation aggregates asynchronously" }, { "info": { "name": "Get status for async query for conversation aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for conversation aggregates" }, { "info": { "name": "Delete/cancel an async request for conversation aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/conversations/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for conversation aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for conversation activity observations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/conversations/activity/query", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The desired page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The desired page number" } ] }, "docs": "Query for conversation activity observations" }, { "info": { "name": "Query for conversation details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/conversations/details/query" }, "docs": "Query for conversation details" }, { "info": { "name": "Gets multiple conversations by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/details", "params": [ { "name": "id", "value": "", "type": "query", "description": "Comma-separated conversation ids" } ] }, "docs": "Gets multiple conversations by id" }, { "info": { "name": "Index conversation properties", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/conversations/:conversationId/details/properties", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Index conversation properties" }, { "info": { "name": "Query for conversation details asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/conversations/details/jobs" }, "docs": "Query for conversation details asynchronously" }, { "info": { "name": "Get status for async query for conversation details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/details/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for conversation details" }, { "info": { "name": "Delete/cancel an async details job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/conversations/details/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async details job" }, { "info": { "name": "Fetch a page of results for an async details job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/details/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page)" }, { "name": "pageSize", "value": "", "type": "query", "description": "The desired maximum number of results" } ] }, "docs": "Fetch a page of results for an async details job" }, { "info": { "name": "Lookup the datalake availability date and time", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/conversations/details/jobs/availability" }, "docs": "Lookup the datalake availability date and time" }, { "info": { "name": "Query for evaluation aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/evaluations/aggregates/query" }, "docs": "Query for evaluation aggregates" }, { "info": { "name": "Query for evaluation aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/evaluations/aggregates/jobs" }, "docs": "Query for evaluation aggregates asynchronously" }, { "info": { "name": "Get status for async query for evaluation aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/evaluations/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for evaluation aggregates" }, { "info": { "name": "Delete/cancel an async request for evaluation aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/evaluations/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for evaluation aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/evaluations/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Get status for async query for flow execution aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/flowexecutions/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for flow execution aggregates" }, { "info": { "name": "Delete/cancel an async request for flow execution aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/flowexecutions/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for flow execution aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/flowexecutions/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for flow execution aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/flowexecutions/aggregates/query" }, "docs": "Query for flow execution aggregates" }, { "info": { "name": "Query for flow execution aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/flowexecutions/aggregates/jobs" }, "docs": "Query for flow execution aggregates asynchronously" }, { "info": { "name": "Query for flow aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/flows/aggregates/jobs" }, "docs": "Query for flow aggregates asynchronously" }, { "info": { "name": "Get status for async query for Flow aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/flows/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for Flow aggregates" }, { "info": { "name": "Delete/cancel an async request for flow aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/flows/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for flow aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/flows/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for flow observations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/flows/observations/query" }, "docs": "Query for flow observations" }, { "info": { "name": "Query for flow activity observations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/flows/activity/query", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The desired page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The desired page number" } ] }, "docs": "Query for flow activity observations" }, { "info": { "name": "Query for flow aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/flows/aggregates/query" }, "docs": "Query for flow aggregates" }, { "info": { "name": "Query for journey aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/journeys/aggregates/query" }, "docs": "Query for journey aggregates" }, { "info": { "name": "Query for journey aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/journeys/aggregates/jobs" }, "docs": "Query for journey aggregates asynchronously" }, { "info": { "name": "Get status for async query for journey aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/journeys/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for journey aggregates" }, { "info": { "name": "Delete/cancel an async request for journey aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/journeys/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for journey aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/journeys/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for knowledge aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/knowledge/aggregates/query" }, "docs": "Query for knowledge aggregates" }, { "info": { "name": "Query for knowledge aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/knowledge/aggregates/jobs" }, "docs": "Query for knowledge aggregates asynchronously" }, { "info": { "name": "Get status for async query for knowledge aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/knowledge/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for knowledge aggregates" }, { "info": { "name": "Delete/cancel an async request for knowledge aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/knowledge/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for knowledge aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/knowledge/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for queue observations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/queues/observations/query" }, "docs": "Query for queue observations" }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/ratelimits/aggregates/query" }, "docs": "The 'max' property can be used to determine estimated rate limit value hit. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled)." }, { "info": { "name": "Query for resolution aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/resolutions/aggregates/query" }, "docs": "Query for resolution aggregates" }, { "info": { "name": "Query for resolution aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/resolutions/aggregates/jobs" }, "docs": "Query for resolution aggregates asynchronously" }, { "info": { "name": "Get status for async query for resolution aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/resolutions/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for resolution aggregates" }, { "info": { "name": "Delete/cancel an async request for resolution aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/resolutions/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for resolution aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/resolutions/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for user activity observations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/routing/activity/query", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The desired page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The desired page number" } ] }, "docs": "Query for user activity observations" }, { "info": { "name": "Query for summary aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/summaries/aggregates/query" }, "docs": "Query for summary aggregates" }, { "info": { "name": "Query for summary aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/summaries/aggregates/jobs" }, "docs": "Query for summary aggregates asynchronously" }, { "info": { "name": "Get status for async query for summary aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/summaries/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for summary aggregates" }, { "info": { "name": "Delete/cancel an async request for summary aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/summaries/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for summary aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/summaries/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for survey aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/surveys/aggregates/query" }, "docs": "Query for survey aggregates" }, { "info": { "name": "Query for survey aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/surveys/aggregates/jobs" }, "docs": "Query for survey aggregates asynchronously" }, { "info": { "name": "Get status for async query for survey aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/surveys/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for survey aggregates" }, { "info": { "name": "Delete/cancel an async request for survey aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/surveys/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for survey aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/surveys/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for task management aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/taskmanagement/aggregates/query" }, "docs": "Query for task management aggregates" }, { "info": { "name": "Get status for async query for task management aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/taskmanagement/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for task management aggregates" }, { "info": { "name": "Delete/cancel an async request for task management aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/taskmanagement/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for task management aggregates" }, { "info": { "name": "Fetch a page of results for an async task management query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/taskmanagement/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async task management query" }, { "info": { "name": "Query for task management observations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/taskmanagement/metrics/query", "params": [ { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned. Used for pagination." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200." } ] }, "docs": "Query for task management observations" }, { "info": { "name": "Query for task management aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/taskmanagement/aggregates/jobs" }, "docs": "Query for task management aggregates asynchronously" }, { "info": { "name": "Query for team activity observations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/teams/activity/query", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The desired page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The desired page number" } ] }, "docs": "Query for team activity observations" }, { "info": { "name": "Query for transcript aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/transcripts/aggregates/query" }, "docs": "Query for transcript aggregates" }, { "info": { "name": "Query for transcript aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/transcripts/aggregates/jobs" }, "docs": "Query for transcript aggregates asynchronously" }, { "info": { "name": "Get status for async query for transcript aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/transcripts/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for transcript aggregates" }, { "info": { "name": "Delete/cancel an async request for transcript aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/transcripts/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for transcript aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/transcripts/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for user aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/users/aggregates/query" }, "docs": "Query for user aggregates" }, { "info": { "name": "Query for user aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/users/aggregates/jobs" }, "docs": "Query for user aggregates asynchronously" }, { "info": { "name": "Get status for async query for user aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/users/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for user aggregates" }, { "info": { "name": "Delete/cancel an async request for user aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/users/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for user aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/users/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for user details", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/users/details/query" }, "docs": "Query for user details" }, { "info": { "name": "Query for user observations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/users/observations/query" }, "docs": "Query for user observations" }, { "info": { "name": "Query for user activity observations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/users/activity/query", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The desired page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The desired page number" } ] }, "docs": "Query for user activity observations" }, { "info": { "name": "Query for user details asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/users/details/jobs" }, "docs": "Query for user details asynchronously" }, { "info": { "name": "Get status for async query for user details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/users/details/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for user details" }, { "info": { "name": "Delete/cancel an async request", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/users/details/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request" }, { "info": { "name": "Fetch a page of results for an async query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/users/details/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page)" }, { "name": "pageSize", "value": "", "type": "query", "description": "The desired maximum number of results" } ] }, "docs": "Fetch a page of results for an async query" }, { "info": { "name": "Lookup the datalake availability date and time", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/users/details/jobs/availability" }, "docs": "Lookup the datalake availability date and time" }, { "info": { "name": "Get Reporting Turns (division aware).", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/botflows/:botFlowId/divisions/reportingturns", "params": [ { "name": "botFlowId", "value": "", "type": "path", "description": "ID of the bot flow." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the ID of the last item in the list of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Max number of entities to return. Maximum of 250" }, { "name": "interval", "value": "", "type": "query", "description": "Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, { "name": "actionId", "value": "", "type": "query", "description": "Optional action ID to get the reporting turns associated to a particular flow action" }, { "name": "sessionId", "value": "", "type": "query", "description": "Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed." }, { "name": "language", "value": "", "type": "query", "description": "Optional language code to get the reporting turns for a particular language" }, { "name": "askActionResults", "value": "", "type": "query", "description": "Optional case-insensitive comma separated list of ask action results to filter the reporting turns." } ] }, "docs": "Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items ha" }, { "info": { "name": "Get Reporting Turns.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/botflows/:botFlowId/reportingturns", "params": [ { "name": "botFlowId", "value": "", "type": "path", "description": "ID of the bot flow." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the ID of the last item in the list of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Max number of entities to return. Maximum of 250" }, { "name": "interval", "value": "", "type": "query", "description": "Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, { "name": "actionId", "value": "", "type": "query", "description": "Optional action ID to get the reporting turns associated to a particular flow action" }, { "name": "sessionId", "value": "", "type": "query", "description": "Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed." }, { "name": "language", "value": "", "type": "query", "description": "Optional language code to get the reporting turns for a particular language" }, { "name": "askActionResults", "value": "", "type": "query", "description": "Optional case-insensitive comma separated list of ask action results to filter the reporting turns." } ] }, "docs": "Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer prese" }, { "info": { "name": "Get Bot Flow Sessions.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/botflows/:botFlowId/sessions", "params": [ { "name": "botFlowId", "value": "", "type": "path", "description": "ID of the bot flow." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the ID of the last item in the list of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Max number of entities to return. Maximum of 250" }, { "name": "interval", "value": "", "type": "query", "description": "Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, { "name": "botResultCategories", "value": "", "type": "query", "description": "Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by." }, { "name": "endLanguage", "value": "", "type": "query", "description": "Optional case-insensitive language code to filter sessions by the language the sessions ended in." } ] }, "docs": "Returns the bot flow sessions in reverse chronological order from the date they were created. It is expected that the client will URL encode the request URI once only. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. The 'nextUri' value in the response is already URL encoded (so it doesn't need to be encoded again). Note: resources returned by this endpoint are not persist" }, { "info": { "name": "Get analytics data retention setting", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/dataretention/settings" }, "docs": "Get analytics data retention setting" }, { "info": { "name": "Update analytics data retention setting", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/analytics/dataretention/settings" }, "docs": "Update analytics data retention setting" }, { "info": { "name": "Get AnalyticsReportingSettings for an organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/reporting/settings" }, "docs": "Get AnalyticsReportingSettings for an organization" }, { "info": { "name": "Patch AnalyticsReportingSettings values for an organization", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/analytics/reporting/settings" }, "docs": "Patch AnalyticsReportingSettings values for an organization" }, { "info": { "name": "Bulk soft delete dashboard configurations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/reporting/settings/dashboards/bulk/remove" }, "docs": "Bulk soft delete dashboard configurations" }, { "info": { "name": "Get list of dashboard configurations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/reporting/settings/dashboards/query", "params": [ { "name": "name", "value": "", "type": "query", "description": "name of the dashboard" }, { "name": "dashboardType", "value": "", "type": "query", "description": "List dashboard of given type" }, { "name": "dashboardState", "value": "", "type": "query", "description": "List dashboard of given state" }, { "name": "dashboardAccessFilter", "value": "", "type": "query", "description": "Filter dashboard based on the owner of dashboard" }, { "name": "sortBy", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" } ] }, "docs": "Get list of dashboard configurations" }, { "info": { "name": "Query dashboard configurations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/reporting/settings/dashboards/query" }, "docs": "Query dashboard configurations" }, { "info": { "name": "Get dashboards summary for a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/reporting/dashboards/users/:userId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Get dashboards summary for a user" }, { "info": { "name": "Bulk soft delete dashboards owned by other user(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/reporting/dashboards/users/bulk/remove" }, "docs": "Bulk soft delete dashboards owned by other user(s)" }, { "info": { "name": "Get dashboards summary for users in a org", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/reporting/dashboards/users", "params": [ { "name": "sortBy", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query", "description": "A list of user IDs to fetch by bulk" }, { "name": "state", "value": "", "type": "query", "description": "Only list users of this state" }, { "name": "deletedOnly", "value": "", "type": "query", "description": "Only list users with deleted dashboards" } ] }, "docs": "Get dashboards summary for users in a org" }, { "info": { "name": "Get list of dashboards for an user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/reporting/settings/users/:userId/dashboards", "params": [ { "name": "userId", "value": "", "type": "path", "description": "User ID" }, { "name": "sortBy", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "publicOnly", "value": "", "type": "query", "description": "If true, retrieve only public dashboards" }, { "name": "favoriteOnly", "value": "", "type": "query", "description": "If true, retrieve only favorite dashboards" }, { "name": "deletedOnly", "value": "", "type": "query", "description": "If true, retrieve only deleted dashboards that are still recoverable" }, { "name": "name", "value": "", "type": "query", "description": "retrieve dashboards that match with given name" } ] }, "docs": "Get list of dashboards for an user" }, { "info": { "name": "Get all export metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/reporting/exports/metadata" }, "docs": "Get all export metadata" }, { "info": { "name": "Get all view export requests for a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/reporting/exports", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Get all view export requests for a user" }, { "info": { "name": "Generate a view export request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/reporting/exports" }, "docs": "This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead" } ] } ], "bundled": true }