---
title: "What this credential has been doing"
method: GET
path: "/usage"
tags: ["usage"]
---

# What this credential has been doing

`GET /usage`

## Request

- Base URL: `https://api.gogoscreen.com/api/v1`
- URL: `https://api.gogoscreen.com/api/v1/usage`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Public API calls over a window, by day and by operation, plus the video time the account spent in the same window. A key sees only its own calls; a signed-in person sees the whole account. Windows are inclusive of `from` and exclusive of `to`, default the last 30 days, and may span at most 92.

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `groupBy` 'day' | 'operation' | 'both'

## Response `200`

What this credential has been doing

- object
  - `byDay` object[], required: UTC days, ascending. Absent days are absent, not zero.
    - `day` string, required
    - `errors` number, required
    - `requests` number, required
  - `byOperation` object[], required: Busiest first.
    - `errors` number, required
    - `operation` string, required
    - `requests` number, required
  - `details` object, nullable, required: Present only when a field above could not be answered, saying which and why.
    - `note` string, required
  - `from` string, date-time, required
  - `requests` number, required: Every public call in the window, whatever it answered.
  - `scope` 'api_key' | 'account', required: `api_key` when a key asked — it sees only its own calls.
  - `secondsCharged` number, nullable, required: Video time charged in the window, from the wallet ledger — the only authority on spend. For a signed-in person this is the ACCOUNT's total. For a KEY it is the total of the work THAT KEY created: renders and marketing exports it started, joined to the ledger by the row they were charged against. Work started in the dashboard is not a key's, and one key never sees another's.
  - `to` string, date-time, required

## Other responses

- `400`: `validation_failed` — That request is not valid.
- `401`: `unauthorized` — Authentication is required.
- `403`: `forbidden_scope` — This credential does not carry the scope this operation needs.
- `404`: `not_found` — No such resource.
- `429`: `rate_limited` — Too many requests. Try again shortly.
- `500`: `internal_error` — Something went wrong. Try again.

---

[API](https://skmtc.dev/gogoscreen/apis/gogoscreen-api.md) · [All operations](https://skmtc.dev/gogoscreen/apis/gogoscreen-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gogoscreen/apis/gogoscreen-api/revisions/2fd812319d75?raw)