Skip to main content

Interface: GraphQLPayload

Defined in: types/graphql.types.ts:87

GraphQL entry payload

Properties​

batchId?​

optional batchId: string

Defined in: types/graphql.types.ts:170

Unique ID for the batch


batchIndex?​

optional batchIndex: number

Defined in: types/graphql.types.ts:166

Index in the batch (0-based)


batchSize?​

optional batchSize: number

Defined in: types/graphql.types.ts:168

Total number of operations in the batch


depthReached?​

optional depthReached: number

Defined in: types/graphql.types.ts:144

Maximum depth reached in the query


duration​

duration: number

Defined in: types/graphql.types.ts:118

Total operation duration in milliseconds


errorCount?​

optional errorCount: number

Defined in: types/graphql.types.ts:134

How many errors the response carried, when more than were recorded


errors?​

optional errors: GraphQLErrorInfo[]

Defined in: types/graphql.types.ts:132

GraphQL errors from the response, at most MAX_RECORDED_ERRORS of them


executionDuration?​

optional executionDuration: number

Defined in: types/graphql.types.ts:124

Time spent executing resolvers (ms)


fieldCount?​

optional fieldCount: number

Defined in: types/graphql.types.ts:142

Number of fields in the selection set


fieldTraces?​

optional fieldTraces: GraphQLFieldTrace[]

Defined in: types/graphql.types.ts:184

Field-level timing traces


hasErrors​

hasErrors: boolean

Defined in: types/graphql.types.ts:130

Whether the response contains any errors


headers?​

optional headers: Record<string, string>

Defined in: types/graphql.types.ts:156

Request headers (sensitive values masked)


ip?​

optional ip: string

Defined in: types/graphql.types.ts:152

Client IP address


messageCount?​

optional messageCount: number

Defined in: types/graphql.types.ts:178

Number of messages sent (for completed subscriptions)


operationName?​

optional operationName: string

Defined in: types/graphql.types.ts:90

Name of the operation (if named)


operationType​

operationType: GraphQLOperationType

Defined in: types/graphql.types.ts:92

Type of operation: query, mutation, or subscription


parsingDuration?​

optional parsingDuration: number

Defined in: types/graphql.types.ts:120

Time spent parsing the query (ms)


potentialN1?​

optional potentialN1: PotentialN1Warning[]

Defined in: types/graphql.types.ts:148

Potential N+1 query warnings


query​

query: string

Defined in: types/graphql.types.ts:100

The query, mutation or subscription as text.

Empty only when a persisted query's hash could not be resolved to one: the server answered, and what it answered is on the entry, but there is no document to show.


queryHash​

queryHash: string

Defined in: types/graphql.types.ts:112

An identity for the query text: the same document produces the same hash whichever operation ran it, so two entries can be told apart from two calls of one thing.

Shown on the detail page. Nothing groups by it — the comment here used to say "for deduplication", which was an intention, not a behaviour.

For a persisted query whose hash the server could not resolve, this is the client's hash: it is the only identity that operation has.


resolverCount?​

optional resolverCount: number

Defined in: types/graphql.types.ts:140

Number of resolver calls


responseData?​

optional responseData: unknown

Defined in: types/graphql.types.ts:136

Response data (if captured)


statusCode​

statusCode: number

Defined in: types/graphql.types.ts:128

HTTP status code (200 for success, 4xx/5xx for errors)


subscriptionDuration?​

optional subscriptionDuration: number

Defined in: types/graphql.types.ts:180

Subscription duration in milliseconds (for completed subscriptions)


subscriptionEvent?​

optional subscriptionEvent: "start" | "data" | "error" | "complete"

Defined in: types/graphql.types.ts:176

Subscription lifecycle event


subscriptionId?​

optional subscriptionId: string

Defined in: types/graphql.types.ts:174

Unique subscription ID


tags?​

optional tags: string[]

Defined in: types/graphql.types.ts:162

Custom tags for this operation


user?​

optional user: RequestUser

Defined in: types/graphql.types.ts:158

Authenticated user info


userAgent?​

optional userAgent: string

Defined in: types/graphql.types.ts:154

User agent string


validationDuration?​

optional validationDuration: number

Defined in: types/graphql.types.ts:122

Time spent validating the query (ms)


variables?​

optional variables: Record<string, unknown>

Defined in: types/graphql.types.ts:114

Variables passed to the operation (sensitive values masked)