indigitall Sms Stats API

openapi: 3.2.0
info:
  version: 2.0.0
  title: INDIGITALL Sms Stats 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: sms-stats
  x-displayName: SMS - Stats
paths:
  /sms/application/stats:
    get:
      tags:
      - sms-stats
      summary: Statistics by application of account
      description: Get statistics by application. If the applicationId is not sent, it will look for all those belonging to the account.
      operationId: smsStatsByApplication
      x-gateway-controller: statsController
      x-gateway-endpoint: smsStatsByApplication
      x-gateway-mode: custom
      x-gateway-check-permission:
        account-features:
        - SMS_ENABLED
      parameters:
      - name: accountId
        in: query
        description: accountId, if not informed search by account of user
        required: false
        schema:
          type: integer
      - name: applicationId
        in: query
        description: application id, if not informed, search by all appIds of account
        required: false
        schema:
          type: integer
      - in: query
        name: limit
        required: true
        description: results per page
        schema:
          type: integer
          minimum: 0
          maximum: 100
      - in: query
        name: page
        required: true
        description: filter by name
        schema:
          type: integer
          minimum: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMS_response_stats_application'
        '403':
          $ref: '#/components/responses/ES_ForbiddenErrorResponse'
        '404':
          description: Application not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ES_ErrorSchema'
              example:
                statusCode: 404
                errorCode: ES_APPLICATION_NOT_FOUND
                message: Application not found
        '500':
          $ref: '#/components/responses/ES_ServerErrorResponse'
  /sms/stats/application:
    get:
      tags:
      - sms-stats
      summary: Stats by application
      description: Get global stats by application and day between two dates.
      x-eov-operation-handler: statsController
      operationId: smsGetByApplication
      x-gateway-endpoint: smsService
      x-gateway-check-permission:
        account-features:
        - SMS_ENABLED
      parameters:
      - in: query
        name: applicationId
        schema:
          type: integer
        required: true
        description: Application ID to look for
      - in: query
        name: dateFrom
        description: Get records from this date. Format is ISO 8601(YYYY-MM-DD)
        schema:
          type: string
          format: date
        required: true
      - in: query
        name: dateTo
        description: Get records until this date. Format is ISO 8601(YYYY-MM-DD)
        schema:
          type: string
          format: date
        required: true
      - in: query
        name: periodicity
        required: true
        description: 'Allows to choose statistics by day or hours

          '
        schema:
          type: string
          default: daily
          enum:
          - hourly
          - daily
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GET_APP_STATS_RESPONSE'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BASE_ERROR_RESPONSE'
  /sms/stats/application/cost:
    get:
      tags:
      - sms-stats
      summary: Get cost stats by application
      description: Get the current month's cost and credit limit for a given application.
      x-eov-operation-handler: statsController
      operationId: getApplicationCostStats
      x-gateway-endpoint: smsService
      x-gateway-check-permission:
        account-features:
        - SMS_ENABLED
      parameters:
      - in: query
        name: applicationId
        schema:
          type: integer
        required: true
        description: Application ID to retrieve cost stats for
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GET_APP_COST_STATS_RESPONSE'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BASE_ERROR_RESPONSE'
  /sms/stats/application/dateStats/csv:
    get:
      tags:
      - sms-stats
      summary: Show the statistics for the given application id between two dates in a .csv…
      description: 'List of statistics for the selected application, filtered between the dates given. The

        difference in days of the selected dates can not be greater than 90'
      x-eov-operation-handler: statsController
      operationId: smsGetApplicationStatisticsCSV
      x-gateway-endpoint: smsService
      x-gateway-check-permission:
        account-features:
        - SMS_ENABLED
        - SMS_DOWNLOAD_STATISTICS
      parameters:
      - name: applicationId
        in: query
        description: application id
        required: true
        schema:
          type: integer
          format: int64
      - name: dateFrom
        in: query
        description: 'Retrieve statistics for messages sent / opened / clicked after the specified timestamp. Format: YYYY-MM-DD. The maximum period of time that can be selected between dateFrom and dateTo is equal to 99 days.'
        required: true
        schema:
          type: string
          format: date
      - name: dateTo
        in: query
        description: 'Retrieve statistics for messages sent / opened / clicked before the specified timestamp. Format: YYYY-MM-DD. The maximum period of time that can be selected between dateFrom and dateTo is equal to 99 days.'
        required: true
        schema:
          type: string
          format: date
      responses:
        '200':
          description: Success
          content:
            text/csv:
              schema: {}
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BASE_ERROR_RESPONSE'
  /sms/stats/campaign:
    get:
      tags:
      - sms-stats
      summary: Stats by campaign
      description: Get stats by campaigns sendings between two dates. Transactional sendings are grouped by day
      x-eov-operation-handler: statsController
      operationId: smsGetByCampaign
      x-gateway-endpoint: smsService
      x-gateway-check-permission:
        account-features:
        - SMS_ENABLED
      parameters:
      - in: query
        name: applicationId
        schema:
          type: integer
          format: int64
        required: true
        description: Application ID to look for
      - in: query
        name: dateFrom
        description: Get records from this date. Format is ISO 8601(YYYY-MM-DD)
        schema:
          type: string
          format: date
        required: true
      - in: query
        name: dateTo
        description: Get records until this date. Format is ISO 8601(YYYY-MM-DD)
        schema:
          type: string
          format: date
        required: true
      - in: query
        name: page
        description: Results page
        schema:
          type: integer
          default: 0
      - in: query
        name: limit
        schema:
          type: integer
          default: 10
        description: Limit of results per page
      - in: query
        name: isCustomerService
        description: filter "journey" type campaigns
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GET_CAMPAIGN_STATS_RESPONSE'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BASE_ERROR_RESPONSE'
  /sms/stats/campaign/csv:
    get:
      tags:
      - sms-stats
      summary: Show the statistics for all the campaigns in CSV format
      description: Get stats by campaigns sendings between two dates. Transactional sendings are grouped by day
      x-eov-operation-handler: statsController
      operationId: smsGetCampaignStatisticsCSV
      x-gateway-endpoint: smsService
      x-gateway-check-permission:
        account-features:
        - SMS_ENABLED
        - SMS_DOWNLOAD_STATISTICS
      parameters:
      - name: applicationId
        in: query
        description: application id
        required: true
        schema:
          type: integer
          format: int64
      - name: dateFrom
        in: query
        description: 'Retrieve statistics for messages sent / opened / clicked after the specified timestamp. Format: YYYY-MM-DD. The maximum period of time that can be selected between dateFrom and dateTo is equal to 99 days.'
        required: true
        schema:
          type: string
          format: date
      - name: dateTo
        in: query
        description: 'Retrieve statistics for messages sent / opened / clicked before the specified timestamp. Format: YYYY-MM-DD. The maximum period of time that can be selected between dateFrom and dateTo is equal to 99 days.'
        required: true
        schema:
          type: string
          format: date
      responses:
        '200':
          description: Success
          content:
            text/csv:
              schema: {}
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BASE_ERROR_RESPONSE'
  /sms/stats/campaign/{id}:
    get:
      tags:
      - sms-stats
      summary: Stats by campaign
      description: Get stats by campaigns sendings between two dates. Transactional sendings are grouped by day
      x-eov-operation-handler: statsController
      operationId: getCampaignStatisticsById
      x-gateway-endpoint: smsService
      x-gateway-check-permission:
        account-features:
        - SMS_ENABLED
      parameters:
      - name: id
        in: path
        description: campaign id
        required: true
        schema:
          type: integer
          format: int64
      - name: applicationId
        in: query
        description: application id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GET_CAMPAIGN_STATS_RESPONSE'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BASE_ERROR_RESPONSE'
  /sms/stats/costs:
    get:
      summary: Cost statistics by application
      description: Sendings costs grouped by hours within a date range for an application's sendings
      x-eov-operation-handler: statsController
      operationId: smsCostStats
      x-gateway-endpoint: smsService
      x-gateway-check-permission:
        account-features:
        - SMS_ENABLED
      tags:
      - sms-stats
      parameters:
      - in: query
        name: applicationId
        schema:
          type: integer
        required: true
        description: Application ID to look for
      - in: query
        name: limit
        schema:
          type: integer
          default: 10
        description: Limit of results per page
      - in: query
        name: page
        schema:
          type: integer
          default: 0
        description: Page number
      - in: query
        name: dateFrom
        description: Get records from this date. Format is ISO 8601(YYYY-MM-DDThh:mm:ssZ for UTC )
        required: true
        schema:
          type: string
          format: date-time
      - in: query
        name: dateTo
        description: Get records until this date. Format is ISO 8601(YYYY-MM-DDThh:mm:ssZ for UTC )
        required: true
        schema:
          type: string
          format: date-time
      - in: query
        name: orderBy
        required: false
        description: "Order of the results:\n\n  * date-ascending - Order by date ascending.\n  * date-descending - Order by date descending.\n"
        schema:
          type: string
          enum:
          - date-ascending
          - date-descending
          default: date-ascending
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GET_COST_STATS_RESPONSE'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BASE_ERROR_RESPONSE'
  /sms/stats/device/count:
    get:
      tags:
      - sms-stats
      summary: Devices sent count
      description: Returns the total number of devices to which a campaign has been sent between a range of dates.
      x-eov-operation-handler: statsController
      x-gateway-endpoint: smsService
      x-gateway-check-permission:
        account-features:
        - SMS_ENABLED
      operationId: getCountSentDevicesStats
      parameters:
      - in: query
        name: applicationId
        schema:
          type: integer
          format: int64
        required: true
        description: Application ID to look for
      - in: query
        name: dateFrom
        description: Get records from this date. Format is ISO 8601(YYYY-MM-DD)
        schema:
          type: string
          format: date
        required: true
      - in: query
        name: dateTo
        description: Get records until this date. Format is ISO 8601(YYYY-MM-DD)
        schema:
          type: string
          format: date
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMS_GetCountCampaignsSentResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BASE_ERROR_RESPONSE'
  /sms/stats/device/csv:
    get:
      tags:
      - sms-stats
      summary: Show the statistics for device for the given application's id between two dates…
      description: List of statistics for the selected application, all devices, filtered between the dates given. The difference in days of the selected dates can not be greater than 5
      x-eov-operation-handler: statsController
      operationId: smsGetDeviceStatsCSV
      x-gateway-endpoint: smsService
      x-gateway-check-permission:
        account-features:
        - SMS_ENABLED
        - SMS_DOWNLOAD_STATISTICS
      parameters:
      - name: applicationId
        in: query
        description: application id
        required: true
        schema:
          type: integer
          format: int64
      - name: dateFrom
        in: query
        description: 'Retrieve statistics for messages sent / opened / clicked after the specified timestamp. Format: YYYY-MM-DD. The maximum period of time that can be selected between dateFrom and dateTo is equal to 99 days.'
        required: true
        schema:
          type: string
          format: date
      - name: dateTo
        in: query
        description: 'Retrieve statistics for messages sent / opened / clicked before the specified timestamp. Format: YYYY-MM-DD. The maximum period of time that can be selected between dateFrom and dateTo is equal to 99 days.'
        required: true
        schema:
          type: string
          format: date
      responses:
        '200':
          description: Success
          content:
            text/csv:
              schema: {}
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BASE_ERROR_RESPONSE'
components:
  schemas:
    SMS_response_stats_application:
      type: object
      properties:
        message:
          type: string
          description: A message indicating the status of the response.
        statusCode:
          type: integer
          description: The status code of the response.
        count:
          type: integer
          description: The number of data items in the "data" array.
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                description: The ID of the application.
              name:
                type: string
                description: The name of the application.
              contacts:
                type: object
                properties:
                  count:
                    type: integer
                    description: The count of contacts related to the application.
              sendings:
                type: object
                properties:
                  inmediate:
                    type: integer
                    description: The count of immediate sendings.
                  scheduled:
                    type: integer
                    description: The count of scheduled sendings.
                  smartTime:
                    type: integer
                    description: The count of smartTime sendings.
              impacts:
                type: object
                properties:
                  totalImpacts:
                    type: integer
                    description: The total impact count.
                  todayImpacts:
                    type: integer
                    description: The impact count for today.
                  lastWeekImpacts:
                    type: integer
                    description: The impact count for the last week.
                  lastMonthImpacts:
                    type: integer
                    description: The impact count for the last month.
                  totalClicks:
                    type: integer
                    description: The total clicks count.
                  todayClicks:
                    type: integer
                    description: The impact clicks for today.
                  lastWeekClicks:
                    type: integer
                    description: The impact clicks for the last week.
                  lastMonthClicks:
                    type: integer
                    description: The impact clicks for the last month.
      example:
        message: OK
        statusCode: 200
        count: 1
        data:
        - id: 1
          name: Test example
          contacts:
            count: 0
          campaigns:
            total: 0
            enabled: 0
          sendings:
            inmediate: 0
            scheduled: 0
            smartTime: 0
          impacts:
            totalImpacts: 0
            todayImpacts: 0
            lastWeekImpacts: 0
            lastMonthImpacts: 0
            totalClicks: 0
            todayClicks: 0
            lastWeekClicks: 0
            lastMonthClicks: 0
    GET_CAMPAIGN_STATS_RESPONSE:
      type: object
      required:
      - statusCode
      - message
      - data
      properties:
        statusCode:
          type: integer
          description: HTTP status code
        message:
          type: string
          description: Message about response
        data:
          type: array
          items:
            $ref: '#/components/schemas/GET_CAMPAIGN_STATS_OBJECT'
    BASE_ERROR_RESPONSE:
      type: object
      required:
      - statusCode
      - message
      properties:
        statusCode:
          type: integer
          description: HTTP error code
        message:
          type: string
          description: Message about error
    GET_APP_COST_STATS_OBJECT:
      type: object
      required:
      - actualMonthCost
      - creditLimit
      - currency
      properties:
        actualMonthCost:
          type: number
          description: Cost accumulated for the current month
        creditLimit:
          type:
          - number
          - 'null'
          description: Credit limit for the application
        currency:
          type:
          - string
          - 'null'
          description: Currency for the application
    GET_COST_STATS_RESPONSE:
      type: object
      required:
      - statusCode
      - message
      properties:
        statusCode:
          type: integer
          description: HTTP status code
        message:
          type: string
          description: Message about response
        data:
          type: array
          items:
            $ref: '#/components/schemas/GET_COST_STATS_OBJECT'
        count:
          type: integer
          description: Total ammount of records
    SMS_GetCountCampaignsSentResponse:
      type: object
      required:
      - statusCode
      - message
      - count
      properties:
        statusCode:
          type: integer
          description: HTTP status code
        message:
          type: string
          description: Message about response
        data:
          type: object
          properties:
            numDevicesSent:
              type: integer
              description: Total contacts
    ES_ErrorSchema:
      required:
      - message
      - statusCode
      type: object
      properties:
        statusCode:
          type: integer
          description: Response code
        errorCode:
          type: string
          enum:
          - ES_ATTACHMENT_NOT_FOUND
          - ES_SHIPMENT_SCHEDULED
          - ES_SHIPMENT_HAVE_VARS
          - ES_CAMPAIGN_NOT_FOUND
          - ES_CAMPAIGN_NOT_MODIFIABLE
          - ES_CAMPAIGN_TEMPLATE_NOT_FOUND
          - ES_CAMPAIGN_SENT
          - ES_CAMPAIGN_MULTIMEDIA_NOT_FOUND
          - ES_CAMPAIGN_HTML_NOT_FOUND
          - ES_CAMPAIGN_BLOCK_NOT_FOUND
          - ES_CAMPAIGN_BLOCK_COLUMN_NOT_FOUND
          - ES_CAMPAIGN_BLOCK_COLUMN_TYPE_ERROR
          - ES_COLUMNS_IN_BLOCK_LIMIT
          - ES_CONFIGURATION_ALREADY_EXISTS
          - ES_CONFIGURATION_NOT_FOUND
          - ES_CONFIGURATION_ERROR_MAILJET
          - ES_CONFIGURATION_DOMAIN_NOT_FOUND
          - ES_CONFIGURATION_DOMAIN_IN_USE
          - ES_CONFIGURATION_DOMAIN_EMAIL_NOT_FOUND
          - ES_CONFIGURATION_DOMAIN_EMAIL_IN_USE
          - ES_CONTACT_NOT_FOUND
          - ES_CATEGORY_NOT_FOUND
          - ES_CATEGORY_IN_USE
          - ES_APPLICATION_NOT_FOUND
          - ES_FOOTER_NOT_FOUND
          - ES_FOOTER_TITLE_EXISTS
          - ES_FOOTER_IN_USE
          - ES_SHIPMENT_NOT_FOUND
          - ES_CONFLICT
          - ES_ACCESS_FORBIDDEN
          - ES_AUDIENCE_CJ_NOT_FOUND
          description: '* `ES_ATTACHMENT_NOT_FOUND` - Attachment not found

            * `ES_SHIPMENT_SCHEDULED` - Shipment has been scheduled

            * `ES_SHIPMENT_HAVE_VARS` - Sending variables is not allowed in massive mailing.

            * `ES_CAMPAIGN_NOT_FOUND` - Campaign not found

            * `ES_CAMPAIGN_NOT_MODIFIABLE` - Campaign cannot be updated as it belongs to an initialized journey

            * `ES_CAMPAIGN_TEMPLATE_NOT_FOUND` - Campaign template not found

            * `ES_CAMPAIGN_SENT` - Campaign has been send

            * `ES_CAMPAIGN_MULTIMEDIA_NOT_FOUND` - Campaign multimedia not found

            * `ES_CAMPAIGN_HTML_NOT_FOUND` - Campaign html not found

            * `ES_CAMPAIGN_BLOCK_NOT_FOUND` - Campaign block not found

            * `ES_CAMPAIGN_BLOCK_COLUMN_NOT_FOUND` - Campaign block column not found * `ES_CAMPAIGN_BLOCK_COLUMN_TYPE_ERROR` - The parameters of the block column are not correct for this type * `ES_COLUMNS_IN_BLOCK_LIMIT` - The column limit for this block has been exceeded

            * `ES_CONFIGURATION_ALREADY_EXISTS` - Configuration already exists for application * `ES_CONFIGURATION_NOT_FOUND` - Configuration not found * `ES_CONFIGURATION_ERROR_MAILJET` - Error Mailjet Api

            * `ES_CONFIGURATION_DOMAIN_NOT_FOUND` - Configuration domain not found

            * `ES_CONFIGURATION_DOMAIN_IN_USE` - Configuration domain in use

            * `ES_CONFIGURATION_DOMAIN_EMAIL_NOT_FOUND` - Configuration domain email not found

            * `ES_CONFIGURATION_DOMAIN_EMAIL_IN_USE` - Configuration domain email in use

            * `ES_CONTACT_NOT_FOUND` - Contact not found

            * `ES_CATEGORY_NOT_FOUND` - Category not found

            * `ES_CATEGORY_IN_USE` - Category in use

            * `ES_APPLICATION_NOT_FOUND` - Application not found

            * `ES_FOOTER_NOT_FOUND` - Footer not found

            * `ES_FOOTER_IN_USE` - Footer in use

            * `ES_FOOTER_TITLE_EXISTS` - Footer title exists

            * `ES_SHIPMENT_NOT_FOUND` - Shipment not found

            * `ES_CONFLICT` - Unique contraint error

            * `ES_ACCESS_FORBIDDEN` - Access forbidden for user

            * `ES_AUDIENCE_CJ_NOT_FOUND` - The referenced Customer Journey (CJ) audience/segment was not found

            '
        message:
          type: string
          description: Error message
    GET_COST_STATS_OBJECT:
      type: object
      properties:
        date:
          type: string
          description: Day
        messages:
          type: integer
          description: Number of sent messages
        cost:
          type: number
          description: Total cost of messages sent
    GET_APP_STATS_OBJECT:
      additionalProperties: false
      type: object
      properties:
        statsDate:
          type: string
          description: Day
        totalChunks:
          type: integer
          description: Number of sent messages
        numContactsSent:
          type: integer
          description: Number of sent messages
        numContactsClicked:
          type: integer
          description: Number of clicked shortened-urls at messages
        cost:
          type: number
          description: Total cost of all messages sent
    GET_APP_STATS_RESPONSE:
      type: object
      required:
      - statusCode
      - message
      - data
      properties:
        statusCode:
          type: integer
          description: HTTP status code
        message:
          type: string
          description: Message about response
        data:
          type: array
          items:
            $ref: '#/components/schemas/GET_APP_STATS_OBJECT'
    GET_CAMPAIGN_STATS_OBJECT:
      additionalProperties: false
      type: object
      properties:
        campaignId:
          type: integer
          description: campaign's  ID
        sendingId:
          type:
          - integer
          - 'null'
          description: Sending's ID
        name:
          type:
          - string
          - 'null'
          description: Campaign name
        senderName:
          type:
          - string
          - 'null'
          description: Sender name
        statsDate:
          type: string
          description: Full date of sending if it was massive, day of sending if it was transactional
        totalChunks:
          type: integer
          description: Number of chunks sent
        cost:
          type: number
          description: Send cost
        numContactsClicked:
          type: integer
          description: Number of clicked shortened-urls at messages
        numContactsSent:
          type: integer
          description: Number of sent destinations
        isCustomerService:
          type: boolean
          description: If sending is from customer journey trigger
    GET_APP_COST_STATS_RESPONSE:
      type: object
      required:
      - statusCode
      - message
      - data
      properties:
        statusCode:
          type: integer
          description: HTTP status code
        message:
          type: string
          description: Message about response
        data:
          $ref: '#/components/schemas/GET_APP_COST_STATS_OBJECT'
  responses:
    ES_ServerErrorResponse:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ES_ErrorSchema'
          example:
            statusCode: 500
            errorCode: ES_SERVER_ERROR
            message: Server error
    ES_ForbiddenErrorResponse:
      description: Access Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ES_ErrorSchema'
          example:
            statusCode: 403
            errorCode: ES_ACCESS_FORBIDDEN
            message: Access Forbidden
  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:
  - inapp-configuration
  - inapp-campaign
  - inapp-schema
  - inapp-topic
  - inapp-multimedia
  - inapp-form
  - inapp-stats
  - inapp-audience
  - inapp-task
- name: SMS Service
  tags:
  - sms-campaign
  - sms-configuration
  - sms-contact
  - sms-send
  - sms-stats
  - sms-topic
  - sms-cost
  - sms-webhook
  - sms-private
- name: Wallet Service
  tags:
  - wallet-project
  - wallet-images
  - wallet-tasks
  - wallet-notifications
  - wallet-template
  - wallet-loyalty-pass
  - wallet-loyalty-template
  - wallet-offer-pass
  - wallet-offer-template
  - wallet-generic-pass
  - wallet-generic-template
- name: Stats Service
  tags:
  - stats-service-chat
  - stats-service-cs
  - stats-service-report
  - stats-service-wallet
  - stats-service-meta
- name: ChatGen service
  tags:


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