NiCE Platform Analytics API
The Platform Analytics API from NiCE — 1 operation(s) for platform analytics.
The Platform Analytics API from NiCE — 1 operation(s) for platform analytics.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/nice:nice-platform-analytics-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Nice Platform Analytics API
version: '1.0'
description: 'Operations tagged Platform Analytics across 2 of this provider''s published API definitions: nice-platform-analytics.json, nice-platform-analytics-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Platform Analytics
paths:
/platform-analytics/v1/segments:
get:
summary: List segment IDs by date range
description: 'Returns a paginated list of segment IDs for the authenticated tenant, filtered by segment start time. Use startTimeFrom and startTimeTo to define the query window. Two limits apply: only the most recent 90 days are queryable (startTimeFrom cannot be earlier than 90 days ago), and the window between startTimeFrom and startTimeTo cannot exceed 90 days. Iterate through pages using the pageToken cursor returned in each response.'
operationId: get-segments
tags:
- Platform Analytics
parameters:
- name: startTimeFrom
in: query
required: true
schema:
type: string
format: date-time
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
description: 'ISO 8601 UTC datetime with a trailing ''Z'' (inclusive ≥), e.g. 2026-05-01T00:00:00Z.
Numeric offsets such as +02:00 are not accepted. Returns segments that started at or after this time.
Maximum lookback is 90 days from now.
'
example: '2026-05-01T00:00:00Z'
- name: startTimeTo
in: query
required: false
schema:
type: string
format: date-time
pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$
description: 'ISO 8601 UTC datetime with a trailing ''Z'' (inclusive ≤), e.g. 2026-05-25T23:59:59Z.
Numeric offsets such as +02:00 are not accepted.
If omitted, defaults to current time.
Range (startTimeTo - startTimeFrom) must not exceed 90 days.
'
example: '2026-05-25T23:59:59Z'
- name: top
in: query
required: false
schema:
type: integer
default: 100
minimum: 1
maximum: 1000
description: 'Page size (number of segments per page).
Default: 100. Maximum: 1000.
'
example: 100
- name: pageToken
in: query
required: false
schema:
type: string
description: 'Opaque pagination cursor from the previous response''s `nextPageToken`.
Omit for the first page. Include for subsequent pages to continue pagination.
'
example: eyJsYXN0RXZhbHVhdGVkS2V5IjoiZm9vIn0=
- name: tenantId
in: header
required: false
schema:
type: string
format: uuid
description: 'Tenant UUID. Required when authenticating with a service token that is not scoped to a specific tenant.
If the service token is scoped to a specific tenant, this header is optional; if provided it must match the token''s tenant (case-insensitive) — a mismatch returns 403.
User tokens have the tenant ID embedded in the token and ignore this header entirely.
'
example: d290f1ee-6c54-4b01-90e6-d701748f0851
responses:
'200':
description: Paginated list of segment IDs matching the requested date range.
content:
application/json:
schema:
$ref: '#/components/schemas/SegmentsResponse'
examples:
first-page:
summary: First page of results
value:
nextPageToken: eyJsYXN0RXZhbHVhdGVkS2V5IjoiZm9vIn0=
data:
- segmentId: 4c22f7f8-c404-4587-912a-ccd9d4b5f3bf
- segmentId: 3c62f8ed-55ad-49d4-aeb6-57d7c883da67
- segmentId: e7a91bc3-2f8d-4e6a-b523-1d9f4c8e7a02
last-page:
summary: Last page of results (no nextPageToken)
value:
nextPageToken: null
data:
- segmentId: 8f1b3e5a-7d2c-4f9e-b6a1-2e4c7d9a3b8f
'400':
description: The request contains an invalid or missing parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
message: 'Invalid parameter: startTimeFrom'
path: /platform-analytics/v1/segments
status: 400
'401':
description: Authentication is required or the provided token is invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
message: Unauthorized
path: /platform-analytics/v1/segments
status: 401
'403':
description: The service token is scoped to a specific tenant and the `tenantId` header was provided but does not match it.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
message: Forbidden
path: /platform-analytics/v1/segments
status: 403
'429':
description: Too many requests. Retry after the duration specified in the Retry-After header.
headers:
Retry-After:
schema:
type: integer
description: Number of seconds to wait before retrying
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
message: Rate limit exceeded
path: /platform-analytics/v1/segments
status: 429
'500':
description: A system error occurred. Retry with exponential backoff.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
message: A system error occurred. Try again. If the problem continues, contact CXone Support.
path: /platform-analytics/v1/segments
status: 500
security:
- bearerAuth: []
components:
schemas:
SegmentItem:
type: object
required:
- segmentId
properties:
segmentId:
type: string
description: Unique segment identifier (UUID)
example: 4c22f7f8-c404-4587-912a-ccd9d4b5f3bf
ErrorResponse:
type: object
required:
- status
properties:
message:
type: string
description: Error message
example: Invalid request
path:
type: string
description: Request path that produced the error
example: /platform-analytics/v1/segments
status:
type: integer
description: HTTP status code
example: 400
SegmentsResponse:
type: object
required:
- data
properties:
nextPageToken:
type:
- string
- 'null'
description: 'Pagination cursor for the next page of results.
Null if this is the last page.
Pass this value as the `pageToken` query parameter for the next request.
'
example: eyJsYXN0RXZhbHVhdGVkS2V5IjoiZm9vIn0=
data:
type: array
items:
$ref: '#/components/schemas/SegmentItem'
description: Array of segment ID objects
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: 'JWT token issued by CXone auth service.
User tokens carry RBAC fields (teams, skills, divisions) which filter segments.
Service tokens carry no RBAC and receive all segments for the tenant.
'
x-refined-from:
- nice-platform-analytics.json
- nice-platform-analytics-openapi.yml