Skip to content
Sursa Developers

Objects

ApiLogEntry

A request made with an API key, as recorded in the log. Added in 1.62.0.

Fields

  • request_idstringrequired

    Request ID (the X-Request-Id response header).

  • created_atstring (date-time)required

    When processing of the request started (UTC).

  • key_idintegerrequired

    API key of the organization.

  • key_namestringrequired

    Name of the key.

  • key_prefixstringrequired

    Beginning of the key value, as in the list of keys.

  • methodstringrequired

    HTTP method.

  • routestringrequired

    Path template of the operation (/v1/cards/{card_id}); unmatched means a path outside API operations.

  • statusintegerrequired

    Response code; 499 means the client closed the connection before the response ended.

  • duration_msnumberrequired

    Response latency in milliseconds.

  • client_ipstring | nullrequired

    Client address.

  • request_bytesinteger (int64)required

    Size of the request body in bytes.

  • response_bytesinteger (int64)required

    Size of the response body in bytes.

  • error_codestring | nullrequired

    Error code from the catalog in the response body; null when the response has no error.

  • sample_rateintegerrequired

    1 means the request was recorded without sampling; N means a sampled record, one of N requests above the daily log limit (successful requests and rejections by the rate limiter and the quota).

Used by

Part of

ApiLogList