Getting a dashboard

Use this request to return dashboard parameters and references to its widgets.

GET

https://api.tracker.yandex.net/v3/dashboards/{dashboard_ID}

Request format

Before making a request, get permission to access the API.

GET /v3/dashboards/{dashboard_ID}
Host: api.tracker.yandex.net
Authorization: OAuth API_TOKEN
X-Org-ID or X-Cloud-Org-ID: ORGANIZATION_ID
Headers

  • Host: address of the node that provides the API.

  • Authorization: Authorization token about these formats:

    • OAuth OAUTH_TOKEN: For authorization using the OAuth 2.0 protocol. Learn more

    • Bearer IAM_TOKEN: For authorization using an IAM token, if a Yandex Identity Hub organization is linked to Tracker. Learn more

  • ID types

    X-Org-ID or X-Cloud-Org-ID: Organization ID.

    • Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.

    • Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Identity Hub.

    Finding the ID

    To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Resource

Parameter

Description

Data type

dashboard_ID

Dashboard ID.

Number

Response format

If the request is successful, the API returns a response with code 200 OK.

On success, the API returns a dashboard object. The widgets property contains widget references, not their full parameters.

{
  "id": 123,
  "self": "https://api.tracker.yandex.net/v3/dashboards/123",
  "version": 4,
  "name": "Team plans",
  "layout": "one-column",
  "widgets": [
    {"id": "456", "self": "https://api.tracker.yandex.net/v3/widgets/456"}
  ]
}
Response parameters

Parameter

Description

Data type

id

Dashboard ID.

Number

self

URL of the API resource with dashboard parameters.

String

version

Dashboard version. Pass it when updating a dashboard.

Number

name

Dashboard name.

String

createdBy

Dashboard creator. User object fields.

Object

createdAt

Dashboard creation date and time.

String

layout

Widget display mode.

String

widgets

Dashboard widget references. The field is absent if the list is empty.

Array of objects

temp

Indicates a temporary dashboard.

Boolean

owner

Dashboard owner. User object fields.

Object

Fields of the widgets array elements

Parameter

Description

Data type

id

Widget ID.

String

self

URL of the API resource with widget parameters.

String

display

Widget name.

String

If the request is processed incorrectly, the API returns a response with an error code:

403
You are not authorized to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.

No access to the dashboard.

404
The requested object was not found. You may have specified an invalid object ID or key.
Previous
Copy a dashboard
Next
Update a dashboard