Striim Monitoring API

openapi: 3.2.0
info:
  version: 5.4.0.2-oas3
  title: Striim TQL Files REST API version 5.4.0.2 Monitoring API
  description: API for uploading, listing, and deleting TQL files in Striim.
  contact:
    name: Striim support
    url: https://go2.striim.com/request-support-striim
    email: support@striim.com
  termsOfService: http://www.striim.com/eula/
tags:
- name: Monitoring
  x-displayName: monitoring
paths:
  /applications/monitoring/report/{applicationnameOrComponentName}:
    servers:
    - url: http://localhost:8080/api/v2
    get:
      description: 'Returns monitoring report for the specified application, source, or target.


        Specify **applicationName** as `.` (the fully qualified name), for example, `Samples.PosApp`, or `.`, for example, `Samples.CsvDataSource`.


        Specify **starttime** and **endtime** as `HH:mm` (current day), `yyyy/MM/dd-HH:mm`, `yyyy/MM/dd-HH:mm:ss`, or `yyyy/MM/dd-HH:mm:ss:SSS`.


        The default rollup interval is 15 minutes. To change that, specify **rollupinterval** as `30m` (30 minutes) or `1h` (one hour).


        For more information, see Using monitor reports and Using the MON command.'
      summary: retrieve monitoring report
      tags:
      - Monitoring
      operationId: ApplicationsApplicationMonitoringReportByApplicationNameGet
      parameters:
      - name: applicationnameOrComponentName
        in: path
        required: true
        description: Fully qualified component or application name
        schema:
          type: string
      - name: starttime
        in: query
        required: true
        description: A required parameter which specifies the start time from which application/component monitoring report has to be generated
        schema:
          type: string
      - name: endtime
        in: query
        required: true
        description: A required parameter which specifies the end time from which application/component monitoring report has to be generated
        schema:
          type: string
      - name: rollupinterval
        in: query
        required: false
        description: An optional parameter that specifies interval at which this application/component report metrics have to be rolled up. If not specified default is 15m, accepted values for this parameter are 15m, 30m and 1h.
        schema:
          type: string
      responses:
        '200':
          description: Success
        '400':
          description: Specified application or component name is not in fully qualified format or an invalid start/end time or rollup interval is specifed
          content:
            application/json:
              schema: {}
        '401':
          description: No valid User found for specified authentication token
          content:
            application/json:
              schema: {}
        '404':
          description: Application or component name not found.
          content:
            application/json:
              schema: {}
        '500':
          description: Internal Server error
          content:
            application/json:
              schema: {}
      security:
      - Authorization: []
      x-unitTests: []
      x-operation-settings:
        CollectParameters: false
        AllowDynamicQueryParameters: false
        AllowDynamicFormParameters: false
        IsMultiContentStreaming: false
      x-stoplight:
        id: nifyj5h0a90e0
components:
  securitySchemes:
    Authorization:
      type: apiKey
      description: ''
      name: Authorization
      in: header
      x-testValue: ''
      x-skip-client-authentication: false
x-stoplight:
  id: z7fl2mixydrcb
x-tagGroups:
- name: Striim TQL Files REST API version 5.4.0.2
  tags:
  - tqlfiles
- name: Striim Application Management REST API version 3.10.3
  tags:
  - application
  - template
  - applicationMetadata
  - checkpoint
  - monitoring
  - tungsten