Fetch Commands for JIRA

When creating elements in Metric Insights, you can fetch data from JIRA and use this data to build elements (Reports and Metrics) as well as Datasets. Simply copy the query from JIRA and specify the fields you would like to retrieve via the JIRA plug-in. This article will give an overview of using JQL fetch commands to build a Report.

1. Build a search command in JIRA

  1. Type a JIRA search command
  2. Choose fields in JIRA that will used when creating an element/Dataset in Metric Insights.

1.1. An alternate way to find fields in JIRA

  1. Click [Create issue] to open the new issue pop-up.
  2. Open the Configure fields dropdown to see the list of available fields.

2. Connect to JIRA from a Report Editor

2.1. Complete a JIRA plug-in Query (prior to 5.3.0)

On the Report Editor:

  1. Specify Atlassian JIRA as a Data Source.
  2. Select ONE or All Projects from which the data will be collected.
  3. In the Query field, formulate your query in braces {}. The Query typically consists of 2 internal parameters – the "jql" parameter (preceeds the actual query copied from JIRA) and  the "fields" parameter. Both must be followed by a colon (:), entered in quotation marks and separated with a comma).

SAMPLE QUERY: {"jql":"query_copied_from_jira","fields":"field_name", "field_name", "field_name"}

  1. Click [Show data] to validate.

NOTE: No Data Columns will be available until you validate the plug-in command.

2.1.1. Complete a JIRA plug-in Query (5.3.0 and higher, slight changes in plug-in command)

On the Report Editor:

  1. Specify Atlassian JIRA as Data Source.
  2. Select ONE or All Projects from which the data will be collected.
  3. In the Query field (or in the Visual Editor), specify the fields that will be included in the Report.
    • formulate your query, starting with the keyword "param" or copy the actual query from JIRA and add "param".
  4. Click [Show data] to validate.

2.2. Preview the Data

  1. The fields specified in the Query are displayed in Data Preview.
  2. [Save] to see the Report Columns List (the changes are shown below).

2.3. View and manage the Report Columns List

Manipulate the display of Report Columns as required.

3. Connect to JIRA from a Dataset Editor

3.1. Complete a JIRA plug-in Query (prior to 5.3.0)

On the Dataset Editor:

  1. Specify Atlassian JIRA as Data Source.
  2. Select ONE or All Project from which the data will be collected.
  3. In the Query field, formulate your query in braces.
  4. [Validate].

3.1.1. Complete a JIRA plug-in Query (5.3.0 and higher)

On the Dataset Editor:

  1. Specify Atlassian JIRA as Data Source.
  2. Select ONE or All Project from which the data will be collected.
  3. In the Query field, formulate your query.
  4. [Validate].

3.2. Preview the Data

  1. The fields specified in the Query are displayed in Data Preview.
  2. [Save] to see the Report Columns List (the changes are shown below).

3.3. View and manage the Dataset Columns List

Manipulate the display of Dataset Columns as required.

To activate automated data collection and to be able to access Dataset Viewer, click [Enable and Publish] Dataset.

4. Add charts and pivots to a Report as needed

Example above shows the Bubble Chart for the data.

For more information, refer to Create a Simple (Undimensioned) Report