Get detailed contact stats

Detailed Contact Stats

curl --request GET \
  --url https://api.operata.io/v1/data/calls/{contactId}/details \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.operata.io/v1/data/calls/{contactId}/details', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.operata.io/v1/data/calls/{contactId}/details"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.operata.io/v1/data/calls/{contactId}/details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

[
  {
    "agent": "agent_42",
    "contactId": "56f36f8c-463e-44fe-aff7-54ea7533cec1",
    "agentStatus": "Talk",
    "jitter": 2,
    "mos": 4.41,
    "packetsReceived": 50,
    "packetsSent": 50,
    "packetsLost": 0,
    "rtt": 32,
    "timestamp": "2020-06-16T01:15:40.123Z",
    "cpuAvailable": 69.93,
    "memoryAvailable": 41.2,
    "packetsLostFraction": 0,
    "outboundPacketsLost": 0,
    "outboundPacketsLostPercentage": 0,
    "inbound": {
      "packetsLost": 0,
      "packetsCount": 50,
      "audioLevel": 3168,
      "mos": 4.41,
      "jitterBufferMillis": 0
    },
    "outbound": {
      "packetsLost": 0,
      "packetsCount": 50,
      "audioLevel": 1064.75,
      "mos": 4.43,
      "jitterBufferMillis": 24
    }
  },
  {
    "agent": "agent_42",
    "contactId": "56f36f8c-463e-44fe-aff7-54ea7533cec1",
    "agentStatus": "Talk",
    "jitter": 2,
    "mos": 4.41,
    "packetsReceived": 50,
    "packetsSent": 50,
    "packetsLost": 0,
    "rtt": 32,
    "timestamp": "2020-06-16T01:15:41.123Z",
    "packetsLostFraction": 0,
    "outboundPacketsLost": 0,
    "outboundPacketsLostPercentage": 0,
    "inbound": {
      "packetsLost": 0,
      "packetsCount": 50,
      "audioLevel": 3168,
      "mos": 4.41,
      "jitterBufferMillis": 0
    },
    "outbound": {
      "packetsLost": 0,
      "packetsCount": 50,
      "audioLevel": 1064.75,
      "mos": 4.43,
      "jitterBufferMillis": 24
    }
  }
]

<string>

<string>

<string>

<string>

GET

data

calls

{contactId}

details

Detailed Contact Stats

curl --request GET \
  --url https://api.operata.io/v1/data/calls/{contactId}/details \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.operata.io/v1/data/calls/{contactId}/details', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.operata.io/v1/data/calls/{contactId}/details"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.operata.io/v1/data/calls/{contactId}/details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

[
  {
    "agent": "agent_42",
    "contactId": "56f36f8c-463e-44fe-aff7-54ea7533cec1",
    "agentStatus": "Talk",
    "jitter": 2,
    "mos": 4.41,
    "packetsReceived": 50,
    "packetsSent": 50,
    "packetsLost": 0,
    "rtt": 32,
    "timestamp": "2020-06-16T01:15:40.123Z",
    "cpuAvailable": 69.93,
    "memoryAvailable": 41.2,
    "packetsLostFraction": 0,
    "outboundPacketsLost": 0,
    "outboundPacketsLostPercentage": 0,
    "inbound": {
      "packetsLost": 0,
      "packetsCount": 50,
      "audioLevel": 3168,
      "mos": 4.41,
      "jitterBufferMillis": 0
    },
    "outbound": {
      "packetsLost": 0,
      "packetsCount": 50,
      "audioLevel": 1064.75,
      "mos": 4.43,
      "jitterBufferMillis": 24
    }
  },
  {
    "agent": "agent_42",
    "contactId": "56f36f8c-463e-44fe-aff7-54ea7533cec1",
    "agentStatus": "Talk",
    "jitter": 2,
    "mos": 4.41,
    "packetsReceived": 50,
    "packetsSent": 50,
    "packetsLost": 0,
    "rtt": 32,
    "timestamp": "2020-06-16T01:15:41.123Z",
    "packetsLostFraction": 0,
    "outboundPacketsLost": 0,
    "outboundPacketsLostPercentage": 0,
    "inbound": {
      "packetsLost": 0,
      "packetsCount": 50,
      "audioLevel": 3168,
      "mos": 4.41,
      "jitterBufferMillis": 0
    },
    "outbound": {
      "packetsLost": 0,
      "packetsCount": 50,
      "audioLevel": 1064.75,
      "mos": 4.43,
      "jitterBufferMillis": 24
    }
  }
]

<string>

<string>

<string>

<string>

Returns the per-second network trace for one contact: jitter, round-trip time (RTT), mean opinion score (MOS), packet counts, and agent status for each second. Use it to chart call quality across a contact. Find the contactId with List contact summaries. Get detailed contact stats (v2) returns the same response.

Endpoint

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

Parameters

Path

Name	Type	Required	Description
`contactId`	string	yes	Amazon Connect contact ID.

Response

200 OK with a JSON array of per-second rows for the contact. The RecordCount response header holds the number of rows. The array is empty when Operata has per-second files for the contact but they hold no rows for it. Rows aren’t sorted. Sort by timestamp if you need them in order.

[
  {
    "agent": "agent_42",
    "contactId": "56f36f8c-463e-44fe-aff7-54ea7533cec1",
    "agentStatus": "Talk",
    "jitter": 2,
    "mos": 4.41,
    "packetsReceived": 50,
    "packetsSent": 50,
    "packetsLost": 0,
    "rtt": 32,
    "timestamp": "2020-06-16T01:15:40.123Z",
    "cpuAvailable": 69.93,
    "memoryAvailable": 41.2,
    "packetsLostFraction": 0,
    "outboundPacketsLost": 0,
    "outboundPacketsLostPercentage": 0,
    "inbound": {
      "packetsLost": 0,
      "packetsCount": 50,
      "audioLevel": 3168,
      "mos": 4.41,
      "jitterBufferMillis": 0
    },
    "outbound": {
      "packetsLost": 0,
      "packetsCount": 50,
      "audioLevel": 1064.75,
      "mos": 4.43,
      "jitterBufferMillis": 24
    }
  },
  {
    "agent": "agent_42",
    "contactId": "56f36f8c-463e-44fe-aff7-54ea7533cec1",
    "agentStatus": "Talk",
    "jitter": 2,
    "mos": 4.41,
    "packetsReceived": 50,
    "packetsSent": 50,
    "packetsLost": 0,
    "rtt": 32,
    "timestamp": "2020-06-16T01:15:41.123Z",
    "packetsLostFraction": 0,
    "outboundPacketsLost": 0,
    "outboundPacketsLostPercentage": 0,
    "inbound": {
      "packetsLost": 0,
      "packetsCount": 50,
      "audioLevel": 3168,
      "mos": 4.41,
      "jitterBufferMillis": 0
    },
    "outbound": {
      "packetsLost": 0,
      "packetsCount": 50,
      "audioLevel": 1064.75,
      "mos": 4.43,
      "jitterBufferMillis": 24
    }
  }
]

Field	Type	Description
`agent`	string	Agent username.
`contactId`	string	Amazon Connect contact ID.
`agentStatus`	string	Agent state for this second, for example `Talk` or `Mute`.
`timestamp`	string	Time of the reading, in UTC.
`jitter`	number	Jitter, in milliseconds.
`rtt`	number	Round-trip time (RTT), in milliseconds.
`mos`	number	Mean opinion score (MOS). Omitted when `0`.
`packetsReceived`, `packetsSent`, `packetsLost`	number	Packet counts.
`packetsLostFraction`	number	Inbound packets-lost fraction.
`outboundPacketsLost`, `outboundPacketsLostPercentage`	number	Outbound packet loss as a count and a percentage.
`cpuAvailable`, `memoryAvailable`	number	Machine CPU and memory readings. Omitted when the Agent Collector had no reading.
`inbound`, `outbound`	object	Per-direction `packetsLost`, `packetsCount`, `audioLevel`, `mos`, and `jitterBufferMillis`.

Fields other than mos, cpuAvailable, and memoryAvailable are always present. A field without a stored value comes back as an empty string or 0.

Example

curl -u "$OPERATA_GROUP_ID:$OPERATA_API_TOKEN" \
  "https://api.operata.io/v1/data/calls/56f36f8c-463e-44fe-aff7-54ea7533cec1/details"

const groupId = process.env.OPERATA_GROUP_ID;
const apiToken = process.env.OPERATA_API_TOKEN;
const auth = Buffer.from(`${groupId}:${apiToken}`).toString("base64");

const contactId = "56f36f8c-463e-44fe-aff7-54ea7533cec1";
const response = await fetch(`https://api.operata.io/v1/data/calls/${contactId}/details`, {
  headers: { Authorization: `Basic ${auth}` },
});
const rows = (await response.json()).sort((a, b) => a.timestamp.localeCompare(b.timestamp));

import os, requests

contact_id = "56f36f8c-463e-44fe-aff7-54ea7533cec1"
response = requests.get(
    f"https://api.operata.io/v1/data/calls/{contact_id}/details",
    auth=(os.environ["OPERATA_GROUP_ID"], os.environ["OPERATA_API_TOKEN"]),
)
response.raise_for_status()
rows = sorted(response.json(), key=lambda row: row["timestamp"])

Errors

Error bodies are plain text.

Status	Body	When	Recover
401	An HTML `401 Authorization Required` page	Credentials are missing or wrong.	See Authentication.
404	`no matching records found`	Operata has no per-second data indexed for this contact ID.	Check the ID with List contact summaries.
400	Starts with `failed to decode OpenSearch response`	OpenSearch returned a response the API couldn’t read.	Retry later. Contact support if it persists.
500	Starts with `error retrieving call stats log` or `failed to read compressed json lines`	OpenSearch or the stored per-second files couldn’t be read.	Retry later. Contact support if it persists.

See Errors for errors every endpoint can return.

Get a contact summary: the whole-contact summary for the same contact.
List contact summaries: find contact IDs in a time window.
Get detailed contact stats (v2): the same data under the v2 path.

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

contactId

string

required

Amazon Connect contact ID.

Response

Per-second rows for the contact, unsorted. An empty array when the stored files hold no rows for it.

agent

string

contactId

string

agentStatus

string

jitter

number

mos

number

packetsReceived

number

packetsSent

number

packetsLost

number

rtt

number

timestamp

string

cpuAvailable

number

memoryAvailable

number

packetsLostFraction

number

outboundPacketsLost

number

outboundPacketsLostPercentage

number

inbound

object

Show child attributes

outbound

object

Show child attributes

Start here

API essentials

Endpoints — Contact data

Endpoints — Admin

Endpoints — Data redaction

Events and webhooks

Releases

Get detailed contact stats

Endpoint

Parameters

Path

Response

Example

Errors

Authorizations

Path Parameters

Response

​Endpoint

​Parameters

​Path

​Response

​Example

​Errors

​Related

Authorizations

Path Parameters

Response

Endpoint

Parameters

Path

Response

Example

Errors

Related