Skip to content

Commit 4445e41

Browse files
committed
update to quick reference, update cross-links
AB#1943486: Sample reports and quick reference index
1 parent 3fdbcd8 commit 4445e41

17 files changed

+64
-33
lines changed

docs/report/analytics/analytics-best-practices.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ There are several reasons to follow best practices when querying Analytics, such
3434
- Minimize consumption of resources
3535
::: moniker-end
3636

37-
Follow the guidance provided below as you get started. If you are an extension developer, you'll also want to review [Query guidelines for Analytics with OData](../extend-analytics/odata-query-guidelines.md).
37+
Follow the guidance provided below as you get started. If you are an extension developer, you'll also want to review [OData Analytics query guidelines](../extend-analytics/odata-query-guidelines.md).
3838

3939

4040
[!INCLUDE [prerequisites-simple](../includes/analytics-prerequisites-simple.md)]
@@ -45,7 +45,7 @@ Query the Analytics metadata to gain familiarity with the entity types, entity s
4545

4646
In addition, you can review select information from these resources:
4747
- [Analytics OData metadata](../extend-analytics/analytics-metadata.md)
48-
- [Work item properties reference](../powerbi/analytics-fields-reference.md)
48+
- [Work tracking properties reference](../powerbi/analytics-fields-reference.md)
4949

5050

5151
## Structure your query to return the data you need
@@ -106,7 +106,7 @@ You specify columns of data to return using the `$select` clause. With customiza
106106

107107
For example, to return the ID, Work Item Type, Title, and State fields for a filtered set of work items, specify the following `$select` clause: `$select=WorkItemId, WorkItemType, Title, State`.
108108

109-
To lookup the list of properties and their corresponding field names, see [Work item properties reference](../powerbi/analytics-fields-reference.md).
109+
To lookup the list of properties and their corresponding field names, see [Work tracking properties reference](../powerbi/analytics-fields-reference.md).
110110

111111
<!--- General info
112112
Analytics is built on top of a Columnstore Index technology. That means that data is both storage and query processing is column-based. So, the more properties that a query references, the more expensive it's to process.
@@ -179,7 +179,7 @@ You can review usage for the service and for individuals by going to **Organizat
179179
- [What is the Analytics service?](../powerbi/what-is-analytics.md)
180180
- [Query the Analytics service in Azure DevOps](analytics-query-parts.md)
181181
- [Analytics OData metadata](../extend-analytics/analytics-metadata.md)
182-
- [Query guidelines for Analytics with OData](../extend-analytics/odata-query-guidelines.md)
182+
- [OData Analytics query guidelines](../extend-analytics/odata-query-guidelines.md)
183183

184184

185185

docs/report/analytics/analytics-query-parts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ Analytics returns the project names of those projects defined for the *fabrikam*
222222
## Related articles
223223
224224
- [What is the Analytics service?](../powerbi/what-is-analytics.md)
225-
- [Query guidelines for Analytics with OData](../extend-analytics/odata-query-guidelines.md)
225+
- [OData Analytics query guidelines](../extend-analytics/odata-query-guidelines.md)
226226
- [Permissions and prerequisites to access Analytics in Azure DevOps](analytics-permissions-prerequisites.md)
227227
228228
<!--- nice to have but not necessary

docs/report/extend-analytics/analytics-metadata.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ Aggregation annotations define the set of [transformations](./odata-supported-fe
231231
- [Organization and project-scoped queries](account-scoped-queries.md).
232232
- [Data available from Analytics](../powerbi/data-available-in-analytics.md)
233233
- [Query work tracking data using Analytics](analytics-recipes.md)
234-
- [Work item properties reference](../powerbi/analytics-fields-reference.md)
234+
- [Work tracking properties reference](../powerbi/analytics-fields-reference.md)
235235
236236
237237
## Related resources

docs/report/extend-analytics/analytics-recipes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Analytics. You can adapt most of these queries to meet your needs.
2020

2121
[!INCLUDE [temp](../includes/analytics-preview.md)]
2222

23-
For prerequisites and other information for getting started, see [Query your work tracking data using OData Analytics](wit-analytics.md) and [Work item properties reference](../powerbi/analytics-fields-reference.md). All examples are scoped to a project on Azure DevOps. For examples of organization-level scoping or Azure DevOps Server, see [Project and organization-scoped queries](account-scoped-queries.md).
23+
For prerequisites and other information for getting started, see [Query your work tracking data using OData Analytics](wit-analytics.md) and [Work tracking properties reference](../powerbi/analytics-fields-reference.md). All examples are scoped to a project on Azure DevOps. For examples of organization-level scoping or Azure DevOps Server, see [Project and organization-scoped queries](account-scoped-queries.md).
2424

2525
::: moniker range="azure-devops"
2626
> [!TIP]
@@ -389,4 +389,4 @@ The response returns two work items.
389389

390390
- [WIT analytics](wit-analytics.md)
391391
- [Aggregate data](aggregated-data-analytics.md)
392-
- [Query guidelines for Analytics with OData](odata-query-guidelines.md)
392+
- [OData Analytics query guidelines](odata-query-guidelines.md)

docs/report/extend-analytics/data-model-analytics-service.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ The following table provides _*a partial list*_ of the **WorkItemRevision** enti
173173
174174
## Related articles
175175
176-
- [Query guidelines for Analytics with OData](odata-query-guidelines.md)
176+
- [OData Analytics query guidelines](odata-query-guidelines.md)
177177
- [WIT analytics](wit-analytics.md)
178178
- [Aggregate data](aggregated-data-analytics.md)
179179
- [Exploring Analytics OData metadata](analytics-metadata.md)

docs/report/extend-analytics/odata-query-guidelines.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
2-
title: Query guidelines for Analytics with OData
2+
title: OData Analytics query guidelines
33
titleSuffix: Azure DevOps
44
description: Learn how to write good OData queries that access Analytics for Azure DevOps.
55
ms.technology: devops-analytics
66
ms.author: kaelli
77
author: KathrynEE
88
ms.topic: conceptual
99
monikerRange: '>= azure-devops-2019'
10-
ms.date: 09/30/2020
10+
ms.date: 08/12/2022
1111
---
1212

13-
# Query guidelines for Analytics with OData
13+
# OData Analytics query guidelines for Azure DevOps
1414

1515
[!INCLUDE [version-gt-eq-2019](../../includes/version-gt-eq-2019.md)]
1616

docs/report/extend-analytics/quick-ref.md

+41-10
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,27 @@ ms.date: 08/12/2022
1616
[!INCLUDE [version-gt-eq-2019](../../includes/version-gt-eq-2019.md)]
1717

1818
Use this quick reference to access information and sample queries using OData and Analytics.
19-
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.
20-
21-
19+
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.
2220

2321
## Get started
2422

23+
If you're new to Analytics, we recommend that you review the following articles.
24+
25+
- [Data available and versioning](../powerbi/data-available-in-analytics.md)
2526
- [Query Analytics data or metadata](../analytics/analytics-query-parts.md)
2627
- [Supported tools to use with Analytics](../analytics/analytics-query-tools.md)
2728
- [Summary of best practices to use when querying Analytics](../analytics/analytics-best-practices.md)
2829
- [Permissions and prerequisites for working with Analytics](../analytics/analytics-permissions-prerequisites.md)
2930

31+
32+
## Sample widgets and reports
3033

34+
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.
35+
36+
37+
[!INCLUDE [temp](../../includes/version-selector-minimize.md)]
3138

3239

33-
## Sample reports
34-
3540
<!--- include built-in reports and widgets -->
3641

3742
::: moniker range=">= azure-devops-2020"
@@ -111,12 +116,27 @@ Using OData, you can directly query Analytics for Azure DevOps from a supported
111116
:::column-end:::
112117
:::row-end:::
113118
---
114-
---
119+
115120
::: moniker-end
116121

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

119-
[!INCLUDE [temp](../powerbi/includes/sample-fulllist.md)]
124+
For Azure DevOps Server 2019, only Azure Boards work tracking data is available from Analytics.
125+
126+
- [Bug trend](../powerbi/sample-boards-bugtrend.md) (Power BI)
127+
- [Burndown/Burnup](../dashboards/configure-burndown-burnup-widgets.md) (widget)
128+
- [Cumulative Flow Diagram (CFD)](../dashboards/cumulative-flow.md) (Built-in report, widget)
129+
- [Cumulative Flow Diagram (CFD)](../powerbi/sample-boards-cfd.md) (Power BI)
130+
- [Feature progress](../powerbi/sample-boards-featureprogress.md) (Power BI)
131+
- [Lead/Cycle Time](../dashboards/cycle-time-and-lead-time.md) (widget)
132+
- [Lead/Cycle Time](../powerbi/sample-boards-leadcycletime.md) (Power BI)
133+
- [Open bugs](../powerbi/sample-boards-openbugs.md) (Power BI)
134+
- [Rollup](../powerbi/sample-boards-rollup.md) (Power BI)
135+
- [Work items and direct links](../powerbi/sample-boards-directlinks.md) (Power BI)
136+
- [Release burndown](../powerbi/sample-boards-releaseburndown.md) (Power BI)
137+
- [Sprint burndown](../dashboards/configure-sprint-burndown.md) (Built-in report, widget)
138+
- [Sprint burndown](../powerbi/sample-boards-sprintburndown.md) (Power BI)
139+
- [Velocity](../dashboards/team-velocity.md) (Built-in report, widget)
120140

121141
::: moniker-end
122142

@@ -235,17 +255,28 @@ Using OData, you can directly query Analytics for Azure DevOps from a supported
235255

236256
## Reference
237257

258+
- [Work tracking properties reference](../powerbi/analytics-fields-reference.md)
259+
- [Analytics views dataset design](../powerbi/data-connector-dataset.md)
260+
- [Supported OData functions and clauses](odata-supported-features.md)
261+
- [OData API versioning](odata-api-version.md)
262+
- [Performance & latency](../powerbi/performance-latency.md)
263+
238264

239265
## Troubleshooting
240266

267+
- [OData Analytics query guidelines for Azure DevOps](odata-query-guidelines.md)
268+
- [Resolve errors associated with an Analytics view](../powerbi/troubleshooting-views.md)
269+
270+
## Marketplace extensions
271+
272+
- [WIQL to OData](https://marketplace.visualstudio.com/items?itemName=ms-eswm.wiql-to-odata)
273+
- [OData for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=stansw.vscode-odata)
274+
241275

242276
## Related articles
243277

244278
- [Power BI](../powerbi/overview.md)
245279
- [Dashboards, charts, reports, & widgets](../dashboards/overview.md)
246280
- [OData Extension for Data Aggregation Version 4.0](https://docs.oasis-open.org/odata/odata-data-aggregation-ext/v4.0/cs01/odata-data-aggregation-ext-v4.0-cs01.html)
247281

248-
### Marketplace extensions
249282

250-
- [WIQL to OData](https://marketplace.visualstudio.com/items?itemName=ms-eswm.wiql-to-odata)
251-
- [OData for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=stansw.vscode-odata)

docs/report/powerbi/analytics-default-views.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Each default Analytics view provides a combination of options for work item type
6464

6565
Default views automatically include the most common fields for the included work item types used for reporting. All custom fields are included.
6666

67-
For example, the following fields are included when filtered for bugs and user stories. You can look up the description of most of these fields from the [Work item properties reference](analytics-fields-reference.md) or [Work item field index](../../boards/work-items/guidance/work-item-field.md).
67+
For example, the following fields are included when filtered for bugs and user stories. You can look up the description of most of these fields from the [Work tracking properties reference](analytics-fields-reference.md) or [Work item field index](../../boards/work-items/guidance/work-item-field.md).
6868

6969
> [!div class="mx-imgBorder"]
7070
> ![Analytics views common fields](media/editable-views/common-fields.png)
@@ -84,7 +84,7 @@ In these cases, you can [create a custom Analytics view](analytics-views-create.
8484
- [Data available from Analytics](data-available-in-analytics.md)
8585
- [Dataset design for the Power BI Azure DevOps Connector](data-connector-dataset.md)
8686
- [Grant permissions to access Analytics](./analytics-security.md)
87-
- [Work item properties reference](analytics-fields-reference.md)
87+
- [Work tracking properties reference](analytics-fields-reference.md)
8888

8989

9090
## Related resources

docs/report/powerbi/analytics-fields-reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ The following surrogate keys (SK) properties can be used to filter or construct
214214

215215
- [About work item fields and attributes](../../boards/work-items/work-item-fields.md)
216216
- [Index of work item fields](../../boards/work-items/guidance/work-item-field.md)
217-
- [Query guidelines for Analytics with OData](../extend-analytics/odata-query-guidelines.md)
217+
- [OData Analytics query guidelines](../extend-analytics/odata-query-guidelines.md)
218218
- [Work tracking, process, and project limits](../../organizations/settings/work/object-limits.md)
219219

220220

docs/report/powerbi/analytics-historical-filtering.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,5 +84,5 @@ To restate, when reporting on historical data, all filters are applied to the wo
8484

8585
## Related articles
8686

87-
- [Work item properties reference](analytics-fields-reference.md)
87+
- [Work tracking properties reference](analytics-fields-reference.md)
8888
- [Data model for Analytics](../extend-analytics/data-model-analytics-service.md)

docs/report/powerbi/analytics-views-create.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Enter a name for the view and provide a description. To allow others to view and
7474

7575
### Specify Work items filters
7676

77-
Specify filters to reduce the number of results returned by your view. In the work items section, you can add different filters on work item fields to scope your data. For a description of each available field, see [Work item properties reference](analytics-fields-reference.md).
77+
Specify filters to reduce the number of results returned by your view. In the work items section, you can add different filters on work item fields to scope your data. For a description of each available field, see [Work tracking properties reference](analytics-fields-reference.md).
7878
> [!div class="mx-imgBorder"]
7979
> ![Specify Work items filters.](media/editable-views/work-items-default.png)
8080

docs/report/powerbi/analytics-views-manage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ To delete a view, select the :::image type="icon" source="../media/icons/actions
104104
- [Grant permissions to access Analytics](./analytics-security.md)
105105
- [Power BI integration overview](overview.md)
106106
- [Query work tracking data using Analytics](../extend-analytics/analytics-recipes.md)
107-
- [Work item properties reference](analytics-fields-reference.md)
107+
- [Work tracking properties reference](analytics-fields-reference.md)
108108

109109

110110
## Related resources

docs/report/powerbi/data-connector-dataset.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ You can select all work tracking fields in an Analytics view, except for the fol
4848
> [!IMPORTANT]
4949
> Identity or person-name fields, such as Created By, Assigned To, etc., are selectable fields, however you can't select these fields at this time as field criteria for the purposes of filtering work items.
5050
51-
For a description of each work item tracking fields, see [Work item properties reference](analytics-fields-reference.md).
51+
For a description of each work item tracking fields, see [Work tracking properties reference](analytics-fields-reference.md).
5252

5353

5454
### Analytics data store fields

docs/report/powerbi/toc.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ items:
176176
href: ../extend-analytics/odata-api-version.md
177177
- name: Troubleshooting
178178
items:
179-
- name: Query guidelines
179+
- name: Odata Analytics query guidelines
180180
href: ../extend-analytics/odata-query-guidelines.md
181181
- name: Performance & latency
182182
href: performance-latency.md

docs/report/powerbi/what-are-analytics-views.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ For more information on how the dataset is modeled when using the Power BI Data
9191
- [What is Power BI Desktop?](/power-bi/fundamentals/desktop-what-is-desktop)
9292
- [Data available from Analytics](data-available-in-analytics.md)
9393
- [Query work tracking data using Analytics](../extend-analytics/analytics-recipes.md)
94-
- [Work item properties reference](analytics-fields-reference.md)
94+
- [Work tracking properties reference](analytics-fields-reference.md)
9595

9696

9797
## Related resources

docs/report/sql-reports/analytics-insights-comparable-sql-reports.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ The following table summarizes Analytics reports, widgets, and other tools that
300300

301301
## Next steps
302302
> [!div class="nextstepaction"]
303-
> [Work item properties reference](../powerbi/analytics-fields-reference.md)
303+
> [Work tracking properties reference](../powerbi/analytics-fields-reference.md)
304304
305305

306306
## Related articles

docs/report/sql-reports/migration-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The following tools support interaction with the Analytics service:
6868

6969
### Query guidelines, query performance and latency
7070

71-
Analytics is not a real-time time store. It is a curated copy of data stored in Azure DevOps. The data copy helps optimize read and aggregation performance, and reduces the effect reporting scenarios have on Azure DevOps. Copying the data introduces up to a 30-second delay before the data associated with any one change shows up in Analytics. To learn more, see [Query guidelines for Analytics with OData](../extend-analytics/odata-query-guidelines.md).
71+
Analytics is not a real-time time store. It is a curated copy of data stored in Azure DevOps. The data copy helps optimize read and aggregation performance, and reduces the effect reporting scenarios have on Azure DevOps. Copying the data introduces up to a 30-second delay before the data associated with any one change shows up in Analytics. To learn more, see [OData Analytics query guidelines](../extend-analytics/odata-query-guidelines.md).
7272

7373

7474
### Analytics permissions

0 commit comments

Comments
 (0)