Dashboard

Query cards on a dashboard

Queries the cards on this dashboard, in display order, including each card's config. Dashboards have at most 20 cards, so all cards are returned in a single page.

get/v1/projects/{project_id}/dashboards/{id}/cards

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/dashboards/{id}/cards
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

idstring required

ID of the Dashboard

Query parameters

countboolean

If true, the API will return the count of items matching the filter, instead of the items themselves

Response

Successful response. When count=1 parameter is provided, returns {"count": N} instead.

truncatedboolean

True if there are more results

next_markerstring

Marker for pagination

page_sizeinteger

Number of results per page

sort_dir'asc' | 'desc'

Sort direction

countinteger

Total count of matching items (only when count=1 parameter is provided)

Example response

{
  "data": [
    {
      "id": "DC5c9155e33a1d0c1a",
      "type": "messages_chart",
      "title": "Registrations by Region",
      "order": 1,
      "width": 400,
      "height": 300,
      "dashboard_id": "DB2ad0100821a98bea",
      "project_id": "PJ2ad0100821a98bea",
      "time_created": 1392254503,
      "time_updated": 1392254503
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.