Dashboards API — List and Retrieve Your Dashboards

The Dashboards API lets you list and retrieve dashboard metadata programmatically — useful for building internal portals, embedding dashboard links in other tools, or auditing your workspace’s dashboards without logging into the Cano Analytics UI. All requests require the read scope.

GET /v1/dashboards — List Dashboards

Retrieve a paginated list of all dashboards in your workspace.

Query parameters

integer

Number of dashboards to return per page. Defaults to 50. Maximum is 200.

string

Opaque pagination cursor from the previous response’s next_cursor field.

Request example

cURL

curl https://api.canoanalytics.io/v1/dashboards \
  -H "Authorization: Bearer YOUR_API_KEY"

Response — 200 OK

200 OK

{
  "data": [
    {
      "id": "dsh_8bYc3kPmNz",
      "name": "Growth Overview",
      "created_at": "2024-02-01T10:00:00Z",
      "updated_at": "2024-06-14T09:15:33Z",
      "chart_count": 6
    },
    {
      "id": "dsh_2aXr9hQeLw",
      "name": "Activation Funnel",
      "created_at": "2024-03-12T14:22:00Z",
      "updated_at": "2024-06-10T17:45:00Z",
      "chart_count": 3
    }
  ],
  "next_cursor": null,
  "has_more": false
}

array

An array of dashboard summary objects.

string

Unique identifier for the dashboard.

string

Human-readable name of the dashboard as it appears in the UI.

string

ISO 8601 timestamp of when the dashboard was created.

string

ISO 8601 timestamp of the most recent change to the dashboard.

integer

Number of charts currently on the dashboard.

GET /v1/dashboards/ — Get a Dashboard

Retrieve the complete metadata for a single dashboard, including the full list of charts and their configurations.

Path parameters

string

required

The unique identifier of the dashboard to retrieve.

Response fields

string

Unique identifier for the dashboard.

string

Human-readable name of the dashboard.

string

Optional description of the dashboard’s purpose.

array

An array of chart objects belonging to this dashboard. See chart fields below.

string

Unique identifier for the chart.

string

Display title of the chart.

string

Chart visualization type. Examples: line, bar, pie, funnel, table.

string

The event name this chart is based on.

array

An array of filter objects applied to the chart (e.g. { "property": "plan", "operator": "eq", "value": "pro" }).

string

The property used to group or segment the chart’s data (e.g. "plan", "country").

string

ISO 8601 timestamp of when the dashboard was created.

string

ISO 8601 timestamp of the most recent change to the dashboard.

string

A shareable public URL for this dashboard, if public sharing is enabled. null if the dashboard is private.

Request example

cURL

curl https://api.canoanalytics.io/v1/dashboards/dsh_8bYc3kPmNz \
  -H "Authorization: Bearer YOUR_API_KEY"

Response — 200 OK

200 OK

{
  "id": "dsh_8bYc3kPmNz",
  "name": "Growth Overview",
  "description": "Top-level metrics for acquisition, activation, and retention.",
  "charts": [
    {
      "id": "chrt_1aQp7mVcLx",
      "title": "Daily Sign-ups by Plan",
      "type": "bar",
      "event": "signup_completed",
      "filters": [],
      "group_by": "plan"
    },
    {
      "id": "chrt_5fNk2rBwYj",
      "title": "Revenue Over Time (Pro Users)",
      "type": "line",
      "event": "order_completed",
      "filters": [
        {
          "property": "plan",
          "operator": "eq",
          "value": "pro"
        }
      ],
      "group_by": null
    }
  ],
  "created_at": "2024-02-01T10:00:00Z",
  "updated_at": "2024-06-14T09:15:33Z",
  "public_url": "https://app.canoanalytics.io/public/dashboards/dsh_8bYc3kPmNz"
}

Use public_url to embed a read-only dashboard link in internal wikis or customer-facing status pages without requiring recipients to have a Cano Analytics account.

Overview

Endpoints

SDKs

Dashboards API — List and Retrieve Your Dashboards

GET /v1/dashboards — List Dashboards

Query parameters

Request example

Response — 200 OK

GET /v1/dashboards/ — Get a Dashboard

Path parameters

Response fields

Request example

Response — 200 OK

​GET /v1/dashboards — List Dashboards

​Query parameters

​Request example

​Response — 200 OK

​GET /v1/dashboards/ — Get a Dashboard

​Path parameters

​Response fields

​Request example

​Response — 200 OK

GET /v1/dashboards — List Dashboards

Query parameters

Request example

Response — 200 OK

GET /v1/dashboards/ — Get a Dashboard

Path parameters

Response fields

Request example

Response — 200 OK