indigitall Stats Service Report API

openapi: 3.2.0
info:
  version: 2.0.0
  title: INDIGITALL Stats Service Report API
  x-logo:
    url: https://console.indigitall.com/images/logo_verdeblanco@2x.png
    backgroundColor: '#0F3B7A'
  description: '### Introduction:

    This documentation describes every endpoint of Indigitall''s API v2


    API BASE URL: https://api.indigitall.com/v2


    ### Authentication:


    Most of the endpoints of the API needs an Authorization header.


    There are two Authorization ways:


    - If your intention is to manage API calls with a server-side script you have to create a Server key through Indigitall''s console.


    You can set the following Authorization Header : ''Authorization: ServerKey {ServerKey}''

    - If your intention is to integrate this API for front-end users POST /auth endpoint authorizes a user and returns an access token.


    You can set the following Authorization Header : ''Authorization: Bearer {Token}'''
servers:
- url: https://api.indigitall.com/v2
security:
- Authorization: []
tags:
- name: stats-service-report
  x-displayName: Stats - Report
paths:
  /application/{applicationId}/stats/dashboard:
    get:
      summary: Returns service statistics by application
      description: Returns statistics of email, sms, inapp and customer services from an application id.
      operationId: getApplicationStatsDashboard
      x-gateway-mode: custom
      x-gateway-controller: statsController
      tags:
      - stats-service-report
      parameters:
      - in: path
        name: applicationId
        description: This ID identifies the specific application.
        required: true
        schema:
          type: integer
      - in: query
        name: dateFrom
        description: "Date start format yyyy-mm-dd\nEx:\n    2019-01-01\n"
        required: true
        schema:
          type: string
          format: date
      - in: query
        name: dateTo
        description: "Date end format yyyy-mm-dd\nEx:\n    2019-01-01\n"
        required: true
        schema:
          type: string
          format: date
      responses:
        '200':
          $ref: '#/components/responses/StatsDashboardResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/Error'
        default:
          $ref: '#/components/responses/Default'
  /stats/application/{applicationId}/report/config:
    post:
      tags:
      - stats-service-report
      summary: Create report configuration for an application
      description: Creates the report configuration settings for a specific application.
      x-gateway-controller: statsController
      x-gateway-endpoint: statsService
      x-gateway-mode: custom
      operationId: createReportConfig
      parameters:
      - in: path
        name: applicationId
        description: 'The ID of the application for which the report configuration is to be created.

          '
        schema:
          type: integer
        required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SSPostReportConfigRequestBody'
        required: true
      responses:
        '201':
          description: The request has succeeded. The response contains the status code and a message indicating success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    description: The HTTP status code indicating a successful request.
                    example: 201
                  message:
                    type: string
                    description: A brief message describing the result of the request.
                    example: Created
                  data:
                    $ref: '#/components/schemas/SSReportConfig'
                required:
                - statusCode
                - message
                - data
                additionalProperties: false
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/Error'
        default:
          $ref: '#/components/responses/Default'
    get:
      tags:
      - stats-service-report
      summary: Retrieve report configuration for a specific application
      description: Retrieves the report configuration settings for a specific application identified by `applicationId`.
      x-eov-operation-handler: reportConfigController
      x-gateway-endpoint: statsService
      operationId: findByApplicationId
      parameters:
      - in: path
        name: applicationId
        description: The ID of the application for which to retrieve the report configuration. This ID identifies the specific application.
        required: true
        schema:
          type: integer
      - in: query
        name: limit
        description: The maximum number of report configurations to retrieve.
        schema:
          type: integer
          default: 10
      - in: query
        name: page
        description: The page number for pagination.
        schema:
          type: integer
          default: 0
      - in: query
        name: cycle
        description: The cycle for which to retrieve the report configuration.
        schema:
          type: string
          enum:
          - daily
          - weekly
          - monthly
      - in: query
        name: reportName
        description: The names of reports to filter by.
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: The request has succeeded. The response contains the status code and a message indicating success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    description: The HTTP status code indicating a successful request.
                    example: 200
                  message:
                    type: string
                    description: A brief message describing the result of the request.
                    example: OK
                  count:
                    type: integer
                    description: The number of report configurations found.
                    example: 1
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SSReportConfig'
                required:
                - statusCode
                - message
                - data
                additionalProperties: false
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/Error'
        default:
          $ref: '#/components/responses/Default'
  /stats/application/{applicationId}/report/config/{configId}:
    delete:
      tags:
      - stats-service-report
      summary: Delete a report configuration by application ID
      description: Deletes the report configuration for the specified application ID. If the configuration does not exist, a 404 error will be returned.
      x-eov-operation-handler: reportConfigController
      x-gateway-endpoint: statsService
      operationId: deleteById
      parameters:
      - in: path
        name: applicationId
        description: The ID of the application whose report configuration is to be deleted.
        required: true
        schema:
          type: integer
      - in: path
        name: configId
        description: The ID of the report configuration to delete.
        required: true
        schema:
          type: integer
      responses:
        '200':
          $ref: '#/components/responses/Ok'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/Error'
        default:
          $ref: '#/components/responses/Default'
    get:
      tags:
      - stats-service-report
      summary: Retrieve a specific report configuration
      description: Retrieves a specific report configuration for a specific application identified by `applicationId`.
      x-eov-operation-handler: reportConfigController
      x-gateway-endpoint: statsService
      operationId: findById
      parameters:
      - in: path
        name: applicationId
        description: The ID of the application for which to retrieve the report configuration. This ID identifies the specific application.
        required: true
        schema:
          type: integer
      - in: path
        name: configId
        description: The ID of the report configuration to retrieve.
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: The request has succeeded. The response contains the status code and a message indicating success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    description: The HTTP status code indicating a successful request.
                    example: 200
                  message:
                    type: string
                    description: A brief message describing the result of the request.
                    example: OK
                  data:
                    $ref: '#/components/schemas/SSReportConfig'
                required:
                - statusCode
                - message
                - data
                additionalProperties: false
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/Error'
        default:
          $ref: '#/components/responses/Default'
    put:
      tags:
      - stats-service-report
      summary: Update report configuration for a specific application
      description: Updates the report configuration settings for a specific application identified by `applicationId`. This endpoint allows you to modify the existing configuration for the application.
      x-eov-operation-handler: reportConfigController
      x-gateway-endpoint: statsService
      operationId: update
      parameters:
      - in: path
        name: applicationId
        description: The ID of the application for which to update the report configuration. This ID identifies the specific application.
        required: true
        schema:
          type: integer
      - in: path
        name: configId
        description: The ID of the report configuration to update.
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SSPutReportConfigRequestBody'
        required: true
      responses:
        '200':
          description: The request has succeeded. The response contains the status code and a message indicating success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    description: The HTTP status code indicating a successful request.
                    example: 200
                  message:
                    type: string
                    description: A brief message describing the result of the request.
                    example: OK
                  data:
                    $ref: '#/components/schemas/SSReportConfig'
                required:
                - statusCode
                - message
                - data
                additionalProperties: false
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/Error'
        default:
          $ref: '#/components/responses/Default'
components:
  responses:
    Error:
      description: The server encountered an unexpected condition that prevented it from fulfilling the request.
      content:
        application/json:
          schema:
            type: object
            properties:
              statusCode:
                type: integer
                description: The HTTP status code indicating an internal server error.
                example: 500
              message:
                type: string
                description: A brief message indicating that the server encountered an unexpected condition that prevented it from fulfilling the request.
                example: Internal Server Error
            required:
            - statusCode
            - message
            additionalProperties: false
    Default:
      description: An unexpected error occurred.
      content:
        application/json:
          schema:
            type: object
            properties:
              statusCode:
                type: integer
                description: The HTTP status code indicating an error.
                example: 500
              message:
                type: string
                description: A brief message describing the error.
                example: An unexpected error occurred.
            required:
            - statusCode
            - message
            additionalProperties: false
    Conflict:
      description: The request could not be processed because of conflict in the request.
      content:
        application/json:
          schema:
            type: object
            properties:
              statusCode:
                type: integer
                description: The HTTP status code indicating a conflict with the current state of the resource.
                example: 409
              message:
                type: string
                description: A brief message indicating that the request could not be processed because of conflict in the request.
                example: Conflict
              errorCode:
                type: string
                description: A specific error code for the conflict request.
            required:
            - statusCode
            - message
            - errorCode
            additionalProperties: false
    NotFound:
      description: The requested resource could not be found.
      content:
        application/json:
          schema:
            type: object
            properties:
              statusCode:
                type: integer
                description: The HTTP status code indicating that the requested resource could not be found.
                example: 404
              message:
                type: string
                description: A brief message indicating that the requested resource could not be found.
                example: Not found
              errorCode:
                type: string
                description: A specific error code for the not found request.
            required:
            - statusCode
            - message
            - errorCode
            additionalProperties: false
    Forbidden:
      description: The server understood the request, but refuses to authorize it.
      content:
        application/json:
          schema:
            type: object
            properties:
              statusCode:
                type: integer
                description: The HTTP status code indicating that the server understood the request but refuses to authorize it.
                example: 403
              message:
                type: string
                description: A brief message indicating that the server refuses to authorize the request.
                example: Forbidden
              errorCode:
                type: string
                description: A specific error code for the forbidden request.
            required:
            - statusCode
            - message
            - errorCode
            additionalProperties: false
    StatsDashboardResponse:
      description: Success
      content:
        application/json:
          schema:
            type: object
            properties:
              statusCode:
                type: integer
                description: The HTTP status code indicating a successful request.
                example: 201
              message:
                type: string
                description: A brief message describing the result of the request.
                example: Created
              data:
                $ref: '#/components/schemas/SS_ApplicationDashboardStats'
            required:
            - statusCode
            - message
            - data
            additionalProperties: false
    Ok:
      description: The request has succeeded. The response contains the status code and a message indicating success.
      content:
        application/json:
          schema:
            type: object
            properties:
              statusCode:
                type: integer
                description: The HTTP status code indicating a successful request.
                example: 200
              message:
                type: string
                description: A brief message describing the result of the request.
                example: OK
            required:
            - statusCode
            - message
            additionalProperties: false
    BadRequest:
      description: The request could not be understood or was missing required parameters.
      content:
        application/json:
          schema:
            type: object
            properties:
              statusCode:
                type: integer
                description: The HTTP status code indicating a bad request.
                example: 400
              message:
                type: string
                description: A brief message describing the reason for the bad request.
                example: Bad Request
              errorCode:
                type: string
                description: A specific error code for the bad request.
            required:
            - statusCode
            - message
            - errorCode
            additionalProperties: false
    Unauthorized:
      description: Authentication failed or user does not have permissions for the desired action.
      content:
        application/json:
          schema:
            type: object
            properties:
              statusCode:
                type: integer
                description: The HTTP status code indicating an unauthorized request.
                example: 401
              message:
                type: string
                description: A brief message indicating that authentication is required and has failed or has not yet been provided.
                example: Unauthorized
              errorCode:
                type: string
                description: A specific error code for the unauthorized request.
            required:
            - statusCode
            - message
            - errorCode
            additionalProperties: false
  schemas:
    SS_MetaPricingStats:
      type: object
      description: Aggregated WhatsApp pricing message grouped
      properties:
        authenticationBillable:
          type: integer
          description: Total count of billable authentication messages
        authenticationInternationalBillable:
          type: integer
          description: Total count of billable authentication international messages
        marketingBillable:
          type: integer
          description: Total count of billable marketing messages
        marketingLiteBillable:
          type: integer
          description: Total count of billable marketing lite messages
        utilityBillable:
          type: integer
          description: Total count of billable utility messages
        utility:
          type: integer
          description: Total count of free utility messages
        service:
          type: integer
          description: Total count of free service messages
        referral:
          type: integer
          description: Total count of referral messages
        totalMessages:
          type: integer
          description: Total count messages
    SS_ApplicationDashboardStats:
      type: object
      properties:
        sms:
          type: object
          description: Sms service stats
          properties:
            numDevicesSent:
              type: integer
              description: Number of devices sent
        email:
          type: object
          description: Email service stats
          properties:
            numDevicesSent:
              type: integer
              description: Number of devices sent
        inapp:
          type: object
          description: Inapp service stats
          properties:
            numDevicesPrint:
              type: integer
              description: Total prints.
            numDevicesClicked:
              type: integer
              description: Total clicks.
        meta:
          $ref: '#/components/schemas/SS_MetaPricingStats'
    SSReportConfig:
      type: object
      properties:
        applicationId:
          type: integer
          description: The ID of the application to
        cycle:
          type: string
          description: The cycle for which to generate the report.
          enum:
          - daily
          - weekly
          - monthly
          example: daily
        reportName:
          type: string
          description: The name of the report.
          example: My Report
        email:
          type: array
          items:
            type: string
          description: The email addresses to send the report to.
          minItems: 1
          example:
          - email1@email1.com
          - email2@email1.com
        extraData:
          type:
          - object
          - 'null'
          description: Extra data to include in the report.
          properties:
            instanceId:
              type: integer
              description: The instance ID. Only used when the report is for the chat service.
              example: 12345
            lang:
              type: string
              description: The language of the report.
              example: es
            maxTopics:
              type: integer
              description: The maximum number of topics to include in the report.
              example: 10
            appName:
              type: string
              description: The name of the application. This field is used for daily reports.
              example: My App
            attached:
              type: boolean
              description: Whether to attach the report to the email. This field is used for daily reports.
              example: true
            minTopicSize:
              type: integer
              description: The minimum size of a topic to include in the report.
              example: 10
            feedback:
              type: boolean
              description: Whether to include feedback in the report.
              example: true
            categories:
              type: array
              items:
                type: string
              description: The categories to include in the report.
              example:
              - category1
              - category2
            chatv1:
              type: boolean
              description: Whether the report uses the chat v1 format. Used for pathbot reports.
              example: false
            advanced:
              type: boolean
              description: Whether to show extra internal flow info of the pathbot in the report.
              example: false
        createdAt:
          type: string
          format: date-time
          description: The date and time the report configuration was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time the report configuration was last updated.
    SSPostReportConfigRequestBody:
      type: object
      properties:
        cycle:
          type: string
          description: The cycle for which to generate the report.
          enum:
          - daily
          - weekly
          - monthly
          example: daily
        reportName:
          type: string
          description: The name of the report.
          example: My Report
        email:
          type: array
          items:
            type: string
          description: The email addresses to send the report to.
          minItems: 1
          example:
          - email1@email1.com
          - email2@email1.com
        extraData:
          type:
          - object
          - 'null'
          description: Extra data to include in the report.
          properties:
            instanceId:
              type: integer
              description: The instance ID. Only used when the report is for the chat service.
              example: 12345
            lang:
              type: string
              description: The language of the report.
              example: es
            maxTopics:
              type: integer
              description: The maximum number of topics to include in the report.
              example: 10
            appName:
              type: string
              description: The name of the application. This field is used for daily reports.
              example: My App
            attached:
              type: boolean
              description: Whether to attach the report to the email. This field is used for daily reports.
              example: true
            minTopicSize:
              type: integer
              description: The minimum size of a topic to include in the report.
              example: 10
            feedback:
              type: boolean
              description: Whether to include feedback in the report.
              example: true
            categories:
              type: array
              items:
                type: string
              description: The categories to include in the report.
              example:
              - category1
              - category2
            chatv1:
              type: boolean
              description: Whether the report uses the chat v1 format. Used for pathbot reports.
              default: false
              example: false
            advanced:
              type: boolean
              description: Whether to show extra internal flow info of the pathbot in the report.
              default: false
              example: false
      required:
      - cycle
      - reportName
      - email
    SSPutReportConfigRequestBody:
      type: object
      properties:
        cycle:
          type: string
          description: The cycle for which to generate the report.
          enum:
          - daily
          - weekly
          - monthly
          example: daily
        reportName:
          type: string
          description: The name of the report.
          example: My Report
        email:
          type: array
          items:
            type: string
          description: The email addresses to send the report to.
          minItems: 1
          example:
          - email1@email1.com
          - email2@email1.com
        extraData:
          type:
          - object
          - 'null'
          description: Extra data to include in the report.
          properties:
            instanceId:
              type: integer
              description: The instance ID. Only used when the report is for the chat service.
              example: 12345
            lang:
              type: string
              description: The language of the report.
              example: es
            maxTopics:
              type: integer
              description: The maximum number of topics to include in the report.
              example: 10
            appName:
              type: string
              description: The name of the application. This field is used for daily reports.
              example: My App
            attached:
              type: boolean
              description: Whether to attach the report to the email. This field is used for daily reports.
              example: true
            minTopicSize:
              type: integer
              description: The minimum size of a topic to include in the report.
              example: 10
            feedback:
              type: boolean
              description: Whether to include feedback in the report.
              example: true
            categories:
              type: array
              items:
                type: string
              description: The categories to include in the report.
              example:
              - category1
              - category2
            chatv1:
              type: boolean
              description: Whether the report uses the chat v1 format. Used for pathbot reports.
              example: false
            advanced:
              type: boolean
              description: Whether to show extra internal flow info of the pathbot in the report.
              example: false
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: Authorization
      description: 'Authorization for accesing endpoints , must be in one of the following format:

        - **Bearer {token}**

        - **ServerKey {key}**

        '
    MultimediaJWT:
      type: apiKey
      in: query
      name: jwt
      description: JWT token for signed URL multimedia authentication (query param)
x-tagGroups:
- name: Chat Service
  tags:
  - chat-configuration
  - chat-channel
  - chat-contact
  - chat-integration
  - chat-task
  - chat-campaign
  - chat-send
  - chat-multimedia
  - chat-slicing
  - chat-tag
  - chat-contact-list
  - chat-cc-agent
  - chat-cc-permissions-profile
  - chat-cc-weekly-schedule
  - chat-cc-special-days-schedule
  - chat-cc-conversation
  - chat-cc-agent-group
  - chat-cc-contact-comment
  - chat-cc-form
  - chat-stats
  - chat-internal
- name: Customer Service
  tags:
  - customer-service-adviser
  - customer-service-customer
  - customer-service-customer-csv
  - customer-service-customer-field
  - customer-service-customer-journey
  - customer-service-customer-journey-template
  - customer-service-customer-journey-control
  - customer-service-customer-send
  - customer-service-stats
  - customer-service-webhook-template
  - customer-service-segment
  - customer-service-audience
  - customer-service-application
  - customer-service-journeywaitqueue
  - customer-service-task
  - customer-service-cdpeventtype
  - customer-service-cdpeventtypetemplate
  - customer-service-internal
- name: Email Service
  tags:
  - es-configuration
  - es-configurationDomain
  - es-configurationDomainEmail
  - es-footer
  - es-audience
  - es-contact
  - es-category
  - es-campaign
  - es-campaign-block
  - es-campaign block-column
  - es-campaign-multimedia
  - es-shipment
  - es-attachment
  - es-statistics
  - es-webhook
  - es-tasks
- name: InApp Service
  tags:


# --- truncated at 32 KB (70 KB total) ---
# Full source: https://artifacts.apis.io/indigitall/openapi/indigitall-stats-service-report-api-openapi.yml