Parameters in URLs

Query parameters can be specified as part of a URL, e.g. for viewing a dashboard. Especially for embedded dashboards, it may be necessary or useful to construct URLs to dashboards with specific parameters applied. This page describes how the dashboard parameters, like aggregations as well as time range and custom filters, can be encoded in a URL.

1. Aggregation Parameter

Values for time aggregation use the form aggregation=<value> in a URL, with the possible values being: second, minute, hour, day, week, month, quarter, year. The following links illustrate this parameter:

• Example (Quarter)
• Example (Year)

2. Time Range Parameter

A time range filter uses the form timerange=<value> in a URL. Multiple formats for the value are supported.

From-To: <unix_timestamp>~<unix_timestamp>

• Example (Jul 2016)

Before: ~<unix_timestamp>

• Example (Before Jul/1 2016)

After: <unix_timestamp>~

• Example (After Jul/1 2016)

Last n units: <number>_full_<unit>

• Example (7 days)
• Example (4 months)

Last n units (ending now): <number>_<unit>

• Example (7 days)
• Example (4 months)

This unit: thisfull_<unit>

• Example (Today)
• Example (This month)

This unit (ending now): this_<unit>

• Example (Today until now)
• Example (Month-to-date)

Previous unit: previous_<unit>

• Example (Yesterday)
• Example (Last month)

3. Custom Filters

All custom filters to be included in a URL are combined in a URL-encoded JSON structure:

{
  <filter_1>: [<filter_value_1>, <filter_value_2>,...],
  <filter_2>: [<filter_value_1>, <filter_value_2>,...],
  ...
}

In JavaScript, this can be achieved via encodeURIComponent, e.g.

encodeURIComponent('{"countries":["United States","Canada"],"origin_airports":["LAX"]}')
"%7B%22countries%22%3A%5B%22United%20States%22%2C%22Canada%22%5D%2C%22origin_airports%22%3A%5B%22LAX%22%5D%7D"

• Example (Flights from LAX and countries Canada and USA)