Usage

On this page, we’ll dive into the usage endpoints. We'll look at how to explore the usage available in the platform.

The usage model

The usage model contains all the information about an organization usage derived from the telemetry data sent to Unblind.

Properties

  • Name
    startTime
    Type
    number
    Description

    Unix timestamp (in seconds).

  • Name
    endTime
    Type
    number
    Description

    Unix timestamp (in seconds).


GET/v1/usage

List all usage

This endpoint allows you to query your whole organization telemetry usage

Required query parameters

  • Name
    startTime
    Type
    number
    Description

    Unix timestamps (in seconds).

  • Name
    endTime
    Type
    number
    Description

    Unix timestamps (in seconds).

  • Name
    interval
    Type
    string
    Description

    Interval period. Allowed values: day, month.

Request

POST
/v1/usage
curl -G https://api.unblind.dev/v1/usage \
  -H "Authorization: Bearer <API_KEY>" \
  --data-urlencode "startTime=1767222000" \
  --data-urlencode "endTime=1769900400"

Response

{
  "logs": {
    "bytes": 854237,
    "units": 4712
  },
  "metrics": {
    "units": 22158
  }
}

Was this page helpful?