Report - ClarusWMS

{
  "name": "Count of Tasks Left To Do",
  "description": "Count of Tasks Left To Do by Task Type",
  "report_type": "bar",
  "report_query_id": 1,
  "source_path": "data.tasks.aggregation",
  "report_fields": [
    {
      "name": "Task Type",
      "path": "task_type.code"
    },
    {
      "name": "Tasks Left To Do",
      "path": "total_records"
    }
  ],
  "variables": [
    {
      "name": "created_at_from",
      "value": "start of today",
      "prompt": "true"
    },
    {
      "name": "created_at_to",
      "value": "end of today",
      "prompt": "true"
    }
  ]
}

Report attributes defining how a report query is formatted and parameterized

name

string

required

Report name for identification

Maximum string length: 50

report_query_id

integer

required

ID of the report query to execute

report_type

enum<string>

required

Output type: single (table), bar (bar chart), pie (pie chart)

Available options:

single,

bar,

pie

description

string | null

Description of what the report shows

Maximum string length: 500

report_fields

object[]

Array of field definitions controlling report output columns. Each field maps a GraphQL response field to a named CSV/report column.

Show child attributes

source_path

string | null

Dot-notation path to extract data from GraphQL response. Must start with 'data.' (e.g., 'data.tasks.aggregation', 'data.stocks.all.edges'). Common patterns: 'data.{resource}.aggregation' for grouped results, 'data.{resource}.all.edges' for paginated lists

variables

object[]

Variable values passed to the report query parameters. Supports Chronic-style date values.

Show child attributes

⌘I