Skip to main content

Report query attributes

name
string
required

Name of the report query for identification

Maximum string length: 50
graphql
string
required

The GraphQL query to execute. Must be a named query with typed parameters (e.g., 'query getTasksToDo($warehouse_id: ID, $created_at_from: Chronic) { ... }'). Never use anonymous queries.

description
string | null

Description of what the report query does

Maximum string length: 500
parameters
object[] | null

Array of parameter definitions for the query