Dashboard

Create a dashboard

Creates a new custom dashboard within the given project. After creating the dashboard, add cards to it via dashboard.createCard.

Each project may have up to 20 dashboards. Custom dashboards require a Telerivet service plan that includes the custom dashboards feature.

post/v1/projects/{project_id}/dashboards

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/dashboards
  • 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

Request body

namestring required

Name of the dashboard (max 100 characters)

solution_idstring

ID of the solution that this dashboard is part of, if applicable

varsobject

Custom variables and values to set 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.

Example request

{
  "name": "Election Monitoring"
}

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.