Skip to main content
Operata API

The Operata Platform API provides access to all key data collected by Operata, in different levels of granularity.

Andy Scott avatar
Written by Andy Scott
Updated over a week ago

The data Operata collects and correlates can be accessed using the Operata API using a Simple API ‘GET’ request to https://api.operata.io/v1 using Basic Auth.

  • The username is the Group ID.

  • Password is the API token generated in the Settings/Config section of Operata.

All API requests can pull details for a specific time period by adding ?criteria={xxxxx}

Examples

?criteria={"fromTime":"xx","toTime":"xx","timezone":"Australia/Melbourne","from":0,"size":10}

?criteria={"agent":"Andy"}

Here's a link to the Operata Docs site with all the detail on how to access and use the API.

Various levels of detail can be extracted, here's some examples for an Amazon Connect service.

Contact Summary

https://api.operata.io/v1/data/calls

  • High-Level detail found in the ‘GET THE DETAILS’ dashboard

Complete Contact Record

https://api.operata.io/v1/data/calls/{callContactId}

  • Contact Flow Summary (UTC) - set attributes, queue, etc

  • Softphone Summary - Agent, location, network, browser, custom attributes, network performance measures, etc

  • Contact Trace Summary - Connected, on hold, etc

  • Softphone Events - Incoming, connected - to end

Detailed Contact Stats

https://api.operata.io/v1/data/calls/{callContactId}/details

  • Per Second network and MOS performance data

CCP logs

https://api.operata.io/v1/data/ccpLogs

  • CCP logs were collected.

Example

https://api.operata.io/v1/data/ccpLogs?criteria={"agent":"andy"}

Did this answer your question?