Resources
Reports
Board report generation and retrieval. Reports contain dashboards.
A report represents a generated board report. Reports are scoped to a specific board and can contain one or more dashboards.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /api/v1/boards/:boardId/reports | List reports |
GET | /api/v1/boards/:boardId/reports/:reportId | Get a report |
Report Object
{
"object": "report",
"id": "60d5ec49f1a2c8b1f8e4e1e1",
"boardId": "60d5ec49f1a2c8b1f8e4e1a1",
"title": "Q2 2025 Board Report",
"status": "published",
"publishedAt": "2025-07-01T09:00:00.000Z",
"createdByUserId": "507f1f77bcf86cd799439011",
"createdAt": "2025-06-20T10:00:00.000Z",
"updatedAt": "2025-07-01T09:00:00.000Z"
}Fields
| Field | Type | Description |
|---|---|---|
object | "report" | Always "report" |
id | string | Opaque report ID |
boardId | string | The board this report belongs to |
title | string | Report title |
status | string | Report lifecycle status (e.g. draft, published) |
publishedAt | string | null | When the report was published, or null if still in draft |
createdByUserId | string | ID of the user who created the report |
createdAt | string | ISO-8601 timestamp |
updatedAt | string | ISO-8601 timestamp |
List Reports
GET /api/v1/boards/:boardId/reportsSupports filtering by status. See Pagination, Filtering & Sorting.
Example
curl -s "https://app.imboard.ai/api/v1/boards/BOARD_ID/reports?status=published" \
-H "Authorization: Bearer imb_pat_YOUR_TOKEN" | jqGet a Report
GET /api/v1/boards/:boardId/reports/:reportId