Dashboard

Get dashboard by ID

Retrieves the dashboard with the given ID, including summaries of the cards on the dashboard.

If the project's dashboards have never been customized, the project's primary dashboard is generated automatically and has the ID default; it is saved (and receives a permanent ID) the first time it is updated, after which the ID default is no longer valid. The ID of the project's current primary dashboard is available via the project's primary_dashboard_id property.

The cards on an automatically generated dashboard have null IDs until the dashboard is customized. To update or delete them individually, first call dashboard.save (even without changing any fields), which converts the dashboard to a custom dashboard and assigns an ID to each card.

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

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/dashboards/{id}
  • 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, or default for the automatically generated dashboard of a project whose dashboards have never been customized

Response

Successful response

idstring

ID of the dashboard, or default for an automatically generated dashboard that has not been saved yet

namestring

Name of the dashboard

solution_idstring nullable

ID of the solution that this dashboard belongs to, if any

varsobject

Custom variables stored for this dashboard. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.

time_createdinteger nullable

Time the dashboard was created in Telerivet (null for an automatically generated dashboard that has not been saved)

time_updatedinteger nullable

Time the dashboard was last updated in Telerivet

project_idstring

ID of the project this dashboard belongs to

urlstring

URL to this dashboard in the Telerivet web app

Example response

{
  "id": "DB2ad0100821a98bea",
  "name": "Election Monitoring",
  "solution_id": "SO2ad0100821a98bea",
  "time_created": 1392254503,
  "time_updated": 1392254503,
  "project_id": "PJ2ad0100821a98bea",
  "url": "https://telerivet.com/p/asdf/dashboard/DB2ad0100821a98bea"
}

Changes

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