real_time_query.yaml

post:
  tags:
    - Queries
  summary:
    Execute Real-time query
  description: |
    API that allows querying the Real-time database directly. Please note that each
    request must be authenticated.
  requestBody:
    required: true
    content:
      application/json:
        schema:
          $ref: '../index.yaml#/components/schemas/RealTimeQueryRequest'
  responses:
    200:
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                description: Rows with results for the query.
                items:
                  type: object
              meta:
                type: object
                description: Additional results metadata for the query.
                properties:
                  count:
                    type: integer
                    description: Total number of results available for this query.
            example: {"data": [[["EU", "Europe"], "Blink", 529437, 128334], [["NA", "North America"], "Blink", 199355, 47171], [["AS", "Asia"], "Blink", 153385, 37308]], "meta": {"count": 42}}
    400:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  type: object
                  properties:
                    status:
                      type: string
                      description: HTTP status code for the error.
                    detail:
                      type: string
                      description: Additional information about the error.
                    source:
                      type: object
                      description: Source of the error (if available).
                      properties:
                        parameter:
                          type: string
                          description: Path to the parameter that caused the error.
            example: { "errors": [ { "status": "400", "detail": "Dimension \"example\" does not exist.", "source": { "parameter": "columns.column_id" } } ] }
    401:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  type: object
                  properties:
                    status:
                      type: string
                      description: HTTP status code for the error.
                    detail:
                      type: string
                      description: Additional information about the error.
            example: { "errors": [ { "status": "401", "detail": "No valid credentials provided." } ] }
    403:
      description: Forbidden
      content:
        application/json:
          schema:
            type: object
            properties:
              errors:
                type: array
                items:
                  type: object
                  properties:
                    status:
                      type: string
                      description: HTTP status code for the error.
                    detail:
                      type: string
                      description: Additional information about the error.
            example: { "errors": [ { "status": "403", "detail": "No valid license found." } ] }