Logs

List API requests, newest first

GET /v1/logs/requests logs:read

The API key environment's requests of the last 30 days. A request shows here a moment after its response.

Query

• status "2xx" | "3xx" | "4xx" | "5xx"

  Only this status class, e.g. 4xx

• method string

  Only this HTTP method

• path string

  Paths containing this text

• limit integer
• cursor string

Responses

• 200

  A page of requests

  Fields

  • data ApiRequest[] required
    Fields

    • id string required

      The request id: the Request-Id header of its response

    • environment "live" | "test" required
    • apiKeyId string | null required

      The API key that made it

    • method string required
    • route string | null required

      The route pattern

    • path string required
    • status integer required
    • durationMs integer required
    • errorCode string | null required
    • errorMessage string | null required
    • idempotencyKey string | null required
    • sdkVersion string | null required

      From User-Agent: hcc-sdk-js/<version>

    • createdAt string required
  • nextCursor string | null required
• 400

  Invalid request

• 401

  Missing or invalid API key

• 404

  Not found

• 429

  rate_limited, or another limit named by error.code

Get an API request by its request id

GET /v1/logs/requests/{id} logs:read

Path

• id string required

Responses

• 200

  The request

  Fields

  • data ApiRequest required

    One request your API keys made in this environment, kept for 30 days. Never its body, headers or key.

    Fields

    • id string required

      The request id: the Request-Id header of its response

    • environment "live" | "test" required
    • apiKeyId string | null required

      The API key that made it

    • method string required
    • route string | null required

      The route pattern

    • path string required
    • status integer required
    • durationMs integer required
    • errorCode string | null required
    • errorMessage string | null required
    • idempotencyKey string | null required
    • sdkVersion string | null required

      From User-Agent: hcc-sdk-js/<version>

    • createdAt string required
• 400

  Invalid request

• 401

  Missing or invalid API key

• 404

  Not found

• 429

  rate_limited, or another limit named by error.code