Jenkins Data Stream Parameters

The Jenkins plugin provides configurable data streams that allow you to retrieve detailed properties for builds, folders, projects, and views. These streams support both Tree Queries and Depth Queries, giving you fine-grained control over which attributes are returned and at what level of detail.

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.

Build Status (Advanced)

Returns builds with their full set of properties, including links back to the build and its artifacts in Jenkins. A Tree query narrows which fields come back.

Parameter
Description
Query type
Select how to define which properties to fetch. Choose from:
  • Tree Query:
    Specify a tree query to return the depth of the API response. (e.g. jobs[name,lastBuild[number,timestamp]]).
  • Depth Query: Standard depth-based retrieval.
Properties
Select one or more specific build properties to return (e.g. url, artifacts, result, timestamp).

Folder Status (Advanced)

Returns the properties of Jenkins folders, for dashboards organized the way the Jenkins instance is.

Parameter
Description
Query type
Select how to define which properties to fetch. Choose from:
  • Tree Query:
    Specify a tree query to return the depth of the API response.
  • Depth Query: Standard depth-based retrieval.
Properties
Select one or more folder properties to return (e.g. name, description, jobs).

Project Status (Advanced)

Returns the fuller set of project properties, beyond what the standard project data stream carries.

Parameter
Description
Query type
Select how to define which properties to fetch. Choose from:
  • Tree Query:
    Specify a tree query to return the depth of the API response.
  • Depth Query: Standard depth-based retrieval.
Properties
Select one or more project properties to return (e.g. displayName, buildable, lastBuild).

View Status (Advanced)

Returns the properties of Jenkins views, so a tile can follow a view your team already curates.

Parameter
Description
Query type
Select how to define which properties to fetch. Choose from:
  • Tree Query:
    Specify a tree query to return the depth of the API response.
  • Depth Query: Standard depth-based retrieval.
Properties
Select one or more view properties to return (e.g. name, url, jobs).

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket