Reporting Json Data Provider macro allows reading of Json data from the attachment file or from the text field. The max number of items may be specified, but cannot be higher than 1000 items. Data providers in Reporting return data in a form of an array of Json objects - one Json object per each report line. In case of Json Data Provider the data is read as is from the attachment file or from the text field. Then, in Reporting Table Item and Reporting List Item formulas these objects may be accessed via CurrentItem variable.

Reporting table built from pasted JSON with percent values and the average in the footer

Example: a table built from JSON data pasted into the Json Data Provider, with percent formatting and an average in the footer.

Reporting Json Data Provider macro has the following parameters:

Parameter Description
[Enum] Data content type (default='Text only')

Specifies, how to process the data, specified in the Json data parameter or the file data, read from the attachment file, which name is specified in the Json data attachment file name parameter - whether it is a plain text or a single formula. This parameter may have one of the following values:

  • Text only
    • Means, that the data will be processed as is. In this case no formulas are searched for in it.
    • Example Json data parameter content: "[{name='name 1'},{name='name 2'},{name='name 3'}]".
  • Single expression
    • Means, that the data is a formula, which should be pre-calculated and its result will be processed afterwards.
[String] Json data (default=''(Empty value))

The Json data to be processed, specified directly in the macro. Use it for small data sets, which are not stored in an attachment.
[String] Json data attachment page (default=''(Empty value))

The page the Json data attachment is attached to, in the form 'SPACEKEY:Page title', for example 'DOCS:Monthly data'. Leave it empty to read the attachment of the current page.

In Confluence Cloud a page title without a space key ('Monthly data') means a page in the current space, and a page ID may also be specified.
[String] Json data attachment file name (default=''(Empty value))

The name of the attachment file to read the Json data from, for example 'data.json'. JSON and TXT files are supported only.
[String] Json data root (default=''(Empty value))

Specifies the root element path in the data. This parameter is convenient, when the input data is a result of some REST API call, where is a common case, when an array of Json objects is provided in an element, called 'results' or 'values'.
[String] Filter (default=''(Empty value))

The formula, which filters out the values when it returns False. Ignored if empty. A comparison that cannot be evaluated – a number against text, or an empty field – counts as False (since Reporting 14.1.0).

Examples:

  • 'FIND("Report", CurrentItem.fields.summary) > 0' - Returns True for the issues with the summary, which contains a 'Report' word. So this formula helps to create a report with the issues, which have 'Report' word in its summary.
  • 'CurrentItem.price > Average(AllItems.price)' – New! – keeps only the rows whose 'price' value is above the average 'price' value across all the (unfiltered) fetched items. In addition to CurrentItem, the Filter formula may now reference AllItems / AllItems.<path> – a range covering every fetched row's value at that path – so aggregate functions like Sum, Average, Max, Min can be used to build "above the average" / "equal to the max" style filters.
[Long] Max results (default=1000) The maximum amount of items to be returned. This feature is convenient to create the lists of TOP Something, when the amount is limited with this parameter.

More examples

Services from a JSON API response with nested owner, number of tags and latency; the slow service is highlighted

Example: an API response whose array sits under results (Json data root = results); nested values are read as CurrentItem.owner.name, slow services are highlighted.