Stellar Statistics API

openapi: 3.2.0
info:
  title: Stellar Disbursement Platform Statistics API
  version: 2.1.0
  summary: The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network.
  description: 'The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network.


    This is an open-source project that is built on top of the Stellar network, and the code can be found on the following repositories:


    - [stellar/stellar-disbursement-platform-backend](https://github.com/stellar/stellar-disbursement-platform-backend): This repository contains the backend and infrastructure code for the Stellar Disbursement Platform.

    - [stellar/stellar-disbursement-platform-frontend](https://github.com/stellar/stellar-disbursement-platform-frontend): This repository contains the web frontend code for the Stellar Disbursement Platform.

    - [stellar/helm-charts](https://github.com/stellar/helm-charts/tree/main/charts/stellar-disbursement-platform): This repository contains the Helm chart for deploying the Stellar Disbursement Platform using kubernetes.

    '
  termsOfService: https://stellar.org/terms-of-service
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: ''
tags:
- name: Statistics
  description: Statistics endpoints return general aggregated data per organization, as well as disbursement-specific metrics. SDP users can use this data to monitor their disbursements over time.
paths:
  /statistics:
    get:
      tags:
      - Statistics
      summary: Retrieve All Statistics
      description: Fetches all metrics on all disbursements the organization has created. The response includes basic aggregations on payments, receivers, receiver wallets, and assets.
      operationId: RetrieveAllStatistics
      responses:
        '200':
          description: General Statistics response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralStatistics'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  extras:
                    type: object
                    properties:
                      status:
                        type: number
                      message:
                        type: string
                example:
                  error: Not authorized
                  extras:
                    status: 401
                    message: Not authorized
              example:
                error: Not authorized
                extras:
                  status: 401
                  message: Not authorized
      security:
      - BearerAuth: []
  /statistics/{id}:
    get:
      tags:
      - Statistics
      summary: Retrieve Disbursement Statistics
      description: Fetches metrics on a specific disbursement by  `id `.
      operationId: RetrieveDisbursementStatistics
      parameters:
      - name: id
        in: path
        description: ID of the `Disbursement`.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Returns statistics for disbursement
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisbursementsStatistics'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  extras:
                    type: object
                    properties:
                      status:
                        type: number
                      message:
                        type: string
                example:
                  error: Not authorized
                  extras:
                    status: 401
                    message: Not authorized
              example:
                error: Not authorized
                extras:
                  status: 401
                  message: Not authorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                example:
                  error: Forbidden
              example:
                error: Forbidden
      security:
      - BearerAuth: []
components:
  schemas:
    DisbursementsStatistics:
      type: object
      properties:
        payment_counters:
          $ref: '#/components/schemas/PaymentCounters'
        payment_amounts_by_asset:
          type: array
          items:
            $ref: '#/components/schemas/PaymentAmountsByAsset'
        receiver_wallets_counters:
          $ref: '#/components/schemas/ReceiverWalletsCounters'
        total_receivers:
          type: integer
          description: Total number of receivers
          format: int64
          example: 100
    GeneralStatistics:
      type: object
      properties:
        total_disbursements:
          type: integer
          description: Total number of disbursements
          format: int64
          example: 20
        payment_counters:
          $ref: '#/components/schemas/PaymentCounters'
        payment_amounts_by_asset:
          type: array
          items:
            $ref: '#/components/schemas/PaymentAmountsByAsset'
        receiver_wallets_counters:
          $ref: '#/components/schemas/ReceiverWalletsCounters'
        total_receivers:
          type: integer
          description: Total number of receivers
          format: int64
          example: 1000
    PaymentAmountsByAsset:
      type: object
      properties:
        asset_code:
          type: string
          example: USDC
        payment_amounts:
          $ref: '#/components/schemas/PaymentAmounts'
    PaymentCounters:
      type: object
      properties:
        draft:
          type: integer
          format: int64
          example: 1
        ready:
          type: integer
          format: int64
          example: 2
        pending:
          type: integer
          format: int64
          example: 3
        paused:
          type: integer
          format: int64
          example: 1
        success:
          type: integer
          format: int64
          example: 5
        failed:
          type: integer
          format: int64
          example: 1
        total:
          type: integer
          format: int64
          example: 14
    PaymentAmounts:
      type: object
      properties:
        draft:
          type: string
          example: '100.00'
        ready:
          type: string
          example: '200.00'
        pending:
          type: string
          example: '300.00'
        paused:
          type: string
          example: '100.00'
        success:
          type: string
          example: '500.00'
        failed:
          type: string
          example: '100.00'
        average:
          type: string
          example: '100.00'
        total:
          type: string
          example: '1400.00'
    ReceiverWalletsCounters:
      type: object
      properties:
        draft:
          type: integer
          format: int64
          example: 1
        ready:
          type: integer
          format: int64
          example: 1
        registered:
          type: integer
          format: int64
          example: 1
        flagged:
          type: integer
          format: int64
          example: 1
        total:
          type: integer
          format: int64
          example: 4
  securitySchemes:
    BearerAuth:
      type: apiKey
      description: Authorization header containing an SDP JWT (ES256) or an SDP_ API key.
      name: Authorization
      in: header
    SEP10Auth:
      type: apiKey
      description: Authorization header containing a SEP-10 JWT (Bearer {token}).
      name: Authorization
      in: header
    SEP24Auth:
      type: apiKey
      description: Authorization header containing a SEP-24 JWT (Bearer {token}).
      name: Authorization
      in: header
    SEP24QueryAuth:
      type: apiKey
      description: Query parameter containing a SEP-24 JWT.
      name: token
      in: query
x-original-swagger-version: '2.0'