Workbook time parameters

With time parameters, you can set the time context of analysis, which is used by almost all reports. Time parameters are simple to set up and use. You can use them to specify the time ranges to show in a dropdown list. You can also create custom time ranges.

Create a time parameter

  1. Start with an empty workbook in edit mode.

  2. Select Add parameters > Add Parameter.

  3. In the new parameter pane that opens, enter:

    • Parameter name: TimeRange
    • Parameter type: Time range picker
    • Required: checked
    • Available time ranges: Last hour, Last 12 hours, Last 24 hours, Last 48 hours, Last 3 days, Last 7 days, and Allow custom time range selection.
  4. Select Save to create the parameter.

    Screenshot that shows a time range parameter in read mode.

This is what the workbook looks like in read mode.

Reference a time parameter

You can reference time parameters with bindings, KQL, or text.

Reference a time parameter with bindings

  1. Select Add query to add a query control, and then select an Application Insights resource.

  2. Most workbook controls support a Time Range scope picker. Open the Time Range dropdown list and select the {TimeRange} in the Time Range Parameters group at the bottom:

    • This control binds the time range parameter to the time range of the chart.
    • The time scope of the sample query is now Last 24 hours.
  3. Run the query to see the results.

    Screenshot that shows a time range parameter referenced via bindings.

Reference a time parameter with KQL

  1. Select Add query to add a query control, and then select an Application Insights resource.

  2. In the KQL, enter a time scope filter by using the parameter | where timestamp {TimeRange}:

    • This parameter expands on the query evaluation time to | where timestamp > ago(1d).
    • This option is the time range value of the parameter.
  3. Run the query to see the results.

    Screenshot that shows a time range referenced in KQL.

Reference a time parameter in text

  1. Add a text control to the workbook.
  2. In the Markdown, enter The chosen time range is {TimeRange:label}.
  3. Select Done Editing.
  4. The text control shows the text The chosen time range is Last 24 hours.

Time parameter options

Parameter Description Example
{TimeRange} Time range label Last 24 hours
{TimeRange:label} Time range label Last 24 hours
{TimeRange:value} Time range value > ago (1d)
{TimeRange:query} Time range query > ago (1d)
{TimeRange:start} Time range start time 3/20/2019 4:18 PM
{TimeRange:end} Time range end time 3/21/2019 4:18 PM
{TimeRange:grain} Time range grain 30 m

Use parameter options in a query

requests
| make-series Requests = count() default = 0 on timestamp from {TimeRange:start} to {TimeRange:end} step {TimeRange:grain}

Next steps

Getting started with Azure Workbooks