Delen via

View the OData query behind an Analytics report or widget

  • Artikel

Azure DevOps Server 2019

Several built-in Analytics reports and widgets are supported. You can view the OData query used to generate these reports by following the steps outlined in this article. You can then adapt that OData query as needed to generate other reports using Power BI.

Note

The Analytics service is in preview for Azure DevOps Server 2019. You can enable or install it for a project collection. Power BI integration and access to the OData feed of the Analytics Service are in Preview. We encourage you to use it and give us feedback.

Available data is version-dependent. The latest supported version is v2.0, and the latest preview version is v4.0-preview. For more information, see OData API versioning.

For a list of built-in Analytics reports and widgets, see About dashboards, charts, reports, & widgets and Widgets based on Analytics data.

Prerequisites

Category Requirements
Access levels - Project member.
- At least Basic access.
Permissions By default, project members have permission to query Analytics and create views. For more information about other prerequisites regarding service and feature enablement and general data tracking activities, see Permissions and prerequisites to access Analytics.

Open the Analytics report

Open the report of interest. For details, choose one of the links provided below. If you are working to get the OData query behind a widget, we recommend that you create a dashboard with just the widget displayed.

Boards Pipelines & Test
- Cumulative Flow Diagram (CFD)
- Sprint burndown
- Velocity chart		 - Build test results
- Code coverage
- Release test results
- Trace test requirements
- Test analytics
- Test failures
- Test impact analysis

Open Developer Tools for your browser

Press the F12 key to open the Developer Tools for your browser. Open the Network tab and scroll down to find the entry with the OData query. The following table lists the beginning text of entries for select reports. Double-click the entry to open the OData query.

Report Entry begins with
Cycle Time widget WorkItems?%24apply=filter
Cumulative Flow Diagram BoardLocations?%24apply=filter
Sprint Burndown BoardLocations?%24apply=filter
Velocity Iterations?%24filter=Teams

Sample OData query, Velocity chart

The following syntax represents the OData query for a velocity chart set to show six iterations.

{
  "@odata.context": "https://analytics.dev.azure.com/fabrikam/677da0fb-b067-4f77-b89b-f32c12bb8617/_odata/v4.0-preview/$metadata#Iterations(IterationSK,IterationName,StartDate,EndDate,IsEnded,IterationPath)",
  "value": [
    {
      "IterationSK": "5b25cc74-aeb3-4f13-8084-1e899d7383b5",
      "IterationName": "06_2022",
      "IterationPath": "FabrikamProject\\CY2022\\06_2022",
      "StartDate": "2022-06-01T00:00:00-07:00",
      "EndDate": "2022-06-30T23:59:59.999-07:00",
      "IsEnded": false
    },
    {
      "IterationSK": "a9219cb0-21c0-48f4-8c88-83d0ae3187db",
      "IterationName": "05_2022",
      "IterationPath": "FabrikamProject\\CY2022\\05_2022",
      "StartDate": "2022-05-01T00:00:00-07:00",
      "EndDate": "2022-05-31T23:59:59.999-07:00",
      "IsEnded": true
    },
    {
      "IterationSK": "8668264f-465d-4d69-b2b5-f5de742447d4",
      "IterationName": "04_2022",
      "IterationPath": "FabrikamProject\\CY2022\\04_2022",
      "StartDate": "2022-04-01T00:00:00-07:00",
      "EndDate": "2022-04-30T23:59:59.999-07:00",
      "IsEnded": true
    },
    {
      "IterationSK": "4933928f-3e08-4cf9-901a-13cc32201944",
      "IterationName": "03_2022",
      "IterationPath": "FabrikamProject\\CY2022\\03_2022",
      "StartDate": "2022-03-01T00:00:00-08:00",
      "EndDate": "2022-03-31T23:59:59.999-07:00",
      "IsEnded": true
    },
    {
      "IterationSK": "a690f087-bd77-42dc-b5aa-f34f64ed67b3",
      "IterationName": "02_2022",
      "IterationPath": "FabrikamProject\\CY2022\\02_2022",
      "StartDate": "2022-02-01T00:00:00-08:00",
      "EndDate": "2022-02-28T23:59:59.999-08:00",
      "IsEnded": true
    },
    {
      "IterationSK": "edae3d3e-4357-4bae-9e25-f01719f48bb7",
      "IterationName": "01_2022",
      "IterationPath": "FabrikamProject\\CY2022\\01_2022",
      "StartDate": "2022-01-01T00:00:00-08:00",
      "EndDate": "2022-01-31T23:59:59.999-08:00",
      "IsEnded": true
    }
  ]
}