/dashboards/{id}

Note: When making API requests, ensure the following headers are included:

  • Authorization: Bearer UserToken (replace UserToken with your actual access token)
  • Content-Type: application/json
  • Accept: application/json

Get a dashboard by ID.

Responses

  • idstring

  • titlestring

  • createdAtstring

  • collectionIDnull

  • collectionTitlenull

  • createdByinteger

  • entity_idinteger

  • jsonVersioninteger

  • editableboolean

  • curatedboolean

  • publicboolean

  • sharedboolean

  • sharedByMeboolean

  • integrationnull

  • disabledboolean

  • isMyDefaultboolean

  • orgIdstring

  • urlBasedboolean

  • jsonViewPropsnull

  • sharedOrgIdnull

Response Samples

{
  "id": "8cf999ca-3a60-44c8-b2dd-8fd2c4bcaadb",
  "title": "Demo copy",
  "createdAt": "2024-09-03T16:14:12Z",
  "collectionID": null,
  "collectionTitle": null,
  "createdBy": 1134233,
  "entity_id": 16533,
  "jsonVersion": 1,
  "editable": true,
  "curated": false,
  "public": false,
  "shared": false,
  "sharedByMe": false,
  "integration": null,
  "disabled": false,
  "isMyDefault": false,
  "orgId": "service_provider_2",
  "urlBased": false,
  "jsonViewProps": null,
  "sharedOrgId": null
}

This API will replace the most recent dashboard and tile data with the following:

  • A new tile will be created if the tile ID does not already exist in the dashboard.

  • Existing tiles will be updated with the latest payload when their IDs match.

  • Any existing tiles not included in the latest tiles payload will be removed.

Request Body

application/json

  • idstring

  • titlestring

  • createdAtstring

  • collectionIDstring

  • collectionTitlestring

  • createdByinteger

  • entity_idinteger

  • jsonVersioninteger

  • tilesarray

  • editableboolean

  • curatedboolean

  • publicboolean

  • sharedboolean

  • sharedByMeboolean

  • integrationstring

  • disabledboolean

  • isMyDefaultboolean

  • orgIdstring

  • urlBasedboolean

  • jsonViewPropsstring

  • sharedOrgIdstring

Loading Examples...

Responses

200OK

Loading Examples...

delete a dashbaord

Responses

Loading Examples...