Versioning

Operata versions the API by URL prefix. Contact data is available under both /v1/ and /v2/. The two versions take the same requests and return different data models.

Endpoint

https://api.operata.io/v1/...
https://api.operata.io/v2/...

Parameters

There’s no version header. The version lives in the path, so pin your client to the prefix you tested against.

Endpoint	v1	v2
List contact summaries	`GET /v1/data/calls`	`GET /v2/data/calls`
Get a contact summary	`GET /v1/data/calls/{contactId}`	`GET /v2/data/calls/{contactId}`
Get detailed contact stats	`GET /v1/data/calls/{contactId}/details`	`GET /v2/data/calls/{contactId}/details`
CCP logs	`GET /v1/data/ccpLogs`	None
Data redaction config	`/v1/config/...`	None
Configured users	None	`GET /v2/admin/users`

Response

v1 and v2 differ only in the shape of the contact summary:

	v1	v2
Summary objects	`softphoneSummary`, `operataBillingSummary`, `contactDurationSummary`, `tags`	`accountProperties`, `contact`, `serviceAgent`, `webRTCSession`, `headset`, `billing`
Single contact adds	Contact flow, softphone events, the stored Contact Trace Record (CTR), Jabra headset data	`insights`
Jitter and RTT	Whole numbers	Decimals
Field reference	Endpoint pages	Account properties, Contact, Agent, WebRTC session

Query parameters, paging, sorting, and error responses are identical. Detailed contact stats return the same response under both prefixes. Pick v2 for new integrations that want the account, agent, and WebRTC session model. Stay on v1 if you depend on the CTR or contact flow in the single-contact response. The change policy:

Additive changes ship in place. New optional fields on responses, new optional query parameters, and new endpoints under an existing version. Your client keeps working without changes.
Breaking changes ship under a new prefix. Renamed or removed fields, changed types, and new required parameters go to the next version.
Deprecations are announced in the API changelog.

Example

The same query against both versions:

curl -u "$OPERATA_GROUP_ID:$OPERATA_API_TOKEN" \
  "https://api.operata.io/v1/data/calls?fromTime=now-1d&toTime=now&size=1"

curl -u "$OPERATA_GROUP_ID:$OPERATA_API_TOKEN" \
  "https://api.operata.io/v2/data/calls?fromTime=now-1d&toTime=now&size=1"

Errors

A path under a prefix with no matching endpoint, such as /v2/data/ccpLogs, returns 404. See Errors for the rest.

Start here

API essentials

Endpoints — Contact data

Endpoints — Admin

Endpoints — Data redaction

Events and webhooks

Releases

Endpoint

Parameters

Response

Example

Errors

​Endpoint

​Parameters

​Response

​Example

​Errors

Endpoint

Parameters

Response

Example

Errors