> ## Documentation Index
> Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/Report/GetTimeSeries
openapi: 3.0.4
info:
  title: Derivitec Api 1.0
  version: '1.0'
servers:
  - url: https://api.riskportal.activeviam.com
security:
  - oauth2: []
  - apikey: []
tags:
  - name: AdminUser
  - name: AtotiReport
  - name: AtotiSession
  - name: BloombergOAuth
  - name: Bond
  - name: BondYieldCurvePage
  - name: BookAccess
  - name: Books
  - name: Commodity
  - name: Counterparties
  - name: Currencies
  - name: Equity
  - name: EquityDividend
  - name: EquityPage
  - name: FeatureFlag
  - name: Fx
  - name: FxPage
  - name: GroupAccess
  - name: Home
  - name: LegacyPosition
  - name: MarketData
  - name: MarketDataProvider
  - name: MarketDataProviderAccess
  - name: Meta
  - name: Notification
  - name: Organisation
  - name: PnLReport
  - name: PortfolioAccess
  - name: Portfolios
  - name: Position
  - name: PositionFilter
  - name: PricingEnvironment
  - name: PricingEnvironmentAccess
  - name: RateAsset
  - name: RateAssetPage
  - name: Report
  - name: ReportDefinition
  - name: ReportHistoryLauncherQuery
  - name: ReportLauncher
  - name: ReportQuery
  - name: ReportQueryViewUser
  - name: ReportRestriction
  - name: ReportView
  - name: RiskReport
  - name: Tradable
  - name: TradeBooking
  - name: User
  - name: VarReport
  - name: VarReportQuery
  - name: YieldCurvePage
paths:
  /api/Report/GetTimeSeries:
    post:
      tags:
        - Report
      summary: Retrieve a filtered report time series over a date range.
      description: >-
        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.
      operationId: GetTimeSeries
      requestBody:
        description: >-
          The body containing required `SeriesName`, `StartDate`, and `EndDate`
          date-time values and an optional polymorphic `Filter`.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetTimeSeriesRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetTimeSeriesRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetTimeSeriesRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetTimeSeriesRequest'
      responses:
        '200':
          description: >-
            Returns matching time-series values, or an unsuccessful envelope
            with error messages when the lookup cannot be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetTimeSeriesResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetTimeSeriesRequest:
      required:
        - $type
      type: object
      properties:
        series_name:
          type: string
          description: Name of the report series to retrieve.
          nullable: true
        start_date:
          type: string
          description: >-
            Lower date or date-time bound of the requested report period;
            inclusivity and time zone are not defined here.
          format: date-time
        end_date:
          type: string
          description: >-
            Upper date or date-time bound of the requested report period;
            inclusivity and time zone are not defined here.
          format: date-time
        filter:
          $ref: '#/components/schemas/IFilterDefinition'
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Reports.ApiGetTimeSeriesRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Series, date-range, and optional row-filter selectors for report
        time-series data.
    ApiGetTimeSeriesResponse:
      required:
        - $type
      type: object
      properties:
        is_success:
          type: boolean
          description: >-
            Whether the operation completed successfully. The default is `true`;
            error outcomes set it to `false`.
          example: true
        error_messages:
          type: array
          items:
            type: string
          description: >-
            Messages explaining operation-level failures. The collection is
            empty by default.
          nullable: true
        time_series:
          description: Time-series data returned by the report action.
          type: array
          items:
            type: object
            additionalProperties: true
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Reports.ApiGetTimeSeriesResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Time-series values returned for the requested report series.
    IFilterDefinition:
      description: Marker role for a supported report-filter definition.
      discriminator:
        propertyName: $type
        mapping:
          Derivitec.Web.Core.Reports.Equal, Derivitec.Web.Core: '#/components/schemas/Equal'
          Derivitec.Web.Core.Interfaces.IFilterDefinition, Derivitec.Web.Core: '#/components/schemas/IFilterDefinitionMintlifyShape'
      oneOf:
        - $ref: '#/components/schemas/Equal'
        - $ref: '#/components/schemas/IFilterDefinitionMintlifyShape'
    Equal:
      required:
        - $type
      type: object
      properties:
        column_name:
          type: string
          description: Gets or sets column name.
          nullable: true
        value:
          description: Gets or sets the value.
          oneOf:
            - type: string
              nullable: true
            - type: number
            - type: boolean
            - type: array
              items: {}
            - type: object
              additionalProperties: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.Reports.Equal, Derivitec.Web.Core
      additionalProperties: false
      description: The equal.
    IFilterDefinitionMintlifyShape:
      required:
        - $type
      type: object
      additionalProperties: false
      description: Marker role for a supported report-filter definition.
      properties:
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Interfaces.IFilterDefinition,
              Derivitec.Web.Core
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth2 access-token requested from AWS Cognito and provided as a Auth
        Bearer header
      flows:
        implicit:
          authorizationUrl: https://auth.riskportal.derivitec.com/oauth2/authorize
          scopes: {}
    apikey:
      type: apiKey
      description: API-Key requested via the site and provided as a header
      name: x-api-key
      in: header

````