Use a URL-based query to create a chart

Tags

(required) Defines the tags to include in the chart. Use the case-sensitive, fully qualified name for each tag (that is, the data source name plus the tag name). Separate tag names with commas.

Note: If a tag name uses special characters, it must be URL encoded.

For example: Tags=MyDataSource.Pump12.Temp,MyDataSource.Pump12.Speed

ChartType

Specifies the type of chart to use. Valid chart types are DataGrid, ColumnChart, LineChart, PieChart, SummaryChart, and StatusBoard.

For example: ChartType=ColumnChart

Default: StatusBoard

StartTime

Specifies the when the reporting time period begins, using this format:

yyyy-MM-dd'T'HH:mm:ss.fff

For example: StartTime=2017-03-27T08:47:40.763

Including milliseconds is optional.

By default, StartTime is in local time (ISO format) for the client computer. Add a Z at the end of the time to use UTC instead. For example: StartTime=2017-03-27T08:47:40.763Z

Default: Today

EndTime

Specifies the when the reporting time period ends. It must be used in conjunction with StartTime or DurationHours, and cannot be a time in the future. Use the following format:

yyyy-MM-dd'T'HH:mm:ss.fff

For example: EndTime=2017-03-28T12:47:40.763

Including milliseconds is optional.

By default, EndTime is in local time (ISO format) for the client computer. Add a Z at the end of the time to use UTC instead. For example: EndTime=2017-03-28T12:47:40.763Z

Default: Today

DurationHours

Specifies the duration to report, in real number of hours. Use decimals to represent times that are less than an hour, for example 0.25 for 15 minutes.

DurationHours is used only if provided.

For example: DurationHours=2

sliceBy

Specifies the event aggregate in a column chart. This parameter accepts the fully qualified name of a string tag.

If sliceBy is provided in the URL along with resolution or timeAggregate, those parameters are ignored and event aggregate is selected for the chart.

If no tag name, or an invalid tag name, is provided for sliceBy, the sliceBy option is ignored.

For example: sliceBy=IntouchAlarm.ConcValve1

resolution

Specifies a time aggregate for a column chart in milliseconds. Standard values are 86400000 (DAY), 3600000 (Hour). Other values are accepted and will show as a custom duration.

For example: resolution=3600000

timeAggregate

Specifies a time aggregate for a column chart in daily or hourly values. Valid values are: Day, Hour, or Event.

If the sliceBy query parameter is used, then timeAggregate is automatically set to Event and any other timeAggregate option is ignored

For example: timeAggregate=Day

If resolution and timeAggregate are both provided, only resolution is considered.

valueAggregate

Specifies a value aggregate for a chart supporting value aggregate options. Valid values are minimum, maximum, integral, average, or last as long as the value is valid for the corresponding chart.

#hidenavigation

Hides the navigation options. This is helpful to provide an uncluttered view of your content, and to remove the option to navigate elsewhere.