GET
/
dashboards
List dashboards with pagination
curl --request GET \
  --url https://core.ravenna.ai/api/dashboards \
  --header 'x-ravenna-api-token: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "slug": "<string>",
      "layout": {
        "columns": 12,
        "widgets": [
          {
            "slug": "<string>",
            "x": 1,
            "y": 1,
            "columns": 1,
            "rows": 2
          }
        ]
      },
      "config": {
        "filters": [
          {
            "field": "<string>",
            "condition": "<string>",
            "value": "<string>",
            "given": "<string>"
          }
        ],
        "dateFilters": {
          "period": "this.day",
          "timeInterval": "day",
          "dateRange": {
            "from": "<string>",
            "to": "<string>"
          }
        }
      },
      "isSystemCreated": true,
      "itemType": "<string>",
      "type": "legacy",
      "parentId": "<string>",
      "organizationId": "<string>",
      "organization": {
        "id": "<string>",
        "name": "<string>"
      },
      "widgets": [
        {
          "id": "<string>",
          "slug": "<string>",
          "name": "<string>",
          "description": "<string>",
          "dashboardId": "<string>",
          "dashboard": {
            "id": "<string>",
            "name": "<string>"
          },
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "type": "<string>",
          "query": {
            "filterGroups": [
              [
                {
                  "field": "<string>",
                  "condition": "<string>",
                  "value": "<any>",
                  "given": "<string>"
                }
              ]
            ],
            "dataSource": "Ticket",
            "timeInterval": "day",
            "groupBy": [
              "<string>"
            ],
            "aggregations": [
              {
                "type": "count",
                "alias": "<string>",
                "field": "id"
              }
            ],
            "limit": 123,
            "sortOrder": "ASC",
            "dateField": "<string>"
          },
          "displayConfig": {
            "formatter": "number",
            "maximumFractionDigits": 123,
            "minimumFractionDigits": 123,
            "chartType": "bar",
            "orientation": "horizontal"
          }
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "totalCount": 123
}

Authorizations

x-ravenna-api-token
string
header
required

Query Parameters

workspaceId
string | null
skip
number | null
Required range: x >= 1
offset
number | null
Required range: x >= 0
cursor
string | null
limit
number | null
default:100
Required range: 1 <= x <= 10000
set
string | null
sortBy
string | null
sortDirection
enum<string> | null
Available options:
asc,
desc
groupBy
string | null
groupDirection
enum<string> | null
Available options:
asc,
desc

Response

Successful response

items
object[]
required
totalCount
number
required
nextCursor
string