Azure DevOps Data Stream Parameters

The Azure DevOps plugin provides configurable data streams to fetch build and release data and metrics.

Each configurable data stream exposes a set of parameters that lets you filter the data you retrieve. The following information describes the available configurable data streams and their parameters in detail.

Agent Pool Consumption (Microsoft-Hosted)

Returns usage analytics for a Microsoft-hosted agent pool, showing how much hosted build capacity is being consumed.

Parameter
Description
Report
Select how to display the results. Choose from:
  • Private: Show the usage alongside the concurrency.
  • Agent: Shows the usage within your project.

Agent Pool Consumption (Self-Hosted)

Returns usage analytics for a self-hosted agent pool, showing how hard your own build agents are working.

Parameter
Description
Report
Select how to display the results. Choose from:
  • Private: Show the usage alongside the concurrency.
  • Agent: Shows the usage within your project.

Agent Pool Diagnostic Logs

Returns diagnostic logs for an agent pool, for when jobs are queuing or agents are failing.

Parameter
Description
Log level
Select specific logs levels to return (Error, Warning, Info).
Operation
Choose specific operation types to return.

Analytics Query

Returns the result of an Azure DevOps Analytics query, for reporting across work items and pipelines.

Parameter
Description
Entity Type (Endpoint)
Specify the starting point of your query by selecting the Analytics entity (similar to a table) you want to pull data from.
This is the only required parameter, however if no additional query options are set then the API may return excessively large results and a warning will be issued.
Scope
Optionally, specify the precise objects to return data for.
Query
Enter your analytics query. Allows you to specify filtering, grouping, or sorting logic in OData query format to shape the dataset you retrieve.
Columns
Specify which fields (columns) to return from the chosen entity. Useful for limiting the response to only the data you need, improving performance and readability.
Top
Specify maximum number of records to return by the query, helping you manage data volume and performance.
Skip
Specify the number of records to tells the query to bypass before starting to return results. Often used in combination with Top to implement paging.

Build Commits

Returns the commits included in specific builds, tying what shipped to what changed.

Parameter
Description
Limit results
Specify the maximum number of commits returned. Helps control data size by returning only the specified number of records. This field is mandatory.
Build result
Select the outcome of the associated build run to filter results by (e.g., Succeeded, Failed, Partially Succeeded). Use this to focus only on commits tied to specific build results.
Build status
Select the current state of the associated build run to filter results by (e.g., In Progress, Completed, Cancelling). Note that some statuses cannot be combined with results—for example, an In Progress build will not have a result yet.
Build trigger
Specify the event that initiated the build run (e.g., Continuous Integration, Manual, Scheduled) to filter associated commits by their trigger source.

Build Runs

Returns builds triggered across your pipelines, with the outcome of each.

Parameter
Description
Limit results
Specify the number of top N results to return.
Result
Specify the outcome of the build run (e.g., Succeeded, Failed, Partially Succeeded) to filter returned runs.
Status
Specify the current state of the build run (e.g., In Progress, Completed, Cancelling) to filter results. Some statuses cannot be combined with results—for example, an In Progress build will not have a result yet.
Branches
Specify one or more branches to filter build runs. The branch name must begin with the prefix refs/heads/ to function correctly.
Build IDs
Specify a comma-separated list of build IDs to return only those matching build runs.
Trigger
Specify the event that initiated the build run (e.g., Continuous Integration, Manual, Scheduled) to filter results by trigger source.
Include stages
Select whether to include build stages in the returned result. Choose from:
  • Detail: Returns stages with a named column for each stage.
  • Durations: Returns stages with a named column for each stage and includes duration details.
  • Summary: Returns stages, sorted by order.
  • No: Does not return stages.
Not available when Work Items are included.
Include Work Items

Returns a column containing a comma-separated list of associated Work Item IDs.
Not available when stages are included.

Commits

Returns code commits across repositories.

Parameter
Description
Branch name
Specify the branch to filter commits. Defaults to the repository’s default branch if not specified. This parameter is relevant when using Repo(s) or Repo Folder(s) as your object.
Author
Specify the author to return only commits made by that user.
Top
Specify the maximum number of commits to return. Helps control data size and improve performance.

Pull Requests

Returns pull requests across the organization, both active and closed.

Parameter
Description
Limit results
Specify the maximum number of pull requests to return. Helps control data size and improve performance.
Creator
Specify the user to return only pull requests created by that person.
Reviewer
Specify the user to return only pull requests where that person is a reviewer or has provided a review
Tag(s)
Specify one or more tags to return only pull requests associated with those tags.
Build status
Specify a build status to filter pull requests (e.g., based on the success or failure of linked builds).

Release Runs

Returns release pipeline runs, with the progress and outcome of each.

Note

If you experience timeouts with this data stream, try disabling Show tags, Show artifacts, and Show stages, as each adds additional API cost.

Parameter
Description
Limit results
Specify the maximum number of release runs to return. Useful when you only want the most recent release(s).
Status
Specify the status to filter release runs (e.g., Active, Abandoned, Completed).
Show stages
Enable the display of individual release stages and their statuses. Choose a column style:
  • Detail: Displays stage columns with headers that reflect stage names and shows statuses in the column cells.
  • Summary: Displays stage columns with numeric headers and shows statuses in the column cells. Useful when data includes releases with varying stages, as it significantly reduces the number of columns. Hover over a status cell to view the stage name.
Show artifacts
Enable display of the artifacts used in the release.
Show tags
Enable display of the release pipeline’s tags

WIQL Query

Returns the work items matching a Work Item Query Language query, for when the filters on Work Items do not reach far enough.

Parameter
Description
WIQL query
Specify a WIQL query to return work items for. For help with writing WIQL queries, see the following:
Project context
Optionally, specify the precise protects to return data from.

Work Items

Returns work item detail for the objects in scope.

Parameter
Description
Limit results
Specify the maximum number of work items to return. Helps control data size and performance.
Type
Specify the work item type (e.g., Bug, Task, User Story) to filter results.
State
Specify the work item state (e.g., New, Active, Closed) to filter results.
Assigned to
Specify the name of an assignee to return only work items assigned to that user.
Area
Specify an area path to return only work items within that area.
Tags
Specify one or more tags to filter work items by associated labels.
Keyword
Specify keywords to filter work items by text matching in fields such as title or description.

Work Items Saved Queries

Returns work items from a query already saved in Azure DevOps, so a dashboard reuses a query your team maintains.

Parameter
Description
Flatten
Select how non-flat queries should be handled.

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket