Settings

Get per-API-key usage

Per-API-key usage: verification counts by type/channel/status plus per-collection totals (requests, confirmations, authorizations) and attribution metadata. The counts cover the key and every key it replaced (api_key.replaced_key_ids). Counts only — no recipient identifiers (SEC-001). Resolves across both key collections, scoped to the requesting user (IDOR); data is returned for revoked keys (audit). An API-key caller may read only its own key usage. (h-dashboard-per-key-api)

get/api/v1/me/api-keys/{id}/usage

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/me/api-keys/{id}/usage
  • Auth: one of:
    • HTTP bearer
    • API key in cookie auth_token

Path parameters

idstring required

API key id (UserAPIKey or legacy APIKey)

Query parameters

environment'production' | 'test'

Scope metrics to test or production (default: the calling key environment)

Response

Per-key usage counts + attribution

attribution_cutoff_atstring date-time nullable required

UTC-day-floored date attribution began for this user (earliest key-linked verification), or null

attributed_fractionnumber nullable required

Fraction of the user verifications linked to any API key in scope (null when there are none)

Example response

{
  "api_key": {
    "id": "507f1f77bcf86cd799439011",
    "key_prefix": "pk_live_",
    "profile_id": "507f1f77bcf86cd799439011",
    "replaced_key_ids": [
      "507f1f77bcf86cd799439011"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.