spicrawl-com · Schema

UsageByKey

`GET /v1/usage?group_by=key`. Only the caller's organization's keys, and only the key's own project for a project-scoped key. The dashboard route `GET /v1/orgs/{orgID}/usage?group_by=key` returns the same `keys` array with inclusive `from`/`to` dates instead of `period`.

CompanyWeb ScrapingData ExtractionAutomationArtificial Intelligence

Properties

Name Type Description
period object
group_by string
keys array
View JSON Schema on GitHub

JSON Schema

spicrawl-com-usage-by-key-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/spicrawl-com/json-schema/spicrawl-com-usage-by-key-schema.json",
  "title": "UsageByKey",
  "description": "`GET /v1/usage?group_by=key`. Only the caller's organization's keys, and only the key's own project for a project-scoped key. The dashboard route `GET /v1/orgs/{orgID}/usage?group_by=key` returns the same `keys` array with inclusive `from`/`to` dates instead of `period`.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/spicrawl-com-usage-api-openapi.yml#/components/schemas/UsageByKey",
  "type": "object",
  "required": [
    "period",
    "group_by",
    "keys"
  ],
  "properties": {
    "period": {
      "$ref": "#/$defs/UsagePeriod"
    },
    "group_by": {
      "type": "string",
      "enum": [
        "key"
      ]
    },
    "keys": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "key_id",
          "name",
          "prefix",
          "project_id",
          "revoked",
          "days",
          "totals"
        ],
        "properties": {
          "key_id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "prefix": {
            "type": "string",
            "description": "Display prefix of the key, never the secret."
          },
          "project_id": {
            "type": "string"
          },
          "revoked": {
            "type": "boolean"
          },
          "days": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "day",
                "metrics"
              ],
              "properties": {
                "day": {
                  "type": "string",
                  "format": "date"
                },
                "metrics": {
                  "$ref": "#/$defs/UsageMetricMap"
                }
              }
            }
          },
          "totals": {
            "$ref": "#/$defs/UsageMetricMap"
          }
        }
      }
    }
  },
  "$defs": {
    "UsageMetricMap": {
      "type": "object",
      "description": "Metric name to quantity. Keys are UsageMetric values.",
      "additionalProperties": {
        "type": "integer",
        "format": "int64"
      }
    },
    "UsagePeriod": {
      "type": "object",
      "required": [
        "start",
        "end",
        "days",
        "bounds"
      ],
      "description": "Half-open range of UTC days.",
      "properties": {
        "start": {
          "type": "string",
          "format": "date",
          "description": "First day, inclusive."
        },
        "end": {
          "type": "string",
          "format": "date",
          "description": "End day, EXCLUSIVE. The last included day is the day before this."
        },
        "days": {
          "type": "integer",
          "minimum": 0,
          "description": "Number of days in the period."
        },
        "bounds": {
          "type": "string",
          "const": "[start, end)",
          "description": "Always `[start, end)`, a reminder that `end` is exclusive."
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/spicrawl-com-usage-by-key"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.