Per-day consumption and the credit ledger

GEThttps://server.heyrik.com/api/v1/usage

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Parameters 3

Fields documented for this operation. See the request example for placement and structure.

daysnumber

Window size. Default 30.

fromstring

ISO start date (use with until).

untilstring

ISO end date.

Response

Explore the example values. This is not a complete response schema.

dataobject

Explore 4 properties

periodobject

Explore 3 properties

credits_usednumber

Example 218.267

minutesnumber

Example 54.5

callsnumber

Example 83

by_dayarray

Explore 1 example item

[0]object

Explore 4 properties

datestring

Example "2026-07-22"

creditsnumber

Example 12.45

minutesnumber

Example 3.1

callsnumber

Example 5

credits_per_minutenumber

Example 4

recordsarray

Explore 1 example item

[0]object

Explore 4 properties

kindstring

Example "call"

creditsnumber

Example 2.9167

secondsnumber

Example 37

notestring

Example "call 37s — 2.4667 platform + 0.45 carrier"

Error reference

GET/usage

cURL

curl "https://server.heyrik.com/api/v1/usage?days=30" \
  -H "Authorization: Bearer $HEYRIK_API_KEY"

Response example

JSON

{
  "data": {
    "period": { "credits_used": 218.267, "minutes": 54.5, "calls": 83 },
    "by_day": [
      { "date": "2026-07-22", "credits": 12.45, "minutes": 3.1, "calls": 5 }
    ],
    "credits_per_minute": 4,
    "records": [
      {
        "kind": "call",
        "credits": 2.9167,
        "seconds": 37,
        "note": "call 37s — 2.4667 platform + 0.45 carrier"
      }
    ]
  }
}

Illustrative examples · No live request is sent