openapi: 3.0.0
info:
  description: >-
    <p><br />This documentation describes the API endpoints allowing to fetch
    data from Metrics. Here's how to use them: <a
    href="https://help.tritondigital.com/user/docs/triton-metrics-api">Triton
    Metrics API User Guide</a>.<br />

    In order to use this API, you need to generate a JWT token using the <a href="https://token.tritondigital.com">Token page</a> or the <a href="https://login.tritondigital.com/docs">Login API</a>.<br />

    <span style="color:red">Note that the API can return a maximum of 100,000 rows.</span><br /><p/>
  title: Triton Metrics API
  contact:
    name: API Support
    url: http://tritondigital.com
    email: support@tritondigital.com
  version: v2
paths:
  /healthcheck:
    get:
      tags:
        - General
      summary: Healthcheck
      operationId: healthcheck
      responses: {}
  "/reports/{id}":
    get:
      security:
        - ApiKeyAuth: []
      description: Get Report
      tags:
        - Reports
      summary: Get Report
      operationId: getReport
      parameters:
        - x-fill-example: no
          description: ID of the saved query from which we want to fetch its data
          name: id
          in: path
          required: true
          example: a1b2c3-d4e5-f6g7h8i9j0
          schema:
            type: string
        - example: YYYY-MM-DD
          x-fill-example: no
          description: Start date override
          name: start
          in: query
          schema:
            type: string
            format: string
        - example: YYYY-MM-DD
          x-fill-example: no
          description: End date override
          name: end
          in: query
          schema:
            type: string
            format: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/models.GetReportResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/utils.ErrorResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/utils.ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/utils.ErrorResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/utils.ErrorResponse"
        "429":
          description: Too Many
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/utils.ErrorResponse"
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/utils.ErrorResponse"
components:
  securitySchemes:
    ApiKeyAuth:
      description: "- <u>Bearer token format</u>: bearer eyJ0eXAiOiJKV..."
      type: apiKey
      name: Authorization
      in: header
  schemas:
    models.GetReportResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: array
            items:
              $ref: "#/components/schemas/models.ReportDataProp"
        length:
          type: integer
        updatedAt:
          type: string
    models.ReportDataProp:
      type: object
      properties:
        exportValue: {}
        name:
          type: string
        value: {}
    utils.Error:
      type: object
      properties:
        message:
          type: string
    utils.ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: "#/components/schemas/utils.Error"
        status:
          type: integer