VindexDocs
    Vindex docs
    Dashboardgetvindex.com

    API reference

    Usage

    Checks, blocks and reviews per day.

    Daily usage

    GET/v1/usage

    Checks, blocks, reviews and screening input tokens per UTC day, for the key's mode only. Defaults to the last 30 days.

    Parameters

    • fromstringquery
    • tostringquery
    • modeanyquery

      Must be the key's own mode, if given.

    Request

    cURL
    curl "https://api.getvindex.com/v1/usage" \
  -H "Authorization: Bearer $VINDEX_KEY"

    Response 200

    Usage in [from, to], inclusive.

    Example
    {
  "from": "2026-09-01",
  "to": "2026-09-30",
  "data": [
    {
      "day": "2026-09-17",
      "mode": "test",
      "checks": 1200,
      "blocked": 12,
      "reviewed": 30,
      "input_tokens": 118
    }
  ],
  "totals": {
    "live": {
      "checks": 1200,
      "blocked": 12,
      "reviewed": 30,
      "input_tokens": 118
    },
    "test": {
      "checks": 1200,
      "blocked": 12,
      "reviewed": 30,
      "input_tokens": 118
    }
  }
}

    Errors

    • 400Invalid request (malformed JSON, or the body/query failed validation).
    • 401Missing, malformed, unknown or revoked API key.
    • 403mode isn't the key's own mode (mode_forbidden).
    • 429Rate limit exceeded for this API key. See Retry-After.