Extend Analytics with OData quick reference

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2020 | Azure DevOps Server 2019

Using OData, you can directly query Analytics for Azure DevOps from a supported browser. Use the returned JSON data as you like. Enterprise organizations generate queries that span multiple projects or the entire organization in Azure DevOps.

Use this quick reference to access information and sample queries using OData and Analytics. You can find more OData query examples in the Overview of sample reports using OData queries articles.

Supported tasks

• 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 Iteration Path
• Filter data with query filter clause
  
  
• Generate multiple aggregations
• Generate calculated properties
• Generate a Cumulative Flow Diagram
• Group results using groupby

• Query a single 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 data from related entities
• Return parent of work items
• Return specific columns or fields
• Set permissions
• Sort results
• View OData query behind a report or widget

Key concepts

• 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

• 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

• 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

Related articles

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

Marketplace extensions

• WIQL to OData