Overview: Query Builder for Jira

With the Query Builder for Jira, you can create Custom Jira Metrics using a combination of Metrics, Dimensions and Filters. 


How to access the Query Builder for Jira

Navigate to Metrics > Query Builder to access the Query Builder for Jira. Click the green + Create Custom Metric button and select your connected Jira Account from the Data Source drop-down list.

    Query Builder is available in Plus and Business Accounts. Agency Basic Accounts have access to Query Builder in the Agency Account only.  Request a trial of Query Builder by following these steps.  

How to use the Query Builder for Jira

  Custom Query Name:  Enter a name for your Custom Metric. This Custom Metric name will be available in the Designer after saving. 
  Metric: Select a Metric from your connected Jira Data Source, such as "Development," "Progress" or "Team." Selecting certain Metrics will expose the Dimension field.

The Dimensions parameter re-categorizes the returned Metric value based on common criteria. Examples of Dimensions are "Assignee," "Project," and "Features." If no Dimension is selected, the Custom Metric will store 1 aggregated Metric value for each Date Range. 

  Date Field: The Date Field determines what to include in the Custom Metric. For example, if "Due Date" is selected, any tasks with a due date that falls during the specified Date Range(s) will be included in the Custom Metric. If "Created" is selected, any task that was created during the specified Date Range(s) will be included in the Custom Metric.  
  Date Range: Select up to 8 Date Ranges that will be available for the Custom Metric. The Date Ranges selected are the only periods of time that data is synced for this Custom Metric. 
  Compare With (Optional) : Select a comparison period to measure each Date Range against, like "Previous Period." Data for the comparison period will be synced for each Date Range that is selected.  
This data can be used on a Line Chart or Bar Chart to show past performance. It is also used to calculate the percentage growth or loss of the current Date Range performance vs the comparison Date Range performance. If no Compare With parameter is selected, comparison percentages cannot be displayed for the Custom Metric. 
  Filter by (Optional):  Filters restrict the data that gets included in the Custom Metric. All data that is returned is tested against the Filter(s). Multiple Filters can be combined using AND/ OR boolean logic. 
If the data synced from the Metric and Dimension fields meet the Filter specifications, the data is retained and included in the Custom Metric value. If the data synced from the Metric and Dimension fields don't meet the Filter specifications, the data is excluded from the Custom Metric value.
Only the first 15 Values returned will be displayed in the Value drop-down list. Follow these steps to determine the exact Filter value and manually enter it into the Value field. 
  Data Preview: After clicking Run query, a Data Preview of the Custom Metric will be displayed. Daily Metric values are displayed in this section, along with the total Metric values for the Date Range in bold at the bottom. You can view the Data Preview for different Date Ranges by clicking on the tabs at the top of the Data Preview. 
Pro Tip : If you don't know which Filters to put in place for your use case, use the Dimension + Data Preview to troubleshoot and get more insight into the data that is returned from your ira Account for each field. Learn more here.

How to create a Custom Jira Metric [Example]

In this example, we'll create a Custom Metric to report on Progress, split up based on the Creator. We only want to include tasks that are labeled "Urgent" or "High" Priority. 

 Navigate to Metrics  > Query Builder   
 Click the green + New query button
 Select the appropriate Jira Data Source
 In order to accurately explain what this Custom Metric is reporting on, we'll name the Custom Metric "Progress by Creator (Urgent/ High Priority)"  
 Since a "Progress" is what we're looking to track, we will select Progress from the Metric dropdown list
 After selecting Progress as the Metric, a new field is exposed called Dimension. Click on  Dimension and select Creator from the dropdown list. This will split up the Progress based on the task Creator
 We want to include any tasks that were updated during the specified Date Range, so we'll select Updated as the Date Field
 Next, we'll select Last Month, Month to Date, Last Week, and Week to Date as Date Range options for the Custom Metric
 We'll choose Previous Period for the Compare With field
 Lastly, we want to restrict the Custom Metric to only retain data for Urgent and High Priority cases, so we'll add 2 Filters. 
First, we'll open the Field drop-down list and will select Priority. The Operator selection will be = and the first Value is Urgent. Since we want to include Urgent or High Priority, we'll click on the + sign to add another Filter. We'll select OR so only 1 Filter needs to be satisfied for data to be retained. For this Filter, we'll select Priority  = High.
 Click Run query to generate a Data Preview of the Custom Metric
 Once we confirm that these are the results we're looking for, we'll click Save to save the Custom Metric

How to add a Custom Jira Metric to a Databoard

Learn how to add a Custom Metric to a Databoard here.

Additional Info

  • Only the first 15 Values returned will be displayed in the Value drop-down list. Follow these steps to determine the exact Filter Value and manually enter it into the Value field. 
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us