openapi: 3.2.0
info:
  title: Fenergo Nebula Business Metrics Query Entity Metrics API
  description: '**Business Metrics Query API**:


    Business Metrics Query API provides endpoints in order to retrieve all related models and their versions.


    **Business Metrics Query API provides**:'
  version: '1.0'
servers:
- url: /businessmetricsquery
security:
- Bearer: []
tags:
- name: EntityMetrics
paths:
  /api/entitymetrics/getentitycountbydaterange:
    post:
      tags:
      - EntityMetrics
      summary: Get entity count metrics by date range
      description: 'Required permissions:

        Following permissions are required: ValueStoryAccess'
      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/EntityMetricsRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityMetricsRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityMetricsRequestDtoServiceRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetEntityCountByDateRangeResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetEntityCountByDateRangeResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetEntityCountByDateRangeResponseDtoServiceResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '500':
          description: Internal Server Error
        '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
        '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
      operationId: postApiEntitymetricsGetentitycountbydaterange
      x-operation-id-source: derived
  /api/entitymetrics/getrelatedpartycountbydaterange:
    post:
      tags:
      - EntityMetrics
      summary: Get related-party count metrics by date range
      description: 'Required permissions:

        Following permissions are required: ValueStoryAccess'
      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/EntityMetricsRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityMetricsRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityMetricsRequestDtoServiceRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetRelatedPartyCountByDateRangeResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetRelatedPartyCountByDateRangeResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetRelatedPartyCountByDateRangeResponseDtoServiceResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '500':
          description: Internal Server Error
        '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
        '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
      operationId: postApiEntitymetricsGetrelatedpartycountbydaterange
      x-operation-id-source: derived
components:
  schemas:
    GetRelatedPartyCountByDateRangeResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetRelatedPartyCountByDateRangeResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EntityMetricsRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityMetricsRequestDto'
          description: Request DTO for entity metrics date-range queries.
      additionalProperties: false
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    GetEntityCountByDateRangeResponseDto:
      type: object
      properties:
        entityCounts:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityCountByTypeDto'
        totalCurrentPeriod:
          type: integer
          format: int32
        totalPreviousPeriod:
          type: integer
          format: int32
        delta:
          type: integer
          format: int32
      additionalProperties: false
    EntityCountByTypeDto:
      type: object
      properties:
        entityType:
          type:
          - string
          - 'null'
        createdCount:
          type: integer
          format: int32
        verifiedCount:
          type: integer
          format: int32
        rejectedCount:
          type: integer
          format: int32
        totalCurrentPeriod:
          type: integer
          format: int32
        totalPreviousPeriod:
          type: integer
          format: int32
        delta:
          type: integer
          format: int32
      additionalProperties: false
    GetEntityCountByDateRangeResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetEntityCountByDateRangeResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EntityMetricsRequestDto:
      type: object
      properties:
        startDate:
          type:
          - string
          - 'null'
          description: Start date in yyyy/MM/dd format.
        endDate:
          type:
          - string
          - 'null'
          description: End date in yyyy/MM/dd format.
      additionalProperties: false
      description: Request DTO for entity metrics date-range queries.
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    GetRelatedPartyCountByDateRangeResponseDto:
      type: object
      properties:
        addedCount:
          type: integer
          format: int32
        removedCount:
          type: integer
          format: int32
        netActive:
          type: integer
          format: int32
        previousPeriodNetActive:
          type: integer
          format: int32
        delta:
          type: integer
          format: int32
      additionalProperties: false
    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