LogRocket · Schema

GraphQLRequest

A standard GraphQL request containing a query string and optional variables and operation name.

Session ReplayProduct AnalyticsFrontend MonitoringLoggingErrors

Properties

Name Type Description
query string The GraphQL query or mutation string to execute.
variables object Variables to substitute into the GraphQL query.
operationName string The name of the operation to execute when the query contains multiple operations.
View JSON Schema on GitHub

JSON Schema

logrocket-graphqlrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GraphQLRequest",
  "title": "GraphQLRequest",
  "type": "object",
  "description": "A standard GraphQL request containing a query string and optional variables and operation name.",
  "required": [
    "query"
  ],
  "properties": {
    "query": {
      "type": "string",
      "description": "The GraphQL query or mutation string to execute."
    },
    "variables": {
      "type": "object",
      "description": "Variables to substitute into the GraphQL query.",
      "additionalProperties": true
    },
    "operationName": {
      "type": "string",
      "description": "The name of the operation to execute when the query contains multiple operations."
    }
  }
}