Skip to main content
GET
/
analytics
/
overview
Get Analytics Overview
curl --request GET \
  --url https://api.revring.ai/v1/analytics/overview \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "filters": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z",
      "tz": "<string>",
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "cards": {
      "totalCalls": {
        "label": "Total Calls",
        "value": 123
      },
      "totalCost": {
        "label": "Total Cost",
        "valueUsd": 123,
        "valueCents": 123
      },
      "averageDuration": {
        "label": "Average Duration",
        "valueSeconds": 123
      },
      "totalTransfers": {
        "label": "Total Transfers",
        "value": 123
      }
    },
    "series": [
      {
        "ts": "2023-11-07T05:31:56Z",
        "totalCalls": 123,
        "totalTransfers": 123,
        "averageDurationSeconds": 123,
        "billableSeconds": 123,
        "totalCostCents": 123,
        "totalCostUsd": 123
      }
    ],
    "activeCalls": 123
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard.

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