Get credit and call usage

GET/usage

Credits used, calls placed, calls answered and time on the line over a period, point by point and per assistant and campaign, compared with the period just before. Also returns the balance now and the date it runs out at the recent pace.

Request

curl -X GET "https://www.getrevox.com/api/usage" \
  -H "Authorization: Bearer $REVOX_API_KEY"

const res = await fetch("https://www.getrevox.com/api/usage", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.REVOX_API_KEY}`,
  },
});
const data = await res.json();
console.log(data);

import os

import requests

response = requests.get(
    "https://www.getrevox.com/api/usage",
    headers={"Authorization": f"Bearer {os.environ['REVOX_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

Try itSend this request live

Response

Success

{
  "period": {
    "from": "from",
    "to": "to",
    "granularity": "hour",
    "timezone": "Europe/Paris"
  },
  "previous_period": { "from": "from", "to": "to" },
  "totals": {
    "credits_used": 1,
    "amount_cents": 1,
    "calls": 1,
    "connected_calls": 1,
    "talk_seconds": 98,
    "credits_by_kind": {
      "reached": 1,
      "not_reached": 1,
      "inbound": 1,
      "per_minute": 1
    },
    "credits_added": 1
  },
  "previous_totals": {
    "credits_used": 1,
    "amount_cents": 1,
    "calls": 1,
    "connected_calls": 1,
    "talk_seconds": 98,
    "credits_by_kind": {
      "reached": 1,
      "not_reached": 1,
      "inbound": 1,
      "per_minute": 1
    },
    "credits_added": 1
  },
  "series": [
    {
      "credits_used": 1,
      "amount_cents": 1,
      "calls": 1,
      "connected_calls": 1,
      "talk_seconds": 98,
      "credits_by_kind": {
        "reached": 1,
        "not_reached": 1,
        "inbound": 1,
        "per_minute": 1
      },
      "start": "start"
    }
  ],
  "by_assistant": [
    {
      "assistant_id": "3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e34",
      "name": "Appointment reminder",
      "credits_used": 1,
      "amount_cents": 1,
      "calls": 1,
      "connected_calls": 1,
      "talk_seconds": 98
    }
  ],
  "by_campaign": [
    {
      "campaign_id": "9b2d7e41-6c3f-4a8e-b5d0-2f7a1c9e4b63",
      "name": "Appointment reminder",
      "credits_used": 1,
      "amount_cents": 1,
      "calls": 1,
      "connected_calls": 1,
      "talk_seconds": 98
    }
  ],
  "balance": {
    "credits": 1,
    "plan": "starter",
    "plan_monthly_credits": 1,
    "next_expiry": {
      "credits": 1,
      "expires_at": "2026-11-05T09:00:00Z"
    },
    "daily_average_credits": 1,
    "depletion_date": "2026-11-02"
  }
}

{
  "message": "Request validation failed",
  "bodyErrors": {
    "issues": [
      {
        "path": ["phone_number"],
        "message": "Invalid input: expected string, received undefined",
        "code": "invalid_type"
      }
    ]
  }
}

{ "error": "Unauthorized, invalid API key" }

Query parameters

fromstring (date-time)
Start of the period, ISO 8601 (e.g. 2026-11-01T00:00:00+01:00). Default: the start of the current month in timezone.
tostring (date-time)
End of the period, excluded, ISO 8601. Default: now.
granularity"hour" | "day" | "week" | "month"
Size of each point of series. Default: hour up to 2 days, day up to 92 days, week up to a year, month beyond. At most 400 points.
timezonestring
IANA timezone the points and the default period are cut in. Default: Europe/Paris.

Request body

No body: send the request without one.

Response

200

periodobject
previous_periodobject
The period of the same length just before, to compare against.
totalsobject
Totals over the period.
previous_totalsobject
Totals over the previous period.
seriesarray of object
The period point by point, oldest first, empty points included.
by_assistantarray of object
The period per assistant, most credits first.
by_campaignarray of object
The period per campaign, most credits first.
balanceobject
The balance now and how long it lasts at the recent pace. Does not depend on the period.

Errors

400Invalid request: a field or parameter failed validation{ "message"?: string, "error"?: string, "bodyErrors"?: {…} }
401Missing or invalid API key{ "message"?: string, "error"?: string, "bodyErrors"?: {…} }

Error bodies carry an error (or message) string; a 400 adds bodyErrors.issues. See Errors.