openapi: 3.2.0
info:
  title: Fenergo Nebula Advanced Dashboard Query Dashboards API
  description: '**Advanced Dashboard Query API**:


    Advanced Dashboard Query API provides endpoints in order to retrieve all related models and their versions.


    **Advanced Dashboard Query API provides**:'
  version: 1.0.0
servers:
- url: /advanceddashboardquery
security:
- Bearer: []
tags:
- name: Dashboards
paths:
  /api/dashboards/journey:
    post:
      tags:
      - Dashboards
      summary: Get journey dashboard data
      description: 'Returns the data for journey dashboard for a given tenant


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: GetJourneyDashboard
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/JourneyDashboardDataRequestDto'
              description: Represents the data model Journey Dashboard request
      responses:
        '200':
          description: Success. Journey Dashboard data is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JourneyDashboardDataDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
  /api/dashboards/journey/aggregation:
    post:
      tags:
      - Dashboards
      summary: Retrieves aggregated journey dashboard data for the specified tenant
      description: 'This endpoint returns grouped data based on the specified aggregation field (e.g., for pie chart visualization),

        optionally filtered by the provided field-value pairs.


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: GetJourneyDataAggregation
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: The request containing filter criteria and the field to aggregate on.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AggregationRequestDto'
              description: Represents the request for aggregation.
      responses:
        '200':
          description: Success. Aggregated journey dashboard data is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AggregationResponseDtoServiceResponse'
        '400':
          description: Bad request. One or more request values are missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
  /api/dashboards/task:
    post:
      tags:
      - Dashboards
      summary: Get task dashboard data
      description: 'Returns the data for task dashboard for a given tenant


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: GetTaskDashboard
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TaskDashboardDataRequestDto'
              description: Represents the data model Task Dashboard request
      responses:
        '200':
          description: Success. Task Dashboard data is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskDashboardDataDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
  /api/dashboards/task/aggregation:
    post:
      tags:
      - Dashboards
      summary: Retrieves aggregated task dashboard data for the specified tenant
      description: 'This endpoint returns grouped data based on the specified aggregation field (e.g., for pie chart visualization),

        optionally filtered by the provided field-value pairs.


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: GetTaskDataAggregation
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: The request containing filter criteria and the field to aggregate on.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AggregationRequestDto'
              description: Represents the request for aggregation.
      responses:
        '200':
          description: Success. Aggregated task dashboard data is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AggregationResponseDtoServiceResponse'
        '400':
          description: Bad request. One or more request values are missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
  /api/dashboards/journey/{journeyId}/tasks:
    get:
      tags:
      - Dashboards
      summary: Get Tasks by Journey ID
      description: 'Returns the data for Tasks for a given Journey ID


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: GetTasksByJourneyId
      parameters:
      - name: journeyId
        in: path
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. Tasks data is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JourneyDashboardDataDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
  /api/dashboards/journey/filter-options/{field}:
    get:
      tags:
      - Dashboards
      summary: Get Journey dashboard filter options for a given field
      description: 'Returns a list of options.


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: GetJourneyDashboardFilterOptions
      parameters:
      - name: field
        in: path
        required: true
        schema:
          minLength: 1
          type: string
      - name: searchPhrase
        in: query
        schema:
          type: string
      - name: sortByValue
        in: query
        schema:
          type: boolean
          default: false
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. Options returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringArrayServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
  /api/dashboards/task/filter-options/{field}:
    get:
      tags:
      - Dashboards
      summary: Get Task dashboard filter options for a given field
      description: 'Returns a list of options.


        Required permissions:

        Following permissions are required: AdvancedDashboardAccess'
      operationId: GetTaskDashboardFilterOptions
      parameters:
      - name: field
        in: path
        required: true
        schema:
          minLength: 1
          type: string
      - name: searchPhrase
        in: query
        schema:
          type: string
      - name: sortByValue
        in: query
        schema:
          type: boolean
          default: false
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. Options returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringArrayServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
components:
  schemas:
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    TaskDashboardDataRequestDto:
      type: object
      properties:
        page:
          minimum: 0
          type: integer
          description: Requested page number
          format: int32
        pageSize:
          minimum: 1
          type: integer
          description: Page size
          format: int32
        sortBy:
          type:
          - string
          - 'null'
          description: Field name used for sorting
        sortOrder:
          allOf:
          - $ref: '#/components/schemas/SortOrder'
          description: Sort order
        searchPhrase:
          type:
          - string
          - 'null'
          description: Full-text search phrase
        filter:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              type: string
          description: Filter criteria
        viewId:
          type:
          - string
          - 'null'
          description: View to use when formatting the data, if not provided, the default view will be used
      additionalProperties: false
      description: Represents the data model Task Dashboard request
    SortOrder:
      enum:
      - Ascending
      - Descending
      type: string
    TaskDashboardDataDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/TaskDashboardDataDto'
          description: Represents the data returned by the Task Dashboard
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    AggregationResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/AggregationResponseDto'
          description: Represents the response after aggregation.
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringArrayServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            type: string
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    JourneyDashboardDataRequestDto:
      type: object
      properties:
        page:
          minimum: 0
          type: integer
          description: Requested page number
          format: int32
        pageSize:
          minimum: 1
          type: integer
          description: Page size
          format: int32
        sortBy:
          type:
          - string
          - 'null'
          description: Field name used for sorting
        sortOrder:
          allOf:
          - $ref: '#/components/schemas/SortOrder'
          description: Sort order
        searchPhrase:
          type:
          - string
          - 'null'
          description: Full-text search phrase
        filter:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              type: string
          description: Filter criteria
        viewId:
          type:
          - string
          - 'null'
          description: View to use when formatting the data, if not provided, the default view will be used
      additionalProperties: false
      description: Represents the data model Journey Dashboard request
    AggregatedFieldDto:
      type: object
      properties:
        fieldValue:
          type:
          - string
          - 'null'
        count:
          type: integer
          format: int32
      additionalProperties: false
    TaskDashboardDataDto:
      type: object
      properties:
        total:
          type: integer
          description: Total number of items matching the criteria
          format: int64
        items:
          type:
          - array
          - 'null'
          items: {}
          description: Items for the requested page
      additionalProperties: false
      description: Represents the data returned by the Task Dashboard
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    JourneyDashboardDataDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/JourneyDashboardDataDto'
          description: Represents the data returned by the Journey Dashboard
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    AggregationResponseDto:
      type: object
      properties:
        aggregatedResults:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AggregatedFieldDto'
          description: The aggregated results
        totalCount:
          type: integer
          description: The combined total of all aggregated counts
          format: int64
      additionalProperties: false
      description: Represents the response after aggregation.
    JourneyDashboardDataDto:
      type: object
      properties:
        total:
          type: integer
          description: Total number of items matching the criteria
          format: int64
        items:
          type:
          - array
          - 'null'
          items: {}
          description: Items for the requested page
      additionalProperties: false
      description: Represents the data returned by the Journey Dashboard
    AggregationRequestDto:
      type: object
      properties:
        filter:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              type: string
          description: A dictionary of field names and their corresponding values to filter the data.
        aggregationField:
          type:
          - string
          - 'null'
          description: The field to aggregate data by (e.g., for generating pie charts or grouped summaries).
        maxAggregationResults:
          type: integer
          description: The number of aggregated results to return in the response
          format: int32
      additionalProperties: false
      description: Represents the request for aggregation.
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header