Report Template Properties

Name

Give the report template a name.

Description

Add a description to the report template (optional).

Graph Type

Select from the available options: pie, column, bar, line, spline, area, areaspline, and scatter.

Datastore

Select to use the System Log or a datastore in the account. See Datastores.

The following system log attributes are not available to reports: node ID, node name, number of input attempts, and number of no match attempts.

Preview

Preview the report.

Note:

Preview reports query at maximum the most recent 50,000 records from the datastore.

On the Series tab, when Form field value is selected (default) and a query condition exists, preview applies the query to a subset of the 50,000 records.

Metrics

Field

Description

Metric

A column in the selected datastore. On a bar chart, this metric displays on the y-axis.

The initial column is the datastore ID.

Calculation

The initial value is Count. If the metric is numeric, you may want to sum or average the values, or pick-out the maximum or minimum value.

Possible calculations are:

  • count

  • sum

  • avg

  • max

  • min

Label

Chart label for the metric.

Breakdown

Field

Description

Breakdown

A column in the selected datastore. On a bar chart, the breakdown displays on the x-axis.

For a time-series chart, use the datastore _timestamp column.

On the Series tab, when Form field value is selected (default), _timestamp is available for every datastore. When the datastore is the system log, _task_id and _uuid are also available.

Label

Chart label for the breakdown data.

Series (From Field Value)

Field

Description

Series Data Field

A column in the selected datastore. Use a column with category data. On a bar chart, each column is divided according to the category data.

For the system log, _task_id is available in addition to the standard columns.

Do not use a column with a large number of different values. Studio may fail to preview or generate the report if the column has a couple of hundred different values or more.

Query Condition

Use to filter the report according to values in the datastore.

For example, a datastore may have the category data values sales, marketing, support, and other. This generates a pie chart with segments for each category. Use the query condition to filter the data so that the data values in other do not appear in the report.

Create a query condition using the Query Builder.

Note:

The chart does not redraw automatically when you update the query condition. To reload the report, click Preview or Reload Preview.

Series (Custom Series)

Create one or more custom series from the datastore using the Query Builder.

Field

Description

Name

Name the series.

Query Condition

Define the query condition for the series.

For example, from the system log use the Query Builder to calculate the number of calls received and the number of hang-up events. Each is a series. You can compare series side by side, and visualize in the same time span where the values differ.

Create a query condition using the Query Builder.

Stack Name

Name the stack on the chart. Typically, the series name and stack name are the same.

Color

Define the color for the series.

Query Builder

Follow these guidelines when building query conditions:

  • Click Add Node to begin.

  • Select from the columns in the datastore.

    You cannot build queries from secure columns in the datastore.

  • Select from the standard operators, such as equal to, not equal to, starts with, and doesn't end with.

  • Create complex queries with nodes and groups.

Query Builder Preview

Click Preview in the query builder to ensure the right records are matched.

The records display in descending order of _timestamp. You cannot change the sort order.

While using preview, click the column settings icon to show or hide columns in the datastore.

The records are paginated.

  • Studio may not return as many records as you request in row_limitand page_size. If Studio cannot serve the number of records you request, Studio lets you know the next_page and optimal page_size to use based on the request type.

  • If you set pageand per_page values, you can find them in meta.pagination.comments.next_page and meta.pagination.comments.page_size respectively.

  • If you set the row_limit, the page and optimal per page values are set in paths ws_response_meta.additional_info.next_page and ws_response_meta.additional_info.per_page respectively in the response body.

Filters

Field

Description

Date

Filter the chart to the selected date range. Initially, the chart is filtered to the last seven days.

Task

Filter the chart to selected tasks. Initially, all tasks are selected. This filter only applies to the system log.