Jira Data Stream Parameters

The Jira plugin returns work items from your Jira site, by saved filter, by JQL query or by space.

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.

Filters

Returns the work items that match a saved Jira filter. Choose the filter as the tile's object.

Parameter
Description
Result type
Select how the work items are returned. Choose from:
  • List: returns one row per work item. This is the default.
  • Count: returns the number of matching work items.
  • Aggregate: returns counts grouped by the field you choose in Group by.
Columns
Shown when Result type is List. Select the fields to return for each work item. Selecting only the columns you need makes the query faster.
Group by
Shown when Result type is Aggregate, and required. Select the field to group work items by. Grouping by a custom field can slow the query down.
Bucket by
Shown when Group by is a date field. Select whether to group dates by Day, Month or Year. The default is Month.

JQL Query

Returns the work items that match a JQL query. The tile has no timeframe by default, so put any date range in the query.

Parameter
Description
JQL query
Required. Enter the JQL to run, for example project = PRG and updated >= -30d.
Result type
Select how the work items are returned. Choose from:
  • List: returns one row per work item. This is the default.
  • Count: returns the number of matching work items.
  • Aggregate: returns counts grouped by the field you choose in Group by.
Columns
Shown when Result type is List. Select the fields to return for each work item. Selecting only the columns you need makes the query faster.
Group by
Shown when Result type is Aggregate, and required. Select the field to group work items by. Grouping by a custom field can slow the query down.
Bucket by
Shown when Group by is a date field. Select whether to group dates by Day, Month or Year. The default is Month.

JQL Query (Over Time)

Counts the work items that matched a query at each point across the tile's timeframe, for example how many high-priority work items were open each week.

Parameter
Description
JQL query
Required. Enter JQL that contains at least one WAS IN or WAS NOT IN with no DURING, BEFORE, AFTER or ON. SquaredUp adds a DURING clause for each interval of the tile's timeframe and counts the matches.
To return one series per value, put $DATASET at the end of a WAS IN list, for example statusCategory in ("To Do") and priority was in ($DATASET). The DURING clause is then added after $DATASET.
$DATASET
Enter the values that replace $DATASET in the query. Each value is returned as its own series, labeled with that value. The default is Low.

Work Items

Returns work items filtered by space, status, type and any additional filters you turn on.

Parameter
Description
Spaces
Select the Jira spaces to include.
Status
Select the statuses to include.
Type
Select the work item types to include.
Component
Select to filter by component, then choose the Components.
Label
Select to filter by label, then choose the Labels.
Release
Select to filter by release, then choose the Releases.
User
Select to filter by user, then choose the Users.
Result type
Select how the work items are returned. Choose from:
  • List: returns one row per work item. This is the default.
  • Count: returns the number of matching work items.
  • Aggregate: returns counts grouped by the field you choose in Group by.
Columns
Shown when Result type is List. Select the fields to return for each work item. Selecting only the columns you need makes the query faster.
Group by
Shown when Result type is Aggregate, and required. Select the field to group work items by. Grouping by a custom field can slow the query down.
Bucket by
Shown when Group by is a date field. Select whether to group dates by Day, Month or Year. The default is Month.
Column
On the Timeframe step. The tile has no timeframe by default. To apply one, select the date column to filter on.

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket