List usage events

One usage event per billable job: held at submit, then settled (credits drawn for the measured length) or voided (nothing charged).

GET /v1/usage

List usage events

cURL

curl --request GET \
  --url https://api.hooper.gg/v1/usage \
  --header 'Authorization: Bearer <token>'

200

{
  "object": "list",
  "has_more": true,
  "total_count": 123,
  "data": [
    {
      "id": "ue_91",
      "object": "usage_event",
      "created": 123,
      "session": "sess_18234",
      "group": "<string>",
      "api_key": "key_11",
      "sku": "video_processing",
      "status": "held",
      "run_version": 123,
      "held_seconds": 123,
      "quantity_seconds": 123,
      "rate_cents_per_hour": 123,
      "cost_cents": 123,
      "settled_at": 123,
      "voided_at": 123
    }
  ],
  "url": "/v1/sessions/sess_18234/highlights"
}

Authorizations

Authorization · string · header · required

API key issued by Hooper for your organization. Keys are environment-tagged: hk_prod_ keys work against production, hk_stg_ keys against staging.

Query Parameters

limit · integer · default: 20

Required range: 1 <= x <= 100

starting_after · string

Cursor: the id of the last item on the previous page.

status · enum<string>

Available options: held, settled, voided

api_key · string

Example:

"key_11"

created[gte] · integer

Unix seconds

created[lte] · integer

Unix seconds

Response

200 - application/json

OK

object · string · required

Allowed value: "list"

has_more · boolean · required

total_count · integer · required

data · object[] · required

Show child attributes

url · string

Embedded lists only: the endpoint that pages the full set.

Example:

"/v1/sessions/sess_18234/highlights"