Create a report definition

Reports module

POST/report-definitionsreportDefinitions.create

A report definition with NULL-aware aggregates. Reports respect RLS and masking. Creates a report definition. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability reports.report.write.
OAuth scopes: reports.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: ReportDefinitionCreate

reportDefinitions.create: ReportDefinitionCreate
Field	Type	Required	Description
name	string	Yes	Report name.Constraints: length 1 to 300
source_code	string	Yes	Source.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
chart	"Table" \| "Bar" \| "Line" \| "Area" \| "Pie" \| "Number"	No	Chart type.
group_by_field	string \| null	No	Field the rows are grouped by.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
shared	boolean	No	Whether everyone who may read the source sees it.
custom_object_type_id	string (uuid) \| null	No	Identifier of the custom object type, when the source is custom_object.

{
  "name": "Labor by Department",
  "source_code": "crew",
  "chart": "Table",
  "group_by_field": "dept_code",
  "shared": false,
  "custom_object_type_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 201: ReportDefinition

reportDefinitions.create: ReportDefinition
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the report definition.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
name	string	Yes	Report name.Constraints: length 1 to 300
source_code	string	Yes	Source.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
chart	"Table" \| "Bar" \| "Line" \| "Area" \| "Pie" \| "Number"	Yes	Chart type.
group_by_field	string \| null	Yes	Field the rows are grouped by.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
shared	boolean	Yes	Whether everyone who may read the source sees it.
custom_object_type_id	string (uuid) \| null	Yes	Identifier of the custom object type, when the source is custom_object.
membership_id	string (uuid)	Yes	Identifier of the membership that owns the report.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Labor by Department",
  "source_code": "crew",
  "chart": "Table",
  "group_by_field": "dept_code",
  "shared": false,
  "custom_object_type_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X POST "$XOS_BASE_URL/report-definitions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Labor by Department","source_code":"crew","chart":"Table","group_by_field":"dept_code","shared":false,"custom_object_type_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data } = await xos.reportDefinitions.create({
    "name": "Labor by Department",
    "source_code": "crew",
    "chart": "Table",
    "group_by_field": "dept_code",
    "shared": false,
    "custom_object_type_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });

response = xos.report_definitions.create({"name": "Labor by Department", "source_code": "crew", "chart": "Table", "group_by_field": "dept_code", "shared": False, "custom_object_type_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})

xos report-definitions create --data '{"name":"Labor by Department","source_code":"crew","chart":"Table","group_by_field":"dept_code","shared":false,"custom_object_type_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'