Retrieve a filtered report time series over a date range.
Reads the named time series for the authenticated caller using the supplied start and end calendar-date bounds. The supplied date-time values are reduced to local calendar dates; no additional time-zone conversion contract is exposed. This operation does not launch a report or expose a cancellation lifecycle.
Authorizations
OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header
Body
The body containing required SeriesName, StartDate, and EndDate date-time values and an optional polymorphic Filter.
Series, date-range, and optional row-filter selectors for report time-series data.
Derivitec.Web.Core.Reports.ApiGetTimeSeriesRequest, Derivitec.Web.Core Name of the report series to retrieve.
Lower date or date-time bound of the requested report period; inclusivity and time zone are not defined here.
Upper date or date-time bound of the requested report period; inclusivity and time zone are not defined here.
Marker role for a supported report-filter definition.
- Option 1
- Option 2
Response
Returns matching time-series values, or an unsuccessful envelope with error messages when the lookup cannot be completed.
Time-series values returned for the requested report series.
Derivitec.Web.Core.Reports.ApiGetTimeSeriesResponse, Derivitec.Web.Core Whether the operation completed successfully. The default is true; error outcomes set it to false.
true
Messages explaining operation-level failures. The collection is empty by default.
Time-series data returned by the report action.