Запрос данных отслеживания работы с помощью Аналитики

Статья
03/21/2024

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

Вы можете запросить данные отслеживания работы Azure DevOps с помощью основных запросов, приведенных в этой статье. Эти запросы устраняют повседневные потребности при демонстрации различных возможностей аналитики. Большинство этих запросов можно адаптировать в соответствии с вашими потребностями.

Эта статья создает сведения, предоставленные в запросах OData конструктора для аналитики и метаданных для Аналитики Boards.

Примечание.

Служба Аналитики автоматически включается и поддерживается в рабочей среде для всех Служб Azure DevOps Services. Интеграция Power BI и доступ к веб-каналу OData службы Аналитики общедоступны. Мы рекомендуем вам использовать его и дать нам отзыв. Доступные данные зависят от версий. Последняя поддерживаемая версия: v2.0последняя предварительная версия v4.0-preview. Дополнительные сведения см. в разделе "Управление версиями API OData".

Примечание.

Служба Аналитики автоматически устанавливается и поддерживается в рабочей среде для всех новых коллекций проектов для Azure DevOps Server 2020 и более поздних версий. Интеграция Power BI и доступ к веб-каналу OData службы Аналитики общедоступны. Мы рекомендуем вам использовать его и дать нам отзыв. При обновлении с Azure DevOps Server 2019 можно установить службу Аналитики во время обновления.

Доступные данные зависят от версий. Последняя поддерживаемая версия: v2.0последняя предварительная версия v4.0-preview. Дополнительные сведения см. в разделе "Управление версиями API OData".

Примечание.

Служба Аналитики доступна в предварительной версии для Azure DevOps Server 2019. Его можно включить или установить для коллекции проектов. Интеграция Power BI и доступ к веб-каналу OData службы аналитики находятся в предварительной версии. Мы рекомендуем вам использовать его и дать нам отзыв.

Необходимые компоненты

Доступ. Быть членом проекта с по крайней мере базовым доступом.
Разрешения. По умолчанию члены проекта имеют разрешение на запросы аналитики и создания представлений.
Дополнительные сведения о других предварительных требованиях для включения служб и функций и общих действий отслеживания данных см. в разделе "Разрешения и предварительные требования для доступа к аналитике".

Все примеры относятся к проекту в Azure DevOps. Примеры области на уровне организации или Azure DevOps Server см. в запросах с областью действия проекта и организации.

Совет

Вы можете использовать расширение WIQL для OData Azure DevOps Marketplace для быстрого создания запроса OData на основе запроса рабочего элемента на странице "Запросы ". Это расширение поддерживает преобразование неструктурированного списка рабочих элементов и рабочих элементов и прямых ссылок. Расширения не поддерживаются функциями Azure Boards и поэтому не поддерживаются командой продуктов. С вопросами, предложениями или проблемами, возникающими у вас при использовании этих расширений, обращайтесь на страницу соответствующего расширения.

Фильтрация рабочих элементов на основе даты изменения

Вы запрашиваете WorkItems набор сущностей для списка рабочих элементов, которые соответствуют условиям поля.

Следующий запрос возвращает элементы невыполненной работы продукта, ошибки и компоненты с измененной датой, превышающей 12 декабря 2021 года.

https://analytics.dev.azure.com/{OrganizationName}/{ProjectName}/_odata/v1.0/WorkItems?
  $select=WorkItemId, WorkItemType, Title, State 
  &$expand=AssignedTo($select=UserEmail)
  &$filter=(Project/ProjectName eq 'Fabrikam Fiber'
    AND (WorkItemType eq 'Product Backlog Item' or WorkItemType eq 'Bug' or WorkItemType eq 'Feature')
    AND ChangedOn/Date ge 2021-12-16T23:44:15.619Z)
  &$orderby=WorkItemType desc

Фильтрация рабочих элементов на основе области

Вы можете изменить следующий запрос, чтобы вывести список всех рабочих элементов в рамках определенного пути области.

https://analytics.dev.azure.com/{OrganizationName}/{ProjectName}/_odata/{version}/WorkItems?
  $filter=Area/AreaPath eq '{area path}'
  &$select=WorkItemId, Title, State

Пример запроса:

Например, следующий синтаксис запрашивает количество рабочих элементов для каждого проекта, определенного для организации fabrikam .

https://analytics.dev.azure.com/fabrikam/_odata/v4.0-preview/WorkItems?$apply=groupby((Project/ProjectName), aggregate($count as Count))

Пример ответа:

Ответ возвращает данные для следующих пяти проектов.

{
   "@odata.context":"https://analytics.dev.azure.com/fabrikam/_odata/v4.0-preview/$metadata#WorkItems(Project(ProjectName),Count)",
   "value":[
      {
         "@odata.id":null,
         "Count":2,
         "Project":{
            "@odata.id":null,
            "ProjectName":"Basic Fabrikam"
         }
      },
      {
         "@odata.id":null,
         "Count":19,
         "Project":{
            "@odata.id":null,
            "ProjectName":"Demo 11"
         }
      },
      {
         "@odata.id":null,
         "Count":188,
         "Project":{
            "@odata.id":null,
            "ProjectName":"Fabrikam Fiber"
         }
      },
      {
         "@odata.id":null,
         "Count":89,
         "Project":{
            "@odata.id":null,
            "ProjectName":"MyFirstProject"
         }
      },
      {
         "@odata.id":null,
         "Count":2,
         "Project":{
            "@odata.id":null,
            "ProjectName":"MyPublicProject"
         }
      }
   ]
}

Фильтрация рабочих элементов на основе итерации

https://analytics.dev.azure.com/{OrganizationName}/{ProjectName}/_odata/{version}/WorkItems?
  $filter=Iteration/IterationPath eq '{iteration path}'
  &$select=WorkItemId, Title, State

Пример запроса:

Например, следующий синтаксис запрашивает рабочие элементы для проекта Fabrikam Fibre в рамках итерации Path=Fabrikam Fibre\Release 1\Sprint 6.

https://analytics.dev.azure.com/fabrikam/_odata/v4.0-preview/WorkItems?$select=WorkItemId, WorkItemType, Title, State&$expand=Iteration($select=IterationPath)&$filter=(Project/ProjectName eq 'Fabrikam Fiber' AND WorkItemType ne '' AND Iteration/IterationPath eq 'Fabrikam Fiber\Release 1\Sprint 6')

Пример ответа:

Ответ возвращает данные для следующих четырех рабочих элементов.

{
   "@odata.context":"https://analytics.dev.azure.com/fabrikam/_odata/v4.0-preview/$metadata#WorkItems(WorkItemId,WorkItemType,Title,State,Iteration(IterationPath))",
   "value":[
      {
         "WorkItemId":361,
         "Title":"Hello World Web Site",
         "WorkItemType":"Product Backlog Item",
         "State":"New",
         "Iteration":{
            "IterationPath":"Fabrikam Fiber\\Release 1\\Sprint 6"
         }
      },
      {
         "WorkItemId":1126,
         "Title":"web site task",
         "WorkItemType":"Task",
         "State":"To Do",
         "Iteration":{
            "IterationPath":"Fabrikam Fiber\\Release 1\\Sprint 6"
         }
      },
      {
         "WorkItemId":1136,
         "Title":"Add a new task with two new tags",
         "WorkItemType":"Task",
         "State":"To Do",
         "Iteration":{
            "IterationPath":"Fabrikam Fiber\\Release 1\\Sprint 6"
         }
      },
      {
         "WorkItemId":1140,
         "Title":"New task - test for Blocked",
         "WorkItemType":"Task",
         "State":"To Do",
         "Iteration":{
            "IterationPath":"Fabrikam Fiber\\Release 1\\Sprint 6"
         }
      }
   ]
}

Получение элементов для итерации

Вы можете получить все рабочие элементы для заданной итерации, которые падают между первым днем итерации и последним днем итерации. Здесь запрос ограничен данными, содержащимися в данных отслеживания работы.

https://analytics.dev.azure.com/{OrganizationName}/{ProjectName}/_odata/{version}/WorkItems?
  $filter=Iteration/IterationPath eq '{iteration path}' 
    and ChangedDate ge Iteration/StartDate 
    and ChangedDate le Iteration/EndDate
  &$select=WorkItemId, Title, State

Фильтрация рабочих элементов, содержащих определенные теги

Любой оператор используется здесь, так как существует коллекция тегов, которые могут быть связаны с рабочим элементом. С точки зрения использования формат: {Navigation Property}/any(d:d/{Field Name} {operator} {expression}) Любой элемент, не окруженный фигурными скобками ({}) является литеральным. Существуют некоторые варианты. Например, вам не нужно использовать "d", как показано в приведенном выше выражении. В соответствии с этим форматом он упрощается.

https://analytics.dev.azure.com/{OrganizationName}/{ProjectName}/_odata/{version}/WorkItems?
  $filter=Tags/any(d:d/TagName eq '{tag name}')
  &$select=WorkItemId, Title, State

Фильтрация рабочих элементов для определенной команды

Используйте следующий запрос для перечисления рабочих элементов для определенной команды.

https://analytics.dev.azure.com/{OrganizationName}/{ProjectName}/_odata/{version}/WorkItems?
  $filter=Teams/any(d:d/TeamName eq '{team name}')
  &$select=WorkItemId, Title, State

Фильтрация рабочих элементов на основе поля с определенным значением

Следующий запрос аналогичен запросу рабочего элемента, использующего оператор Was Ever .

https://analytics.dev.azure.com/{OrganizationName}/{ProjectName}/_odata/{version}/WorkItems?
  $filter=WorkItemType eq '{Type}'
     and Revisions/any(r:r/ResolvedBy/UserName eq '{User}')

Пример запроса:

Следующий запрос возвращает рабочие элементы, которые когда-либо были назначены Jamal Hartnett, электронная почта которого является "fabrikamfiber4@hotmail.com" для проекта Fabrikam Fibre .

https://analytics.dev.azure.com/fabrikam/Fabrikam Fiber/_odata/v4.0-preview/WorkItems?
  $select=WorkItemType, Title, State, 
  &$expand=AssignedTo($select=UserEmail), Area($select=AreaPath)
  &$filter=(WorkItemType ne '' AND State ne '' AND Revisions/any(r:r/AssignedTo/UserEmail eq 'fabrikamfiber4@hotmail.com'))
  &$orderby=WorkItemType asc

Пример ответа:

Ответ возвращает два рабочих элемента.

{
   "@odata.context":"https://analytics.dev.azure.com/fabrikam/Design%20Agile/_odata/v4.0-preview/$metadata#WorkItems(Priority,WorkItemType,Title,State,TagNames,AssignedTo(UserEmail),Area(AreaPath))",
   "value":[
      {
         "Title":"New home page design",
         "WorkItemType":"Feature",
         "State":"Closed",
         "AssignedTo":{
            "UserEmail":"fabrikamfiber4@hotmail.com"
         },
         "Area":{
            "AreaPath":"Design Agile"
         }
      },
      {
         "Title":"Check performance",
         "WorkItemType":"User Story",
         "State":"New",
         "AssignedTo":{
            "UserEmail":"fabrikamfiber4@hotmail.com"
         },
         "Area":{
            "AreaPath":"Design Agile"
         }
      }
   ]
}

Получение команд, назначенных в разделе "Путь к области"

Следующий запрос возвращает имена команд, назначенных пути к областям в области управления учетными записями для проекта Fabrikam Fibre.

> https://analytics.dev.azure.com/fabrikam/Fabrikam Fiber/_odata/v4.0-preview/Areas?
>      $filter=startswith(AreaPath,'Fabrikam Fiber\Account Management')
>      &$select=AreaPath&$expand=Teams($select=TeamName)
>```
The response returns three area paths and the names of several teams assigned to each. 

> [!div class="tabbedCodeSnippets"]
```OData
> @odata.context	"https://analytics.dev.azure.com/fabrikam/Fabrikam%20Fiber/_odata/v4.0-preview/$metadata#Areas(AreaPath,Teams(TeamName))"
> value	
> 0	
>   AreaPath             "Fabrikam Fiber\\Account Management\\Customer Profile"
>   Teams	
>       0	
>           TeamName     "Organization Management"
>       1	
>           TeamName     "Fabrikam Team"
>       2	
>           TeamName     "Customer Profile"
> 1	
>   AreaPath             "Fabrikam Fiber\\Account Management\\Shopping Cart"
>   Teams	
>       0	
>           TeamName     "Organization Management"
>       1	
>           TeamName     "Shopping Cart"
>       2	
>           TeamName     "Fabrikam Team"
> 2	
>   AreaPath             "Fabrikam Fiber\\Account Management"
>   Teams	
>       0	
>           TeamName     "Organization Management"
>       1	
>           TeamName     "Fabrikam Team"

Возврат журнала определенного рабочего элемента

Запрос сущности, заданной для WorkItemRevisions списка журнала рабочих элементов. Следующий запрос возвращает значение пути заголовка, состояния и итерации для каждой редакции для указанного рабочего элемента.

https://analytics.dev.azure.com/{OrganizationName}/{ProjectName}/_odata/{version}/WorkItemRevisions?
  $filter=WorkItemId eq {Id}
  &$select=WorkItemId, Title, State, Iteration Path

Примечание.

В любой момент изменения в рабочий элемент, включая изменение значения ранжирования стека, создается редакция. Дополнительные сведения об исторических данных см. в разделе "Применение фильтров к историческим данным".

Пример запроса:

Например, следующие синтаксические запросы запрашивают изменения для ID=1145 в проекте Fabrikam Fibre.

https://analytics.dev.azure.com/fabrikam/Fabrikam Fiber/_odata/v1.0/WorkItemRevisions?$select=WorkItemId, Title, State&$expand=Iteration($select=IterationPath)&$filter=(Project/ProjectName eq 'Fabrikam Fiber' AND WorkItemId eq 1145 AND State ne '' AND Revision gt 1)

Пример ответа:

Ответ возвращает данные для четырех редакций:

{
   "@odata.context":"https://analytics.dev.azure.com/fabrikam/Fabrikam%20Fiber/_odata/v4.0-preview/$metadata#WorkItemRevisions(WorkItemId,Title,State,Iteration(IterationPath))",
   "value":[
      {
         "WorkItemId":1145,
         "Title":"Sprint 2 work added in June",
         "State":"New",
         "Iteration":{
            "IterationPath":"Fabrikam Fiber\\Future"
         }
      },
      {
         "WorkItemId":1145,
         "Title":"Sprint 2 work added in June",
         "State":"New",
         "Iteration":{
            "IterationPath":"Fabrikam Fiber\\Future"
         }
      },
      {
         "WorkItemId":1145,
         "Title":"Sprint 2 work added in June",
         "State":"New",
         "Iteration":{
            "IterationPath":"Fabrikam Fiber\\Release 1\\Sprint 2"
         }
      },
      {
         "WorkItemId":1145,
         "Title":"Sprint 2 work added in June",
         "State":"Done",
         "Iteration":{
            "IterationPath":"Fabrikam Fiber\\Release 1\\Sprint 2"
         }
      }
   ]
}

Поделиться через

Запрос данных отслеживания работы с помощью Аналитики

Необходимые компоненты

Фильтрация рабочих элементов на основе даты изменения

Фильтрация рабочих элементов на основе области

Фильтрация рабочих элементов на основе итерации

Получение элементов для итерации

Фильтрация рабочих элементов, содержащих определенные теги

Фильтрация рабочих элементов для определенной команды

Фильтрация рабочих элементов на основе поля с определенным значением

Получение команд, назначенных в разделе "Путь к области"

Возврат журнала определенного рабочего элемента

Обратная связь

Дополнительные ресурсы

Поделиться через

Запрос данных отслеживания работы с помощью Аналитики

Необходимые компоненты

Фильтрация рабочих элементов на основе даты изменения

Фильтрация рабочих элементов на основе области

Фильтрация рабочих элементов на основе итерации

Получение элементов для итерации

Фильтрация рабочих элементов, содержащих определенные теги

Фильтрация рабочих элементов для определенной команды

Фильтрация рабочих элементов на основе поля с определенным значением

Получение команд, назначенных в разделе "Путь к области"

Возврат журнала определенного рабочего элемента

Связанные статьи

Обратная связь

Дополнительные ресурсы