| title | titleSuffix | description | ms.subservice | ms.assetid | ms.author | author | ms.topic | monikerRange | ms.date |
|---|---|---|---|---|---|---|---|---|---|
Data model for Analytics |
Azure DevOps |
Learn about the EntityTypes and relationships provided by Analytics for Azure DevOps. |
azure-devops-analytics |
032FB76F-DC43-4863-AFC6-F8D67963B177 |
chcomley |
chcomley |
conceptual |
<=azure-devops |
09/19/2022 |
[!INCLUDE version-gt-eq-2019]
The Analytics data model for Azure DevOps consists of entity sets, whose members (entities) contain properties that can be filtered, aggregated, and summarized. Additionally, they contain navigation properties that relate entities to one other, providing access to other properties for selecting, filtering, and grouping.
[!INCLUDE temp]
The Analytics data model is based on two schema namespaces:
Microsoft.VisualStudio.Services.Analytics.ModelMicrosoft.VisualStudio.Services.Analytics.
Entity types are named structured types with a key. They define the named properties and relationships of each entity. The key of an EntityType is formed from a subset of the primitive properties, for example—WorkItemId, PipelineId, ReleasePipelineId—and more of the entity type.
Entity sets are named collections of entities. For example, WorkItems is an entity set containing WorkItem entities. An entity's key uniquely identifies the entity within an entity set. If multiple entity sets use the same entity type, the same combination of key values can appear in more than one entity set and identifies different entities, one per entity set where this key combination appears. Each of these entities has a different entity-id. Entity sets provide entry points into the data model.
Entity sets are described in OData metadata, and vary by project. You can explore the complete list of entity sets, entity types, and properties by requesting the OData metadata for your project. To learn how, see Construct OData queries for Analytics.
Composite entities support specific scenarios. They're composed from simpler entities, often require more computing resources to generate, and may return larger result sets. To achieve the best performance and avoid unnecessary throttling, ensure that you query the correct entity for your scenario.
For example, WorkItemSnapshot combines WorkItemRevisions and Dates such that each date has one revision for each work item. This representation supports OData queries that focus on-trend data for a filtered set of work items. However, you shouldn't use this composite entity to query the current state of work items. Instead, you should use the WorkItems entity set to generate a more quick-running query.
Similarly, some entities may contain all historic values, while others may only contain current values. WorkItemRevisions contains all work item history, which you shouldn't use in scenarios where the current values are of interest.
To generate more complex query results, you can combine entities using relationships. You can employ relationships to expand, filter, or summarize data.
Some navigation properties result in a single entity, while others result in a collection of entities. The following diagram shows select entities and their navigation properties. For clarity, some composite entities and relationships have been omitted.
Entity relationships are also represented as foreign keys so that external tools can join entities. These properties have the suffix "SK", and are either integer or GUID data types. Date properties have corresponding integer date key properties with the following format: YYYYMMDD.
The following entity types and entity sets are supported with the indicated API versions. For a complete reference, see Work tracking metadata reference for Azure Boards Analytics.
[!div class="mx-tdCol2BreakAll"]
EntityType/EntitySetDescription v1.0 v2.0 v3.0-preview v4.0-preview Area/
AreasThe work item Area Paths, with properties for grouping and filtering by area hierarchy. ✔️ ✔️ ✔️ ✔️ Iteration/
IterationsThe work item Iteration Paths, with properties for grouping and filtering by iteration hierarchy. ✔️ ✔️ ✔️ ✔️ BoardLocation/
BoardLocationsThe board cell locations, as identified by board column, swimlane, and split, includes historic board settings. For a description of each board field, see Workflow and board fields. ✔️ ✔️ ✔️ ✔️ CalendarDate/
DatesThe dates used to filter and group other entities using relationships. ✔️ ✔️ ✔️ ✔️ Project/
ProjectsAll projects defined for an organization (cloud) or project collection (on-premises). ✔️ ✔️ ✔️ ✔️ Process/
ProcessesBacklog information used to expand or filter work items and work item types. For an example that uses Processes to filter a report, see Requirements tracking sample report. ✔️ ✔️ ✔️ Tag/
TagsAll work item tags for each project. For an example that uses Tags to filter a report, see Release burndown sample report. ✔️ ✔️ ✔️ ✔️ Team/
TeamsAll teams defined for the project. For an example that uses Teams to filter a report, see Add a Team slicer to a Power BI report. ✔️ ✔️ ✔️ ✔️ User/
UsersUser information that is used to expand or filter various work item properties, for example Assigned To, Created By. ✔️ ✔️ ✔️ ✔️ WorkItemBoardSnapshot/
WorkItemBoardSnapshot(Composite) The state of each work item on each calendar date, including board location, used to generate trend reports. For a sample report, see Cumulative Flow Diagram (CFD) sample report. ✔️ ✔️ ✔️ ✔️ WorkItemLink/
WorkItemLinksThe links between work items, for example, Child, Parent, and Related. Includes only the latest revision of links, no history. Hyperlinks aren't included. ✔️ ✔️ ✔️ ✔️ WorkItemRevision/
WorkItemRevisionsAll historic work item revisions, including the current revision. Does not include deleted work items. ✔️ ✔️ ✔️ ✔️ WorkItemSnapshot/
WorkItemSnapshot(Composite) The state of each work item on each calendar date, used to support trend reporting. For a sample report, see Bug trends sample report. ✔️ ✔️ ✔️ ✔️ WorkItem/
WorkItemsThe current state of work items. Used to support status reports. For a sample report, see Rollup child work item values to parent sample report. ✔️ ✔️ ✔️ ✔️ WorkItemTypeField/
WorkItemTypeFieldsThe work item properties for each work item type and process. Used to support building reports. ✔️ ✔️ ✔️ ✔️
::: moniker range=">= azure-devops-2020"
The following entity types and entity sets are supported with the v3.0-preview or v4.0-preview Analytics version. For a complete reference, see Pipeline metadata reference .
[!div class="mx-tdCol2BreakAll"]
EntityType/EntitySet Description v3.0-preview v4.0-preview Branch/
BranchesBasic information about branches used in tests or pipelines. For a sample report, see Progress status sample report. ✔️ ✔️ ParallelPipelineJobsSnapshot/
ParallelPipelineJobsSnapshot(Composite) Supports understanding of parallel pipeline consumption. For more information about parallel pipeline tests, see Run tests in parallel using the Visual Studio Test task. ✔️ Pipeline/
PipelinesProperties for a pipeline. ✔️ ✔️ PipelineJob/
PipelineJobsIndividual execution results for a specific Test associated with a TestRun ✔️ ✔️ PipelineRun/
PipelineRunsExecution information for pipelines. For a sample report, see Pipeline pass rate trend sample report. ✔️ ✔️ PipelineRunActivityResult/
PipelineRunActivityResultsMerged log of all the stages, steps, jobs, and tasks within a specific pipeline execution. For a sample report, see Pipeline task duration sample report. ✔️ ✔️ PipelineTask/
PipelineTasksProperties for tasks that are used within a pipeline. ✔️ ✔️ TaskAgentPoolSizeSnapshot/
TaskAgentPoolSizeSnapshots(Composite) Supports understanding of pool size, pipeline jobs, and concurrency. The Historical graph for agent pools illustrates how this entity set can be used. ✔️ TaskAgentRequestSnapshot/
TaskAgentRequestSnapshots(Composite) ✔️
::: moniker-end
::: moniker range=">= azure-devops-2020"
The following entity types and entity sets are supported with the v3.0-preview or v4.0-preview Analytics version. For a complete reference, see Test metadata reference.
[!div class="mx-tdCol2BreakAll"]
EntityType/EntitySetDescription v3.0-preview v4.0-preview TestConfiguration/
TestConfigurationsTest plan configuration information. For details on configuring tests, see Test different configurations ✔️ ✔️ TestResult/
TestResultsIndividual execution results for a specific Test associated with a TestRun. ✔️ ✔️ TestResultsDaily/
TestResultsDailyA daily snapshot aggregate of TestResult executions, grouped by Test (not TestRun). For a sample report, see Test summary trend sample report. ✔️ ✔️ TestRun/
TestRunsExecution information for tests run under a pipeline with aggregate TestResult. ✔️ ✔️ Test/
TestsProperties for a test case, such as test name and test owner. For details on defining test cases, see Create manual test cases. ✔️ ✔️ TestPoint/
TestPointsExecution information for test points. A test point is a unique combination of test case, test suite, configuration, and tester. For a sample report, see Progress status sample report. ✔️ ✔️ TestPointHistorySnapshot/
TestPointHistorySnapshots(Composite) Individual execution results for a specific Test associated with a TestRun. For a sample report, see Manual test execution trend sample report ✔️ ✔️ TestSuite/
TestSuitesTest suites information. For details on defining test suites, see Create test plans and test suites. ✔️ ✔️
::: moniker-end