quick-ref.md

title	titleSuffix	description	ms.subservice	ms.reviewer	ms.author	author	ms.topic	monikerRange	ms.date
Sample reports and quick reference index for the Analytics service	Azure DevOps	An index of articles that explain how to generate results using OData backed Analytics for Azure DevOps.	azure-devops-analytics	desalg	chcomley	chcomley	conceptual	>= azure-devops-2019	08/12/2022

Sample reports and quick reference index

[!INCLUDE version-gt-eq-2019]

Use this quick reference to access information and sample queries using OData and Analytics.
Using OData, you can directly query Analytics for Azure DevOps from a supported browser. Use the returned JSON data as you like. Enterprise organizations can generate queries that span multiple projects or an entire organization or project collection.

Get started

If you're new to Analytics, we recommend that you review the following articles.

• Data available and versioning
• Query Analytics data or metadata
• Supported tools to use with Analytics
• Summary of best practices to use when querying Analytics
• Permissions and prerequisites for working with Analytics

[!INCLUDE temp]

Analytics supports several widgets and built-in reports. In addition, we've created several sample reports to showcase how to query the data and build the reports of interest using Power BI.

Azure Boards sample widgets and reports

:::row::: :::column span="1"::: Widgets and built-in reports - Cumulative Flow Diagram (CFD)
- Lead/Cycle Time
- Sprint burndown
- Velocity :::column-end::: :::column span="1"::: Sample reports - Bug trend
- Cumulative Flow Diagram (CFD) - Feature progress - Lead/Cycle Time - Open bugs - Rollup - Work items and direct links - Release burndown
- Sprint burndown :::column-end::: :::row-end:::

::: moniker range=">= azure-devops-2020"

Azure Pipelines sample widgets and reports

• Built-in reports
  - Test failures report

• Sample reports
  - Outcome summary
  - Outcome summary for all pipelines
  - Pass rate trend - Stage wise failures
  - Duration
  - Duration trend
  - Task duration
  - Task duration trend
  - Test summary
  - Test summary trend
  - Failed tests
  - Flaky tests
  - Test duration
  - Test duration trend
  - Pass rate trend of a test

Azure Test Plans sample widgets and reports

• Widgets and built-in reports
  - Chart for Test Plans - Requirements traceability - Test Progress - Test Results Trend

• Sample reports
  - Configuration by outcome matrix
  - Execution Trend
  - Progress status
  - Requirements tracking - Requirements tracking - Rollup - Test suites aggregated view
  - Tester by outcome matrix

::: moniker-end

Key concepts

:::row::: :::column span=""::: - Aggregation extensions support
- Analytics OData metadata
- Analytics
- API versioning
- Batch endpoint for long queries

- Case insensitivity
- Column limit
- Client-driven paging
- Columnstore Index technology
- Composite entities
- Containers

- Data availability
- Data latency
- Data model
:::column-end::: :::column span=""::: - EntityTypes
- Entity keys
- Entity properties
- Filter by dates
- Filter by surrogate keys
- Filter by tags

- Long queries guidance
- Maximum size of returned data
- Metadata annotations
- Metadata response
- Navigational properties

- OData evaluation order
- OData supported clauses
- OData supported functions
- OData unsupported functions
:::column-end::: :::column span=""::: - Project-level security restrictions
- Parent/Child hierarchy

- Query guidelines
- Query fails and timeouts
- Query restrictions
- Query performance
- Query performance guidelines
- Query style guidelines

- Relationships
- Server-driven paging
- Snapshot entities
- Tag names
- Time zone filter
- Weekly or monthly snapshots for trend queries
:::column-end::: :::row-end:::

Tasks

:::row::: :::column span="1"::: - Aggregate data, apply extension
- Aggregate data, OData aggregation extension
- Aggregate data, simple count
- Collection-scoped queries
- Construct a basic query
- Create an Analytics widget

- Enforce server-side paging
- Filter aggregated results
- Filter by Area Path
- Filter by Changed Date
- Filter by Identity field
- Filter by Iteration Path
- Filter data with query filter clause

- Generate multiple aggregations
- Generate calculated properties
- Generate a Cumulative Flow Diagram
- Group results using groupby

:::column-end::: :::column span="1"::: - Query an entity set
- Query based on Iteration Path
- Query based on Area Path
- Query based on Changed Date
- Query based on Tags
- Query based on Team
- Query based on Was Ever

- Query work item count - Query for linked work items
- Query for non-hierarchical links
- Query metadata
- Query trend data
- Query work item history

- Organization-scoped queries
- Project-scoped queries
- Return a count of work items
- Return data from related entities
- Return parent of work items
- Return specific properties or fields
- Set permissions
- Sort results
- View OData query behind a report or widget :::column-end::: :::row-end:::

Metadata reference

::: moniker range=">= azure-devops-2020"

• Calendar date, Project, and User
• Azure Boards
• Azure Pipelines
• Test Plans ::: moniker-end

::: moniker range="azure-devops-2019"

• Calendar date, Project, and User
• Azure Boards

::: moniker-end

Data model reference and troubleshooting

• Analytics views dataset design
• Supported OData functions and clauses
• OData API versioning
• Performance & latency
• OData Analytics query guidelines for Azure DevOps
• Resolve errors associated with an Analytics view

Marketplace extensions

• WIQL to OData
• OData for Visual Studio Code

Related articles

• Power BI
• Dashboards, charts, reports, & widgets
• OData Extension for Data Aggregation Version 4.0