List dashboards

List the custom analytics dashboards in the workspace.

GEThttps://api.tried.com.au/dashboards

Returns every custom analytics dashboard in the workspace, in tab order.

Request#

This endpoint takes no path, query or body parameters.

Example request#

curl https://api.tried.com.au/dashboards \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/dashboards", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const dashboards = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/dashboards",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
dashboards = res.json()

Response#

200 OK

[
  {
    "dashboard_id": "dash_6e1a9c3f5b7d2e4a8c0f1b3d",
    "name": "Inbound overview",
    "charts": [
      {
        "id": "chart_a1b2c3d4e5",
        "title": "Calls per day",
        "type": "line",
        "query": {
          "metric": "call_count",
          "measurement": "count",
          "breakdown": "none",
          "breakdowns": [
            "agent"
          ],
          "tz": "Australia/Sydney",
          "filters": {
            "agent_ids": [],
            "call_type": [],
            "direction": [],
            "disconnection_reason": [],
            "user_sentiment": [],
            "call_successful": null,
            "fields": []
          },
          "compare_previous": false
        },
        "layout": {
          "x": 0,
          "y": 0,
          "w": 6,
          "h": 4
        }
      }
    ],
    "position": 0,
    "last_modification_timestamp": 1792395000000
  }
]

The response is a JSON array of dashboards.

Field	Type	Description
`dashboard_id`	string	Dashboard ID, prefixed `dash_`.
`charts`	object[]	Stored charts with every query default filled in.
`position`	integer	Tab order, starting at 0.
`last_modification_timestamp`	integer	Unix ms of the last change.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `analytics` scope.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.

Retell compatibility#

Retell's public API reference has no analytics endpoints, so this route has no Retell SDK equivalent.