Creating a dashboard

Use this request to create a dashboard. Use the Creating a "Cycle time" widget request to add the "Cycle time" widget.

POST

https://api.tracker.yandex.net/v3/dashboards/

Request format

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

To create a widget, use an HTTP POST request. In the request body, specify the parameters in JSON format.

POST /v3/dashboards/
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "name": "<dashboard_name>",
    "layout": "<widget_display_mode>",
    "owner": {
       "id": "<user's_username_or_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 Cloud Organization organization is linked to Tracker. Learn more

  • 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 Cloud Organization.

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

Request body parameters

The request body contains the dashboard parameters.

Required parameters

Parameter Description Data type
name Dashboard name. String

Additional parameters

Parameter Description Data type
layout Widget display mode on the dashboard.
Available modes:
  • one-column: Default mode.
  • two-columns.
  • three-columns.
  • narrow-left-wide-right: The left column is narrow and the right column is wide.
  • one-top-two-bottom: One column at the top and two columns at the bottom.
 String
owner Username or ID of the dashboard owner. If the parameter is omitted, the user who created the dashboard is considered its owner. String

Response format

If the request is successful, the API returns a response with code 201 Created.

The response body contains a JSON object with the new dashboard's parameters.

{
   "id": 10,
   "version": 1,
   "name": "New Dashboard",
   "createdBy": {
      "self": "https://api.tracker.yandex.net/v3/users/44********",
      "id": "44********",
      "display": "Ivan Ivanov",
      "passportUid": 12********
   },
   "createdAt": "2024-04-15T19:38:42.074+0000",
   "layout": "one-column",
   "owner": {
      "self": "api.tracker.yandex.nett/v3/users/44********",
      "id": "44********",
      "display": "Ivan Ivanov",
      "passportUid": 12********
   },
   "self": "https://api.tracker.yandex.net/v3/dashboards/10"
}
Response parameters
Parameter Description Data type
id Dashboard ID. Number
version Dashboard version. The version number goes up whenever the dashboard is changed. Number
name Dashboard name. String
createdBy Object with the dashboard author's details. Map item
createdAt Dashboard creation date and time in YYYY-MM-DDThh:mm:ss.sss±hhmm format. String
layout Widget display mode on the dashboard. String
owner Object with the dashboard owner's details. Map item
self Address of the API resource that contains the dashboard parameters. String

createdBy and owner object fields

Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. Number
cloudUid Unique user ID in Yandex Cloud Organization String

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

400
One or more request parameters have an invalid value.
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.
404
The requested object was not found. You may have specified an invalid object ID or key.
422
JSON validation error, the request is rejected.
500
Internal service error. Try again later.
503
The API service is temporarily unavailable.
Previous
Creating a sprint
Next
Create a widget