Skip to main content
GET
Get Analytics Overview

Authorizations

x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard. A key is either full access or read-only; a read-only key is refused with 403 read_only_key on any request that creates, changes or deletes.

Query Parameters

from
string<date-time>
required

Start date (ISO 8601)

to
string<date-time>
required

End date (ISO 8601)

agentId
string<uuid>

Filter by agent ID

tz
string
default:UTC

Timezone (IANA format)

bucket
enum<string>
default:auto

Time bucket granularity

Available options:
auto,
hour,
day,
month

Response

Analytics data

data
object
required