Preview

ApiRequest is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

ApiRequest

API request captured information

This page contains

    Fields

    id: ID!

    ID of the request

    timestamp: DateTime!

    Timestamp at which the request was captured

    endpoint: String!

    Endpoint targeted by the API request, e.g.: /api/graphql

    method: HttpMethod! PREVIEW

    HTTP method used to make the API request

    ipAddress: String!

    IP address the request originated from

    clientId: String!

    The API client ID used to make the API request

    responseCode: Int!

    HTTP response code

    contentType: String!

    Content type of the API call, e.g.: application/json

    userAgent: String!

    User agent used to make the API request

    duration: Int!

    Duration of the API call in milliseconds

    requestSize: Long!

    HTTP request body size in bytes (Envoy request_body_bytes). Zero means no request body was captured.

    responseSize: Long!

    HTTP response body size in bytes (Envoy response_body_bytes). Zero means no response body was captured.

    graphql: ApiRequestGraphQLDetails PREVIEW

    GraphQL details for this call. Null when the call was not GraphQL, was introspection, or operation/field/endpoint were not captured.

    Parent objects of ApiRequest

    ApiRequestConnection PREVIEW

    Paginated result for API requests

    Queries for ApiRequest

    apiRequests PREVIEW

    Paginated list of API requests