Endpoints — Contact data
List contact summaries (v2)
Query a time window and get a page of contacts in the v2 data model, with account, contact, agent, WebRTC session, headset, and billing objects.
GET
Contact Summary (v2)
Returns a page of contact summaries for your Operata Group in the v2 data model. Each contact carries account properties, contact details and events, the agent’s machine and network, WebRTC session metrics, headset data, and billing. Filters, paging, and sorting work exactly as in List contact summaries. Only the response format differs.
Endpoint
Parameters
Query
All parameters are optional. With none, you get the 100 most recent contacts.How filters apply
- Time window.
fromTimeandtoTimematch the contact summary’stimestamp, the time Operata recorded the contact. - Ranges. Each range filter takes both ends, as whole numbers. Both ends are inclusive, the upper end must be at least 1, and the lower end can’t exceed it. For example,
mosFrom=3&mosTo=4matches an average MOS from 3.0 to 4.0. - Text filters.
agent,networkType,agentCity,contactId,contactIds, andtagsuse an OpenSearch phrase match on the stored value. - Contact IDs. Only summaries with a contact ID come back.
- Sort. Without
sortColumn, results are newest first bytimestamp.
400 when a parameter is unknown, sent more than once (other than contactIds and tags), not a whole number where one is needed, out of range, or missing its pair. The response body names the parameter. Empty values, such as contactId=, count as not sent.
Response
200 OK with a JSON array of contacts. The array is empty when nothing matches.
The RecordCount response header holds the total number of matching contacts, not just this page. OpenSearch counts up to 10,000, so larger totals report 10000.
accountProperties, contact, serviceAgent, webRTCSession, and billing are always present. Inside them, most fields without a stored value come back as an empty string, 0, or false. These are omitted instead: every accountProperties field; contact.callerId, systemEndpoint, queueName, durationSec, type, direction, initiation, recordingUrl, events, endedBy, and disconnectReason; serviceAgent.friendlyName, serviceId, and machine; and webRTCSession.signallingEndpoint, eventTimer, eventFailure, and usedDevices. serviceAgent.browser comes back as null when not recorded.
The list never includes insights. Get a contact summary (v2) returns it for one contact.
Example
Fetch the contacts from a 48-hour window, 50 at a time.Errors
Error bodies are plain text.
See Errors for errors every endpoint can return.
Related
- Get a contact summary (v2): the v2 summary for one contact, including insights.
- Get detailed contact stats (v2): per-second metrics for one contact.
- List contact summaries: the same query in the v1 format.
- Versioning: how v1 and v2 differ.