Get a dashboard tile
Módulo Reports
GET/dashboard-tiles/{id}dashboardTiles.get
A report tile on a dashboard. Returns one dashboard tile with its `ETag`. A dashboard tile the caller may not see returns 404.
- Requiere la capacidad reports.report.read.
- Alcances de OAuth: reports.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the dashboard tile. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: DashboardTile
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the dashboard tile. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| dashboard_id | string (uuid) | Sí | Identifier of the dashboard. |
| report_definition_id | string (uuid) | Sí | Identifier of the report definition. |
| grid_column | integer | Sí | Leftmost column, 1 to 12.Restricciones: range 1 to any |
| grid_row | integer | Sí | Top row, from 1.Restricciones: range 1 to any |
| column_span | integer | Sí | Columns spanned, 1 to 12.Restricciones: range 1 to any |
| row_span | integer | Sí | Rows spanned, 1 to 12.Restricciones: 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
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/dashboard-tiles/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.dashboardTiles.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.dashboard_tiles.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos dashboard-tiles get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f