> ## Documentation Index
> Fetch the complete documentation index at: https://growi.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Payout totals

> Totals for the same filters as /payouts: owed and paid amounts, counts, the breakdown by payout component and what is owed per cycle. A total is null, never partial, while a payout it needs is recalculating. Replaces /stats/payouts_24h.

> [!TIP]
>
> Replaces [`/stats/payouts_24h`](https://growi.mintlify.site/api-reference/endpoint/get-payouts-24h) and [`/stats/manual_campaign_progress`](https://growi.mintlify.site/api-reference/endpoint/get-manual-campaign-progress), which are deprecated.


## OpenAPI

````yaml GET /payouts/totals
openapi: 3.0.1
info:
  title: Growi API
  description: >-
    API documentation for Growi platform, showcasing the public tracking event
    endpoint
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.growi.io/api/public/v1
security:
  - bearerAuth: []
paths:
  /payouts/totals:
    get:
      summary: Payout totals
      description: >-
        Totals for the same filters as /payouts: owed and paid amounts, counts,
        the breakdown by payout component and what is owed per cycle. A total is
        null, never partial, while a payout it needs is recalculating. Replaces
        /stats/payouts_24h.
      parameters:
        - name: organization_id
          in: query
          required: false
          description: >-
            Read one of your child brands instead of the organization that owns
            the key. Any id that is not one of your brands answers 404.
          schema:
            type: integer
        - name: invoice_status
          in: query
          required: false
          description: all (default), due, in_progress, open, paid, completed or canceled.
          schema:
            type: string
            enum:
              - all
              - due
              - in_progress
              - open
              - paid
              - completed
              - canceled
        - name: campaign_id
          in: query
          required: false
          description: Only this campaign of your organization (404 otherwise).
          schema:
            type: integer
        - name: creator_id
          in: query
          required: false
          description: Only this creator (Growi user id).
          schema:
            type: integer
        - name: cycle
          in: query
          required: false
          description: Only this payout cycle number (1 = first).
          schema:
            type: integer
        - name: payout_type
          in: query
          required: false
          description: Only TikTok Shop contest payouts, or everything else.
          schema:
            type: string
            enum:
              - contest
              - not_contest
        - name: search
          in: query
          required: false
          description: Creator name, email or payout uuid.
          schema:
            type: string
        - name: start_date
          in: query
          required: false
          description: 'With invoice_status=paid: paid on or after this day, YYYY-MM-DD.'
          schema:
            type: string
            format: date
        - name: end_date
          in: query
          required: false
          description: 'With invoice_status=paid: paid on or before this day, YYYY-MM-DD.'
          schema:
            type: string
            format: date
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    additionalProperties: true
                  meta:
                    type: object
                    additionalProperties: true
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            `organization_id` isn't an active child brand of your organization,
            or the record doesn't exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Invalid or missing params. `error` says which
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            Rate limited: 2 seconds between calls and an hourly cap per API key.
            See `Retry-After` and the `X-RateLimit-*` headers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ApiError:
      type: object
      properties:
        error:
          type: string
          description: What went wrong
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.