Get Dataset

get

https://core.{customerId}.ec.avayacloud.com/api/analytics/v2/datasets/{datasetName}

Returns paginated rows of historical contact center data for the specified dataset.

Getting Started

Base URL

All requests are made to:

https://core.{customerId}.ec.avayacloud.com/api/analytics

Replace {customerId} with your Avaya Infinity customer ID (the subdomain segment of your tenant URL).

Authentication

This API uses Bearer token authentication. Obtain a token via the OAuth 2.0 client credentials flow using your Client ID and Client Secret from the Avaya Infinity developer portal. Include the token in the Authorization header:

Authorization: Bearer <your_token>

For full authentication guidance, see the Avaya Infinity authentication docs.

Interval Format

The interval parameter is required. Its format depends on the datasetType value:

Interval dataset (datasetType=interval, default)

Use YYYYMMDDHHmm datetime values. Standard mm values are 00, 15, 30, and 45. Non-standard minute values (e.g., 0007) are silently accepted but may return empty results. Specify a range using starting and/or ending:

interval=starting:202502010415,ending:202502010445

Daily dataset (datasetType=daily)

Use YYYYMMDD datetime values. Non-zero HHmm suffixes are silently accepted but may return empty results:

interval=starting:20250201,ending:20250225

Important Notes

The interval parameter is required. Omitting it will return a 400 Bad Request.
Pagination is forward-only. The prevPageToken field is reserved for future use and currently always returns an empty string.
Not all column names are valid filter keys. For example, CHANNEL:phone is a valid filter, but AGENT_NAME:John* returns 400 Invalid filter column. See the filter parameter for details.
A 202 Accepted response indicates the request was valid but data has not yet been processed for the requested interval. Column headers will be returned but records will be empty. Retry after a short delay.
Pagination links.next URLs may contain unicode-escaped ampersands (\u0026). Consumers should handle unicode-escaped characters when parsing these URLs.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

datasetName

string

required

length between 1 and 50

The unique name of the dataset. Available datasets:

agent - Agent performance metrics
queue - Queue performance metrics
agentLoginSessions - Agent login session data
workflow - Workflow execution data
mpccdr - MPC CDR data
transcript - Interaction transcripts
clientSessions - Client session data
agentAux - Agent auxiliary/status data
interactionSegments - Interaction segments (requires Analytics Insights)
workflowTrace - Workflow trace data (requires Analytics Insights)
cxAgentLoginLogout - CX Agent login/logout events
agentByQueue - Agent performance metrics by queue
agentLoginLogoutByQueue - Agent login/logout events by queue

Query Params

pageSize

int32

1 to 200

Defaults to 20

The maximum number of results per page.

prevPageToken

string

length between 36 and 100

Reserved for future use. Backward pagination is not currently supported. Submitting this parameter has no effect. The response will always return an empty string for prevPageToken.

nextPageToken

string

length between 36 and 100

The page token of the next set of records to retrieve, represented as unique 36 characters(uuid).

interval

string

required

length between 8 and 41

Specify the interval range to be used.
Must contain either a single datetime value or both 'starting' and 'ending' datetimes. The datetime format is dependent on the datasetType param.

For daily dataset (datasetType = 'daily')

datetime implies specific day(s).
all datetime expressions should use YYYYMMDD format.
'HHmm' values should be either omitted or replaced with 0000. Non-standard values may return empty results.
Example values:
- starting:20250201
- ending:20250225
- starting:20250201,ending:20250225

For interval dataset (datasetType = 'interval')

all datetime expressions should use YYYYMMDDHHmm format.
'mm' part can be used to indicate the 15 min interval such as '00', '15', '30' or '45'. Non-standard values may return empty results.
- interval should be less than atleast 30 mins from the current interval.
Example values:
- starting:202502010415
- ending:202502251530
- starting:202502010415,ending:202502251545

datasetType

string

The type of dataset to be retrieved. The allowed values are:

daily
interval
The default value is 'interval'.
The datasetType param is used to determine the format of the interval param.

filter

string

length between 3 and 256

Specifies details of a row filter. The allowed format:

Begins with the column name to be filtered, followed by a colon, then:
Either an exact string to match, or
A string expression including the * wildcard character

Important: Not all column names are valid filter keys. Using an unsupported column name
returns 400 Invalid filter column. The following columns are known to be filterable:

CHANNEL — e.g., CHANNEL:phone
AGENT_ID — e.g., AGENT_ID:002d011106bf83ae15133ec0a7
QUEUE_ID — e.g., QUEUE_ID:003d0110243d0fd4d9c7f27dea
ACCOUNT_ID — e.g., ACCOUNT_ID:001d010917f6594b9a104630f7

Columns not listed above (e.g., AGENT_NAME) are not accepted as filter keys and will
return a 400 error. Contact Avaya support to confirm the full list of filterable columns
for a specific dataset.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses