Query CCP logs

CCP Logs

curl --request GET \
  --url https://api.operata.io/v1/data/ccpLogs \
  --header 'Authorization: Basic <encoded-value>'

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

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

package main

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

func main() {

	url := "https://api.operata.io/v1/data/ccpLogs"

	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",
    "component": "ccp",
    "exception": null,
    "level": "TRACE",
    "line": 0,
    "loggerId": "1747526402159-lbngq11trj",
    "objects": [
      {
        "nextToken": null,
        "permissions": [
          "outboundCall"
        ]
      }
    ],
    "text": "AWSClient: <-- Operation 'getAgentPermissions' succeeded.",
    "time": "2026-05-18T00:01:02.577Z"
  }
]

<string>

<string>

<string>

<string>

GET

data

ccpLogs

CCP Logs

curl --request GET \
  --url https://api.operata.io/v1/data/ccpLogs \
  --header 'Authorization: Basic <encoded-value>'

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

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

package main

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

func main() {

	url := "https://api.operata.io/v1/data/ccpLogs"

	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",
    "component": "ccp",
    "exception": null,
    "level": "TRACE",
    "line": 0,
    "loggerId": "1747526402159-lbngq11trj",
    "objects": [
      {
        "nextToken": null,
        "permissions": [
          "outboundCall"
        ]
      }
    ],
    "text": "AWSClient: <-- Operation 'getAgentPermissions' succeeded.",
    "time": "2026-05-18T00:01:02.577Z"
  }
]

<string>

<string>

<string>

<string>

Returns raw Contact Control Panel (CCP) log entries that the Agent Collector forwarded to Operata. Use it to inspect agent-side errors, softphone state transitions, and timing for a single agent across a time window.

Endpoint

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

Parameters

Query

Name	Type	Required	Description
`criteria`	string (JSON)	yes	URL-encoded JSON object holding the filters below. Send `{}` for no filters.

`criteria` field	Type	Description
`agent`	string	Agent username to match.
`level`	string	Log level to match, for example `ERROR`.
`fromTime`, `toTime`	string	Time window on the entry’s `time`, both ends inclusive. Accepts ISO 8601 timestamps or OpenSearch date math such as `now-5d`. Applied only when both are set.
`timezone`	string	Time zone OpenSearch applies to the window. Used only with `fromTime` and `toTime`.
`size`	integer	Entries to return. Default `100`.
`from`	integer	Entries to skip, for paging. Default `0`.

The API ignores fields it doesn’t recognize. The criteria value is a JSON object passed as a single query-string parameter. For example, {"agent":"agent_42","fromTime":"2026-05-18T00:00:00Z","toTime":"2026-05-18T01:00:00Z"} becomes

criteria=%7B%22agent%22%3A%22agent_42%22%2C%22fromTime%22%3A%222026-05-18T00%3A00%3A00Z%22%2C%22toTime%22%3A%222026-05-18T01%3A00%3A00Z%22%7D

Response

200 OK with a JSON array of CCP log entries, newest first by time. The array is empty when nothing matches. The RecordCount response header holds the total number of matching entries; OpenSearch counts up to 10,000, so larger totals report 10000. The API returns each entry exactly as the Agent Collector stored it, so the fields can vary between entries. This example shows a typical entry.

[
  {
    "agent": "agent_42",
    "component": "ccp",
    "exception": null,
    "level": "TRACE",
    "line": 0,
    "loggerId": "1747526402159-lbngq11trj",
    "objects": [
      { "nextToken": null, "permissions": ["outboundCall"] }
    ],
    "text": "AWSClient: <-- Operation 'getAgentPermissions' succeeded.",
    "time": "2026-05-18T00:01:02.577Z"
  }
]

Field	Type	Description
`agent`	string	Agent username the log entry came from.
`component`	string	CCP subsystem that emitted the entry. Typical values: `ccp`, `softphone`.
`level`	string	Log level: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`.
`exception`	string \| null	Stack or exception text when the entry is an error. `null` otherwise.
`loggerId`	string	The CCP logger instance that emitted the entry.
`objects`	array	Structured payload the CCP attached to the entry, when present.
`text`	string	Human-readable log message.
`time`	string (ISO 8601)	UTC timestamp the entry was emitted.

CCP log capture requires the Agent Collector to be running in the agent’s browser. Entries from a session in progress may not appear until that session ends.

Example

CRITERIA='{"agent":"agent_42","fromTime":"2026-05-18T00:00:00Z","toTime":"2026-05-18T01:00:00Z"}'
curl -u "$OPERATA_GROUP_ID:$OPERATA_API_TOKEN" \
  --get "https://api.operata.io/v1/data/ccpLogs" \
  --data-urlencode "criteria=$CRITERIA"

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

const criteria = JSON.stringify({
  agent: "agent_42",
  fromTime: "2026-05-18T00:00:00Z",
  toTime: "2026-05-18T01:00:00Z",
});

const url = new URL("https://api.operata.io/v1/data/ccpLogs");
url.searchParams.set("criteria", criteria);

const response = await fetch(url, {
  headers: { Authorization: `Basic ${auth}` },
});
const entries = await response.json();

import json, os, requests

criteria = json.dumps({
    "agent": "agent_42",
    "fromTime": "2026-05-18T00:00:00Z",
    "toTime": "2026-05-18T01:00:00Z",
})

response = requests.get(
    "https://api.operata.io/v1/data/ccpLogs",
    auth=(os.environ["OPERATA_GROUP_ID"], os.environ["OPERATA_API_TOKEN"]),
    params={"criteria": criteria},
)
response.raise_for_status()
entries = response.json()

Errors

Error bodies are plain text.

Status	Body	When	Recover
400	`Invalid search criteria`	`criteria` is missing or isn’t valid JSON.	Send a URL-encoded JSON object, even if it’s `{}`.
401	An HTML `401 Authorization Required` page	Credentials are missing or wrong.	See Authentication.
422	`An error occurred while retrieving agent CCP logs`	OpenSearch rejected or failed the query, for example on malformed date math in `fromTime`.	Fix `criteria`, or retry later if it persists.
500	`An error occurred parsing agent CCP logs response from ES`	OpenSearch returned a response the API couldn’t read.	Retry later. Contact support if it persists.

See Errors for errors every endpoint can return.

Get a contact summary — fetch the full record for a contact ID surfaced in the logs.
List contact summaries — find contacts handled by the same agent.
CCP error logs — field reference for CCP error entries.
CCP agent states — agent state values referenced in log entries.
Errors — shared status codes and recovery patterns.

Authorizations

Authorization

string

header

required

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

Query Parameters

criteria

string

required

URL-encoded JSON object. Fields: agent, level, fromTime, toTime, timezone, size (default 100), from (default 0).

Response

Stored log entries, newest first. An empty array when nothing matches.

Start here

API essentials

Endpoints — Contact data

Endpoints — Admin

Endpoints — Data redaction

Events and webhooks

Releases

Endpoint

Parameters

Query

Response

Example

Errors

Authorizations

Query Parameters

Response

​Endpoint

​Parameters

​Query

​Response

​Example

​Errors

​Related

Authorizations

Query Parameters

Response

Endpoint

Parameters

Query

Response

Example

Errors

Related