Skip to main content
POST
Create a report query

Request Structure

Key Fields

GraphQL Query Rules

  • Must be a named query (e.g., query getTasksToDo(...)) — never anonymous
  • Use $variable syntax for parameters with GraphQL types (ID, Chronic, String)
  • Common query patterns: aggregation(...) for grouped/summarized data, all(...) { edges { node { ... } } } for paginated lists

Parameter Types

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
data
object
required

Response

Report query created successfully

data
object