Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Insight

Use a URL-based query to create charts

  • Last UpdatedFeb 06, 2025
  • 3 minute read

You can create an AVEVA Insight chart from a URL query. This is useful when you want to trigger the creation of an AVEVA Insight chart from another application.

Note: You must be signed into the AVEVA Insight solution that corresponds to the data you reference before you can query it.

Parts of a URL-based query

The query must be in this format:

<base URL>?Tags=<tag list><optional parameters, where parameters are joined by "&">

Here is an example of a URL-based query

https://online.wonderware.[DOMAINSUFFIX]/framework/content?tags=WeatherApp.Auckland.Cloudiness&chartType=LineChart&startTime=2017-03-29T08:45:00.000&endTime=2017-03-30T08:45:00.000

The following further explains the above example:

Part of the query URL

Related segment of the URL

The base URL

https://online.wonderware.[DOMAINSUFFIX]/framework/content

Note: /framework will generate a chart

An indicator showing that parameters are to follow

?

Query parameters

tags=WeatherApp.Auckland.Cloudiness
&chartType=LineChart
&startTime=2017-03-29T08:45:00.000
&endTime=2017-03-30T08:45:00.000

Supported query parameters

These query parameters are supported. While tag names are case-sensitive, parameters are not. (Parameters are case-insensitive.)

Parameter

Description

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.

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

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

Note that milliseconds, represented by fff, are optional.

StartTime is in local time (ISO 8601 format) for the client computer. To use UTC format, append the time with a z (New Look only).

If no value is provided, the default is Today.

EndTime

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

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

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

Note that milliseconds, represented by fff, are optional.

EndTime is in local time (ISO 8601 format) for the client computer. To use UTC format, append the time with a z (New Look only).

If no value is provided, the default is Today.

DurationHours

Specifies the duration to report, in hours. This parameter also supports decimal input. DurationHours is used only if provided.

For example: DurationHours=2.5

sliceBy

Specifies the event aggregate in a column chart. This parameter accepts the fully qualified name of a non-analog tag. For example: sliceBy=IntouchAlarm.ConcValve1

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.

resolution

Specifies a time aggregate in milliseconds for a chart supporting time aggregate options. For example: resolution=900000.

resolution accepts any value, in milliseconds.

timeAggregate

Specifies a time aggregate in daily or hourly values for a chart supporting time aggregate options. For example: timeAggregate=Day

The following values are supported:

  • Day

  • Hour

  • Event

  • TimeInState (Only on Column Chart types)

  • A value in minutes, such as 90. Providing a value populates the Custom Duration field in supported chart types.

    Alternatively, you can provide 1, 2, 3, or 4 for Day, Hour, 15minute, or Event, respectively.

    The following rules apply:

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

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

valueAggregate

Specifies a value aggregate for a chart supporting value aggregate options. For example: valueAggregate=average.

Valid values are:

  • minimum

  • maximum

  • total

  • average

  • last

  • meter (Only on Column and Summary chart types)

About StartTime, EndTime, and DurationHours

Reporting time is calculated in several different ways, depending on which fields have values. Here are some examples.

  • When StartTime, EndTime, and DurationHours are all specified, then StartTime and EndTime are used, but DurationHours is ignored.

  • When either StartTime or EndTime is specified along with DurationHours, then the two specified parameters are used.

  • When either StartTime or EndTime is specified without DurationHours, then CurrentTime and the specified parameter are used.

  • When neither StartTime, EndTime, or DurationHours are specified, then the chart shows tag values for today ending with the current time.

In This Topic
TitleResults for “How to create a CRG?”Also Available in