Dashboards

Last Update: 11/7/2016

Team Services

This API is in preview. Learn more

api-version = 3.0-preview.2

Each team in VS Team Services can have one or more dashboards. Each dashboard contains one or more widgets. Each team in Team Services can have one or more dashboards. Each dashboard is made up of one or more widgets.

Data versioning

The rest APIs have multi-user concurrency support for a list of widgets and for each widget, separately. This prevents one user of the API from overwriting changes of another user.

Lists of widgets are versioned using the eTag header in the list APIs. You must retrieve current eTag, and then provide that same eTag when updating the list.

The widget contract also contains the eTag property and works same way. This versions the settings of a single widget. This version is separate from the list version and you must provide it when updating a single widget.

Common tasks

Create a new dashboard

Add a team dashboard.

Add a new widget to a dashboard

Add or delete a widget from a given dashboard.