Create a dashboard tile
Reports module
POST/dashboard-tilesdashboardTiles.create
A report tile on a dashboard. Creates a dashboard tile. 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: DashboardTileCreate
| Field | Type | Required | Description |
|---|---|---|---|
| dashboard_id | string (uuid) | Yes | Identifier of the dashboard. |
| report_definition_id | string (uuid) | Yes | Identifier of the report definition. |
| grid_column | integer | Yes | Leftmost column, 1 to 12.Constraints: range 1 to any |
| grid_row | integer | Yes | Top row, from 1.Constraints: range 1 to any |
| column_span | integer | Yes | Columns spanned, 1 to 12.Constraints: range 1 to any |
| row_span | integer | Yes | Rows spanned, 1 to 12.Constraints: range 1 to any |
{
"dashboard_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"report_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"grid_column": 1,
"grid_row": 1,
"column_span": 6,
"row_span": 1
}Response 201: DashboardTile
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the dashboard tile. |
| 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. |
| dashboard_id | string (uuid) | Yes | Identifier of the dashboard. |
| report_definition_id | string (uuid) | Yes | Identifier of the report definition. |
| grid_column | integer | Yes | Leftmost column, 1 to 12.Constraints: range 1 to any |
| grid_row | integer | Yes | Top row, from 1.Constraints: range 1 to any |
| column_span | integer | Yes | Columns spanned, 1 to 12.Constraints: range 1 to any |
| row_span | integer | Yes | Rows spanned, 1 to 12.Constraints: range 1 to any |
{
"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",
"dashboard_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"report_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"grid_column": 1,
"grid_row": 1,
"column_span": 6,
"row_span": 1
}Code samples
curl -X POST "$XOS_BASE_URL/dashboard-tiles" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"dashboard_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","report_definition_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","grid_column":1,"grid_row":1,"column_span":6,"row_span":1}'const { data } = await xos.dashboardTiles.create({
"dashboard_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"report_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"grid_column": 1,
"grid_row": 1,
"column_span": 6,
"row_span": 1
});response = xos.dashboard_tiles.create({"dashboard_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "report_definition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "grid_column": 1, "grid_row": 1, "column_span": 6, "row_span": 1})xos dashboard-tiles create --data '{"dashboard_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","report_definition_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","grid_column":1,"grid_row":1,"column_span":6,"row_span":1}'