---
title: "Get Boards"
method: GET
path: "/reporting/board"
tags: ["Board"]
---

# Get Boards

`GET /reporting/board`

## Query parameters

- `page` number
- `sortOrder` 'ASC' | 'DESC'
- `sortBy` 'createdAt' | 'duration' | 'cost'
- `limit` number
- `createdAtGt` string, date-time
- `createdAtLt` string, date-time
- `createdAtGe` string, date-time
- `createdAtLe` string, date-time
- `updatedAtGt` string, date-time
- `updatedAtLt` string, date-time
- `updatedAtGe` string, date-time
- `updatedAtLe` string, date-time

## Response `200`

- BoardPaginatedResponse
  - `results` Board[], required
    - `items` union[] — This is the contents of the Board, which is an array of objects defining the type, contents, and position of the widgets on the Board.
      - union
        - BoardInsightItem
          - `type` 'insight', required
          - `insightId` string, required
          - `systemKey` string
          - `position` BoardItemPosition, required
            - `x` number, required
            - `y` number, required
          - `size` BoardItemSize, required
            - `width` number, required
            - `height` number, required
        - BoardMetricWidgetItem
          - `type` 'failed_calls_list' | 'concurrency_chart' | 'average_cost_breakdown_chart', required
          - `position` BoardItemPosition, required
            - `x` number, required
            - `y` number, required
          - `size` BoardItemSize, required
            - `width` number, required
            - `height` number, required
          - `insightId` string
          - `systemKey` string
    - `id` string, required — This is the unique identifier for the Board.
    - `orgId` string, required — This is the unique identifier for the org that this Board belongs to.
    - `createdAt` string, date-time, required — This is the ISO 8601 date-time string of when the Board was created.
    - `updatedAt` string, date-time, required — This is the ISO 8601 date-time string of when the Board was last updated.
    - `systemKey` string — Server-owned key for system-provisioned boards. User create/update DTOs do not accept this field.
    - `name` string, required — This is the name of the Board.
    - `layout` BoardLayout, required
      - `columns` number, required — This is the number of columns in the Board. For now, it is fixed to 6.
    - `timeRangeOverride` InsightTimeRangeWithStep
      - `step` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year' — This is the group by step for aggregation. If not provided, defaults to group by day.
      - `start` object — This is the start date for the time range. Should be a valid ISO 8601 date-time string or relative time string. If not provided, defaults to the 7 days ago. Relative time strings of the format "-{number}{unit}" are allowed. Valid units are: - d: days - h: hours - w: weeks - m: months - y: years
      - `end` object — This is the end date for the time range. Should be a valid ISO 8601 date-time string or relative time string. If not provided, defaults to now. Relative time strings of the format "-{number}{unit}" are allowed. Valid units are: - d: days - h: hours - w: weeks - m: months - y: years
      - `timezone` string — This is the timezone you want to set for the query. If not provided, defaults to UTC.
  - `metadata` PaginationMeta, required
    - `itemsPerPage` number, required
    - `totalItems` number, required
    - `currentPage` number, required
    - `totalPages` number
    - `hasNextPage` boolean
    - `nextCursor` string — Opaque cursor for the next page under keyset pagination (PRO-3163). Pass it back as the `cursor` query param to fetch the next page without an OFFSET scan. Present only when a further page likely exists.
    - `sortOrder` 'ASC' | 'DESC'
    - `itemsBeyondRetention` boolean
    - `createdAtLe` string, date-time
    - `createdAtGe` string, date-time

---

[API](https://skmtc.net/vapiai/apis/vapi-api.md) · [All operations](https://skmtc.net/vapiai/apis/vapi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vapiai/vapi-api/versions/42e311e78e21/schema)