Aeris Organization Signaling Reports API

openapi: 3.2.0
info:
  title: Organization Signaling Aggregations Organization Signaling…
  version: 1.0.0
  description: '#### Copyright

    © Aeris Communications, Inc.'
  x-audience: external-partner
  x-api-id: 81d83137-7e50-4396-9083-789378c7c534
servers:
- url: https://iot-api.aeris.com/iot/api/diagnostic-analytics
  description: API server
tags:
- name: Organization Signaling Reports
  description: Organization Signaling Aggregations APIs.
paths:
  /signaling-aggregations/traffic-usages/{dimension}:
    get:
      tags:
      - Organization Signaling Reports
      summary: Get organization traffic data statistics aggregated on dimension
      description: 'This service returns various aggregated traffic data. With this operation,

        it is possible to retrieve traffic aggregated on

        Total, APN, SMSCAccount, CountryCode, Operator, or Opco per current day.

        The traffic can be filtered to a specific customer.'
      operationId: QueryTrafficUsages
      parameters:
      - $ref: '#/components/parameters/Header-Accept'
      - $ref: '#/components/parameters/Header-Accept-Version'
      - $ref: '#/components/parameters/OrganizationIdParameter'
      - $ref: '#/components/parameters/DimensionParameter'
      responses:
        default:
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '200':
          $ref: '#/components/responses/200'
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      security:
      - OAuth2:
        - cnx_aggregated_traffic
components:
  responses:
    '401':
      description: Unauthorized
      headers:
        X-RateLimit-Limit-Second:
          $ref: '#/components/headers/X-RateLimit-Limit-Second'
        X-RateLimit-Limit-Minute:
          $ref: '#/components/headers/X-RateLimit-Limit-Minute'
        X-RateLimit-Remaining-Second:
          $ref: '#/components/headers/X-RateLimit-Remaining-Second'
        X-RateLimit-Remaining-Minute:
          $ref: '#/components/headers/X-RateLimit-Remaining-Minute'
        Content-Type:
          $ref: '#/components/headers/Content-Type'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: about:blank
            title: Unauthorized
            status: 401
            detail: Token expired.
            instance: N/A
    '429':
      description: Too Many Requests
      headers:
        X-RateLimit-Limit-Second:
          $ref: '#/components/headers/X-RateLimit-Limit-Second'
        X-RateLimit-Limit-Minute:
          $ref: '#/components/headers/X-RateLimit-Limit-Minute'
        X-RateLimit-Remaining-Second:
          $ref: '#/components/headers/X-RateLimit-Remaining-Second'
        X-RateLimit-Remaining-Minute:
          $ref: '#/components/headers/X-RateLimit-Remaining-Minute'
        Content-Type:
          $ref: '#/components/headers/Content-Type'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: about:blank
            title: Too Many Requests
            status: 429
            detail: Limit of requests fully used. Please try later.
            instance: N/A
    '403':
      description: Forbidden
      headers:
        X-RateLimit-Limit-Second:
          $ref: '#/components/headers/X-RateLimit-Limit-Second'
        X-RateLimit-Limit-Minute:
          $ref: '#/components/headers/X-RateLimit-Limit-Minute'
        X-RateLimit-Remaining-Second:
          $ref: '#/components/headers/X-RateLimit-Remaining-Second'
        X-RateLimit-Remaining-Minute:
          $ref: '#/components/headers/X-RateLimit-Remaining-Minute'
        Content-Type:
          $ref: '#/components/headers/Content-Type'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: about:blank
            title: Forbidden
            status: 403
            detail: Action forbidden.
            instance: N/A
    '405':
      description: Method Not Allowed
      headers:
        X-RateLimit-Limit-Second:
          $ref: '#/components/headers/X-RateLimit-Limit-Second'
        X-RateLimit-Limit-Minute:
          $ref: '#/components/headers/X-RateLimit-Limit-Minute'
        X-RateLimit-Remaining-Second:
          $ref: '#/components/headers/X-RateLimit-Remaining-Second'
        X-RateLimit-Remaining-Minute:
          $ref: '#/components/headers/X-RateLimit-Remaining-Minute'
        Content-Type:
          $ref: '#/components/headers/Content-Type'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: about:blank
            title: Method Not Allowed
            status: 405
            detail: Method not allowed.
            instance: N/A
    '400':
      description: Bad Request
      headers:
        X-RateLimit-Limit-Second:
          $ref: '#/components/headers/X-RateLimit-Limit-Second'
        X-RateLimit-Limit-Minute:
          $ref: '#/components/headers/X-RateLimit-Limit-Minute'
        X-RateLimit-Remaining-Second:
          $ref: '#/components/headers/X-RateLimit-Remaining-Second'
        X-RateLimit-Remaining-Minute:
          $ref: '#/components/headers/X-RateLimit-Remaining-Minute'
        Content-Type:
          $ref: '#/components/headers/Content-Type'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://your.api.documentation.url
            title: Bad Request
            status: 400
            detail: The dimension parameter is unknown.
            instance: N/A
    '404':
      description: Not Found
      headers:
        X-RateLimit-Limit-Second:
          $ref: '#/components/headers/X-RateLimit-Limit-Second'
        X-RateLimit-Limit-Minute:
          $ref: '#/components/headers/X-RateLimit-Limit-Minute'
        X-RateLimit-Remaining-Second:
          $ref: '#/components/headers/X-RateLimit-Remaining-Second'
        X-RateLimit-Remaining-Minute:
          $ref: '#/components/headers/X-RateLimit-Remaining-Minute'
        Content-Type:
          $ref: '#/components/headers/Content-Type'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: about:blank
            title: Not Found
            status: 404
            detail: Resource not found.
            instance: N/A
    '500':
      description: Internal Server Error
      headers:
        X-RateLimit-Limit-Second:
          $ref: '#/components/headers/X-RateLimit-Limit-Second'
        X-RateLimit-Limit-Minute:
          $ref: '#/components/headers/X-RateLimit-Limit-Minute'
        X-RateLimit-Remaining-Second:
          $ref: '#/components/headers/X-RateLimit-Remaining-Second'
        X-RateLimit-Remaining-Minute:
          $ref: '#/components/headers/X-RateLimit-Remaining-Minute'
        Content-Type:
          $ref: '#/components/headers/Content-Type'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    '204':
      description: No Content
    '200':
      description: OK
      headers:
        X-RateLimit-Limit-Second:
          $ref: '#/components/headers/X-RateLimit-Limit-Second'
        X-RateLimit-Limit-Minute:
          $ref: '#/components/headers/X-RateLimit-Limit-Minute'
        X-RateLimit-Remaining-Second:
          $ref: '#/components/headers/X-RateLimit-Remaining-Second'
        X-RateLimit-Remaining-Minute:
          $ref: '#/components/headers/X-RateLimit-Remaining-Minute'
        Content-Type:
          $ref: '#/components/headers/Content-Type'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TrafficUsagesResponse'
  parameters:
    Header-Accept:
      name: Accept
      in: header
      description: Accept content-type and schemas by the client
      schema:
        type: string
        example: application/json
        default: application/json
    Header-Accept-Version:
      name: Accept-Version
      in: header
      description: Accept version of the response
      schema:
        type: string
        example: 0.0.1
        default: 0.0.1
    DimensionParameter:
      name: dimension
      in: path
      required: true
      description: "A parameter that tells how to aggregate the data. Valid values are as follows:\n  - APN\n  - SMSC_ACCOUNT\n  - COUNTRY_CODE\n  - OPCO\n  - OPERATOR\n  - TOTAL\n\nReal time usage query response elements:\n  | Value in the Request | Description |\n  |-------------|------------|\n  | APN         | Only 'activePDPContexts' and 'data' contain related data. |\n  | SMSC_ACCOUNT | Only smsMobileOriginated, smsMobileTerminated, smsApplicationOriginated, and smsAApplicationTerminated contain related data. |\n  | COUNTRY_CODE | All elements contain related data. |\n  | OPCO        | Aggregation on customer number. All elements contain related data. |\n  | OPERATOR    | All elements contain related data. |\n  | TOTAL       | All elements contain related data. |\n"
      schema:
        $ref: '#/components/schemas/DimensionEnum'
    OrganizationIdParameter:
      name: organizationId
      in: query
      description: "ID of the organization for which the aggregation should be done. It could be a fix number e.g. '1.2.3' or it can contain ‘*’ as a wildcard in the following way:\n  - '1.2.*' will filter all organization whose id starts with 1.2 but not the parent 1.2 itself\n  - '1.2*' will filter all organizations whose id starts with 1.2 and include the parent 1.2 itself'\n"
      schema:
        type: string
      example: 22.2.2.22
  schemas:
    Aggregation:
      allOf:
      - $ref: '#/components/schemas/Common'
      - properties:
          data:
            $ref: '#/components/schemas/Data'
          sms:
            type: array
            items:
              $ref: '#/components/schemas/Sms'
    Error:
      type: object
      properties:
        errorCount:
          type: integer
          format: int64
          description: 'Optional. Number of errors. Eight-byte integer, its maximum value is 2^63-1.

            '
          example: 10
          default: 0
        lastErrorOccurredAt:
          type: string
          format: date-time
          description: Optional. The date and time of last error.
          example: '2001-12-31T00:00:00.000Z'
    TrafficUsagesResponse:
      description: Response containing aggregated traffic statistics
      type: object
      properties:
        usageAggregations:
          type: array
          description: 'Aggregated items based on the dimension parameter.

            '
          items:
            $ref: '#/components/schemas/Aggregation'
    Data:
      allOf:
      - $ref: '#/components/schemas/Error'
      - properties:
          uploaded:
            type: integer
            format: int64
            description: 'Optional. Uploaded data (in Bytes). Eight-byte integer, its maximum value is 2^63-1.

              '
            example: 1055
            default: 0
          lastUploadedAt:
            type: string
            format: date-time
            description: Optional. The timestamp of the last uploaded data.
            example: '2001-12-31T00:00:00.000Z'
          downloaded:
            type: integer
            format: int64
            description: 'Optional. Downloaded data (in Bytes). Eight-byte integer, its maximum value is 2^63-1.

              '
            example: 1055
            default: 0
          lastDownloadedAt:
            type: string
            format: date-time
            description: Optional. The timestamp of the last downloaded data.
            example: '2001-12-31T00:00:00.000Z'
    Common:
      type: object
      properties:
        dimensionValue:
          type: string
          description: 'The value of the aggregated dimension.

            '
          example: FI
        numberOfLocationUpdates:
          type: integer
          format: int64
          description: 'Optional. Number of location updates.

            Eight-byte integer, its maximum value is 2^63-1.

            '
          default: 0
          example: 1000
        activePDPContexts:
          type: integer
          format: int64
          description: 'Optional. Number of active PDP Contexts.

            Eight-byte integer, its maximum value is 2^63-1.

            '
          default: 0
          example: 100
    Problem:
      type: object
      properties:
        type:
          type: string
          description: 'An absolute URI that identifies the problem type. When dereferenced,

            it SHOULD provide human-readable documentation for the problem type

            (e.g., using HTML).

            '
          format: uri
          example: https://your.api.documentation.url
          default: about:blank
        title:
          type: string
          description: 'A short, summary of the problem type. Written in english and readable

            for engineers (usually not suited for non technical stakeholders and

            not localized).

            '
          example: Internal Server Error
        status:
          minimum: 100
          type: integer
          description: 'The HTTP status code generated by the origin server for this occurrence

            of the problem.

            '
          format: int32
          example: 500
          exclusiveMaximum: 600
        detail:
          type: string
          description: 'A human readable explanation specific to this occurrence of the

            problem.

            '
          example: The server has encountered a situation that it does not know how to handle.
        instance:
          type: string
          description: 'An absolute URI that identifies the specific occurrence of the problem.

            It may or may not yield further information if dereferenced.

            '
    DimensionEnum:
      type: string
      description: "A parameter that tells how to aggregate the data. Valid values are as follows:\n  - APN\n  - SMSC_ACCOUNT\n  - COUNTRY_CODE\n  - OPCO\n  - OPERATOR\n  - TOTAL\n"
      enum:
      - APN
      - SMSC_ACCOUNT
      - COUNTRY_CODE
      - OPCO
      - OPERATOR
      - TOTAL
      example: COUNTRY_CODE
      default: TOTAL
    Sms:
      allOf:
      - $ref: '#/components/schemas/Error'
      - properties:
          type:
            type: string
            description: Type of SMS traffic.
            enum:
            - MobileOriginated
            - MobileTerminated
            - ApplicationOriginated
            - ApplicationTerminated
          successCount:
            type: integer
            format: int64
            description: 'Optional. Total number of messages.

              Eight-byte integer, its maximum value is 2^63 - 1.

              '
            example: 100
            default: 0
          lastOccurredAt:
            type: string
            format: date-time
            description: Optional. The date and time of the last message.
            example: '2001-12-31T00:00:00.000Z'
  headers:
    X-RateLimit-Remaining-Minute:
      description: The number of requests remaining in a minute.
      schema:
        type: integer
        format: int32
    X-RateLimit-Remaining-Second:
      description: The number of requests remaining in a second.
      schema:
        type: integer
        format: int32
    Content-Type:
      description: Handle Content-Type
      schema:
        type: string
    X-RateLimit-Limit-Minute:
      description: The maximum number of requests allowed in a minute.
      schema:
        type: integer
        format: int32
    X-RateLimit-Limit-Second:
      description: The maximum number of requests allowed in a second.
      schema:
        type: integer
        format: int32
  securitySchemes:
    OAuth2:
      type: oauth2
      description: The API uses OAuth2 and OIDC for authentication and authorization.
      flows:
        password:
          tokenUrl: /iot/api/auth/token
          scopes:
            cnx_aggregated_traffic: Access right to perform query operation.