openapi: 3.2.0
info:
  title: Fenergo Nebula Reporting Query Journey Report API
  description: Reporting Query API is part of FenX eco-system to manage Reporting. All the operations require valid access token obtained from Identity service.
  version: 1.0.0
servers:
- url: /reportingquery
security:
- Bearer: []
tags:
- name: JourneyReport
paths:
  /api/journey-report/journey-started-report:
    post:
      tags:
      - JourneyReport
      summary: Get report for journey started property
      description: 'Returns the list of journeys started within a specified date range.

        Limit: 10000 journeys, for more, please use the /file API


        Required permissions:

        Following permissions are required: ReportingAccess'
      operationId: GetJourneyStartedReport
      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: Start and end date
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DateRangeReportRequestServiceRequest'
      responses:
        '200':
          description: Success. Journey report for specified criteria is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JourneyStartedDtoDateRangeReportResponseServiceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
  /api/journey-report/journey-started-report/file:
    post:
      tags:
      - JourneyReport
      summary: Get file report for journey started property
      description: 'Returns the link to the file, with a list of journeys started within a specified date range


        Required permissions:

        Following permissions are required: ReportingAccess'
      operationId: GetJourneyStartedFileReport
      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: Start and end date
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DateRangeReportFileRequestServiceRequest'
      responses:
        '200':
          description: Success. Journey report for specified criteria is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DateRangeReportFileResponseServiceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
  /api/journey-report/journey-completed-report:
    post:
      tags:
      - JourneyReport
      summary: Get report for journey completed property
      description: 'Returns the list of journeys completed within a specified date range.

        Limit: 10000 journeys, for more, please use the /file API


        Required permissions:

        Following permissions are required: ReportingAccess'
      operationId: GetJourneyCompletedReport
      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: Start and end date
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DateRangeReportRequestServiceRequest'
      responses:
        '200':
          description: Success. Journey report for specified criteria is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JourneyCompletedDtoDateRangeReportResponseServiceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
  /api/journey-report/journey-completed-report/file:
    post:
      tags:
      - JourneyReport
      summary: Get file report for journey completed property
      description: 'Returns the link to the file, with a list of journeys completed within a specified date range


        Required permissions:

        Following permissions are required: ReportingAccess'
      operationId: GetJourneyCompletedFileReport
      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: Start and end date
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DateRangeReportFileRequestServiceRequest'
      responses:
        '200':
          description: Success. Journey report for specified criteria is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DateRangeReportFileResponseServiceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
  /api/journey-report/journey-updated-report:
    post:
      tags:
      - JourneyReport
      summary: Get report for journey updated property
      description: 'Returns the list of journeys updated within a specified date range.

        Limit: 10000 journeys, for more, please use the /file API


        Required permissions:

        Following permissions are required: ReportingAccess'
      operationId: GetJourneyUpdatedReport
      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: Start and end date
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DateRangeReportRequestServiceRequest'
      responses:
        '200':
          description: Success. Journey report for specified criteria is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JourneyUpdatedDtoDateRangeReportResponseServiceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
  /api/journey-report/journey-updated-report/file:
    post:
      tags:
      - JourneyReport
      summary: Get file report for journey updated property
      description: 'Returns the link to the file, with a list of journeys updated within a specified date range


        Required permissions:

        Following permissions are required: ReportingAccess'
      operationId: GetJourneyUpdatedFileReport
      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: Start and end date
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DateRangeReportFileRequestServiceRequest'
      responses:
        '200':
          description: Success. Journey report for specified criteria is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DateRangeReportFileResponseServiceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '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
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
components:
  schemas:
    JourneyCompletedDtoDateRangeReportResponseServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JourneyCompletedDtoDateRangeReportResponse'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    DateRangeReportFileRequest:
      type: object
      properties:
        startDate:
          type:
          - string
          - 'null'
          description: Start Date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        endDate:
          type:
          - string
          - 'null'
          description: End Date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        fileFormat:
          $ref: '#/components/schemas/FileFormat'
      additionalProperties: false
      description: Request representing file report
    DateRangeReportFileRequestServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DateRangeReportFileRequest'
      additionalProperties: false
      description: Service request data
    DateRangeReportRequestServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DateRangeReportRequest'
      additionalProperties: false
      description: Service request data
    JourneyUpdatedDtoDateRangeReportResponse:
      type: object
      properties:
        count:
          type: integer
          description: Count of items returned
          format: int32
          readOnly: true
          example: 22
        datasetSizeAccepted:
          type: boolean
          description: Boolean flag indicating if returned dataset size is appropriate
          readOnly: true
          example: true
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/JourneyUpdatedDto'
          description: List of !:TDto
      additionalProperties: false
    JourneyStartedDto:
      type: object
      properties:
        startedTime:
          type: string
          description: Started Time
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        journeyId:
          type: string
          description: Journey Id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        journeyType:
          type:
          - string
          - 'null'
          description: Journey Type
          example: Client Onboarding
        currentJourneyStatus:
          type:
          - string
          - 'null'
          description: 'Journey Status - Example Values: In Progress | Completed | Cancelled'
          example: Client Onboarding
        journeySchemaId:
          type: string
          description: Journey Schema Id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        legalEntityId:
          type: string
          description: Legal Entity Id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        businessRelatedAccessLayers:
          type:
          - string
          - 'null'
          description: Business Access Layers
        geographicAccessLayers:
          type:
          - string
          - 'null'
          description: Geographic Access Layers
      additionalProperties: false
      description: Response DTO representing started journey
    JourneyUpdatedDtoDateRangeReportResponseServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JourneyUpdatedDtoDateRangeReportResponse'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    JourneyUpdatedDto:
      type: object
      properties:
        updatedTime:
          type: string
          description: Updated Time
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        eventType:
          type:
          - string
          - 'null'
          description: Event Type
          example: TaskCompleted
        startedTime:
          type: string
          description: Started Time
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        journeyId:
          type: string
          description: Journey Id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        journeyType:
          type:
          - string
          - 'null'
          description: Journey Type
          example: Client Onboarding
        currentJourneyStatus:
          type:
          - string
          - 'null'
          description: 'Journey Status - Example Values: In Progress | Completed | Cancelled'
          example: Client Onboarding
        journeySchemaId:
          type: string
          description: Journey Schema Id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        legalEntityId:
          type: string
          description: Legal Entity Id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        businessRelatedAccessLayers:
          type:
          - string
          - 'null'
          description: Business Access Layers
        geographicAccessLayers:
          type:
          - string
          - 'null'
          description: Geographic Access Layers
      additionalProperties: false
      description: Response DTO representing updated journey
    JourneyStartedDtoDateRangeReportResponse:
      type: object
      properties:
        count:
          type: integer
          description: Count of items returned
          format: int32
          readOnly: true
          example: 22
        datasetSizeAccepted:
          type: boolean
          description: Boolean flag indicating if returned dataset size is appropriate
          readOnly: true
          example: true
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/JourneyStartedDto'
          description: List of !:TDto
      additionalProperties: false
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    JourneyStartedDtoDateRangeReportResponseServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JourneyStartedDtoDateRangeReportResponse'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    DateRangeReportFileResponse:
      type: object
      properties:
        reportFileUrl:
          type:
          - string
          - 'null'
          description: Report File URL
          example: https://google.com/report.csv
        count:
          type: integer
          description: Count
          format: int32
          example: 23
        expirationDate:
          type: string
          description: Link expiration date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
      additionalProperties: false
      description: Response representing file report
    FileFormat:
      enum:
      - csv
      - json
      type: string
    ObjectServiceResponse:
      type: object
      properties:
        data:
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    JourneyCompletedDto:
      type: object
      properties:
        completedTime:
          type: string
          description: Completed Time
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        startedTime:
          type: string
          description: Started Time
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        duration:
          type: integer
          description: Duration (in seconds)
          format: int32
          example: 234
        journeyId:
          type: string
          description: Journey Id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        journeyType:
          type:
          - string
          - 'null'
          description: Journey Type
          example: Client Onboarding
        journeySchemaId:
          type: string
          description: Journey Schema Id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        legalEntityId:
          type: string
          description: Legal Entity Id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        businessRelatedAccessLayers:
          type:
          - string
          - 'null'
          description: Business Access Layers
        geographicAccessLayers:
          type:
          - string
          - 'null'
          description: Geographic Access Layers
      additionalProperties: false
      description: Response DTO representing completed journey
    JourneyCompletedDtoDateRangeReportResponse:
      type: object
      properties:
        count:
          type: integer
          description: Count of items returned
          format: int32
          readOnly: true
          example: 22
        datasetSizeAccepted:
          type: boolean
          description: Boolean flag indicating if returned dataset size is appropriate
          readOnly: true
          example: true
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/JourneyCompletedDto'
          description: List of !:TDto
      additionalProperties: false
    DateRangeReportFileResponseServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DateRangeReportFileResponse'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    DateRangeReportRequest:
      type: object
      properties:
        startDate:
          type:
          - string
          - 'null'
          description: Start Date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        endDate:
          type:
          - string
          - 'null'
          description: End Date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
      additionalProperties: false
      description: Request representing report
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          description: The message
          example: Success
        type:
          type:
          - string
          - 'null'
          description: 'Type of the message

            One of Info, Warning, Error, Forbidden'
          example: Info
        errorCode:
          type:
          - string
          - 'null'
          description: Error Code
          example: INTERNAL_SERVER_ERROR
      additionalProperties: false
      description: The message associated to the service response
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header