GetSummaries

Retrieve the statistical summaries of the Historian points within a specified time range.

Input Parameter

Item
Description
Request
GET
URL Parameter
  • request
    : JSON.
  • URL Parameter Members
    :
    • ServerName: String (required). The FactoryTalk Historian server name.
    • PointNames: Array in the string format (required). The point names to be queried in the Data Archive.
    • StartTime: Time in the string format (required). The start time of a time range.
    • EndTime: Time in the string format (required). The end time of a time range.
    • Weighting: String (optional). It weighs each event's value by the length of its applied time. The default value is Time.
Request Header
Authentication
: String (required). Bearer Token string returned from the Login action.
Request Body
None
Status Code
  • 200
    : The request succeeded.
  • 206
    : Partially processed.
  • 400
    : Bad request. For example, the URL parameter is not provided.
  • 401
    : Unauthorized.
  • 403
    : Forbidden.
  • 404
    : Resource not found.
  • 500
    : Internal server error.

Sample

Request Header
"Authorization": "eyJhbGciOiJIUzI1N…"
Request URL Parameter
request={"ServerName":"HisSrvName","PointNames":["TestPoint1"],"StartTime":"*-8h","EndTime":"*","Weighting":"Time"}
Response Body
{
	"Result": {
		"TestPoint1": [{
				"TimeStamp": "2024-04-09T21:06:39.820991Z",
				"Value": "100",
				"Statistic": "Percent Good"
			},
			{
				"TimeStamp": "2024-04-09T21:06:39.820991Z",
				"Value": "50",
				"Statistic": "Average"
			},
			{
				"TimeStamp": "2024-04-09T21:06:39.8209991Z",
				"Value": "10",
				"Statistic": "Minimum"
			},
			{
				"TimeStamp": "2024-04-09T21:06:39.8209991Z",
				"Value": "100",
				"Statistic": "Maximum"
			},
			{
				"TimeStamp": "2024-04-09T21:06:39.820991Z",
				"Value": "0",
				"Statistic": "Range"
			},
			{
				"TimeStamp": "2024-04-09T21:06:39.820991Z",
				"Value": "0",
				"Statistic": "Standard Deviation"
			},
			{
				"TimeStamp": "2024-04-09T21:06:39.820991Z",
				"Value": "0",
				"Statistic": "Population Standard Deviation"
			},
			{
				"TimeStamp": "2024-04-09T21:06:39.820991Z",
				"Value": "28800",
				"Statistic": "Count"
			}
		]
	},
	"Success": true,
	"ErrorMessage": ""
}
TIP:
The weighting types include:
  • Time
    : The default type. It is time-weighted, which weighs each event value by the length of its applied time.
  • TimeContinuous
    : It is time-weighted, which does all interpolations between values as if values represent continuous data.
  • TimeDiscrete
    : It is time-weighted, which does all interpolations between values as if values represent discrete and unrelated data.
  • Event
    : It is event-weighted, which weighs each event equally. This type requires at least one event in a time range. Events at the boundary of the calculation are handled as follows:
    • If there is only one calculation interval, use events at both boundaries.
    • If there are multiple intervals and the intervals are in ascending time order, include events at the start time.
    • If there are multiple intervals and the intervals are in descending time order, include events at the end time.
  • EventExStart
    : It is event-weighted, which excludes the earliest event generated at the start time during an interval.
  • EventExEnd
    : It is event-weighted, which excludes the most recent event generated at the end time during an interval.
  • EventInEnds
    : It is event-weighted, which includes the event generated at the start and end times during an interval.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal