Skip to main content
POST
Retrieve a filtered report time series over a date range.

Authorizations

Authorization
string
header
required

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.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Reports.ApiGetTimeSeriesRequest, Derivitec.Web.Core
series_name
string | null

Name of the report series to retrieve.

start_date
string<date-time>

Lower date or date-time bound of the requested report period; inclusivity and time zone are not defined here.

end_date
string<date-time>

Upper date or date-time bound of the requested report period; inclusivity and time zone are not defined here.

filter
object

Marker role for a supported report-filter definition.

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.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Reports.ApiGetTimeSeriesResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

time_series
object[] | null

Time-series data returned by the report action.