Endpoints — Contact data
List contact summaries
Query a time window and get a page of contacts with headline agent, network, and call-quality metrics in the v1 format.
GET
Contact Summary
Returns a page of contact summaries for your Operata Group in the v1 format: agent location, network, machine load, call-quality metrics, and durations. Use it to list contacts in a time window, then fetch one in full with Get a contact summary. For the v2 data model, use List contact summaries (v2).
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.
Every
softphoneSummary field is always present. A field without a recorded value comes back as an empty string or 0. Inside operataBillingSummary and contactDurationSummary, the API omits fields whose value is 0.
The list leaves out contact flow, softphone events, the Contact Trace Record (CTR), and headset data. Get a contact summary returns those 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: the full v1 summary for one contact.
- Get detailed contact stats: per-second metrics for one contact.
- List contact summaries (v2): the same query in the v2 data model.
- Pagination: walk a result set with
fromandsize.