dashboards

List dashboards

Changed on

List dashboards accessible to the authenticated user. Always pass project_id — without it, all dashboards across every project in your organisation are returned, which can be a large result set.

Dashboard workflow:

  1. POST /dashboards/dashboards — create a dashboard with a name, project, and date-range filters
  2. POST /dashboards/widgets — add widgets (line, bar, pie, or stat charts)
  3. GET /dashboards/widgets/{id}/data — fetch chart data (requires a timestamp filter)
  4. POST /dashboards/dashboards/{id}/duplicate — clone an existing dashboard as a starting point
get/dashboards/dashboards/

Request

  • Base URL
    https://api.cekura.ai
  • URL
    https://api.cekura.ai/dashboards/dashboards/
  • Auth
    • API key in header X-CEKURA-API-KEY
    • or HTTP bearer
    • or HTTP bearer
    • or API key in header X-VOCERA-SHAREABLE-LINK-TOKEN
    • or HTTP bearer

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

project_idinteger

Filter by project ID. Strongly recommended — omitting returns all dashboards across every project.

source'call_logs' | 'runs'

Dataset of the dashboards to list: call_logs (default) or runs.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "https://api.cekura.ai/example/v1/example-external/?page=4",
  "previous": "https://api.cekura.ai/example/v1/example-external/?page=3",
  "results": [
    {
      "filters": {
        "field": "success",
        "op": "eq",
        "value": true
      }
    }
  ]
}

Changes

    • info

      the endpoint scheme security embedded_session was added to the API

    • info

      the endpoint scheme security oauth2 was added to the API

    • info

      the endpoint scheme security shareable_link was added to the API

    • info

      the endpoint scheme security supabase_session was added to the API

    • info

      added the new optional query request parameter source

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status