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

# Get campaign stats

> Stats-only campaign payload for polling without refetching campaign metadata.



## OpenAPI

````yaml https://api-tbi.boost.xyz/v1/openapi.json get /v1/campaigns/{campaignId}/stats
openapi: 3.1.0
info:
  title: Boost Time-Based Incentives SDK API
  version: 1.0.0
  description: >-
    Public /v1 API surface for the Boost TBI SDK. Internal Rabbithole, admin,
    Polymarket, and widget routes are intentionally excluded.
servers:
  - url: https://api-tbi.boost.xyz
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: Campaigns
    description: Campaign discovery, detail, and stats endpoints.
  - name: Claims
    description: Claim proof and claim status endpoints.
  - name: Forwarder
    description: Boost Forwarder target discovery and direct deposit transaction builders.
  - name: Referrals
    description: >-
      Referral attribution: signed per-campaign binds, referrer earnings, and
      claim proofs.
  - name: Users
    description: User rewards and balance endpoints.
paths:
  /v1/campaigns/{campaignId}/stats:
    get:
      tags:
        - Campaigns
      summary: Get campaign stats
      description: >-
        Stats-only campaign payload for polling without refetching campaign
        metadata.
      operationId: getCampaignStats
      parameters:
        - name: campaignId
          in: path
          required: true
          description: Campaign ID in chainId:campaignIndex form, for example 480:1.
          schema:
            type: string
            pattern: ^\d+:\d+$
        - name: X-Boost-Ref-Id
          in: header
          required: false
          description: >-
            Optional partner attribution reference ID. Values are manually
            assigned by Boost and must be at most 128 characters.
          schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$
      responses:
        '200':
          description: Campaign stats
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignStats'
        '400':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
components:
  schemas:
    CampaignStats:
      type: object
      properties:
        id:
          type: object
          properties:
            chainId:
              type: integer
              exclusiveMinimum: 0
              maximum: 9007199254740991
            campaignIndex:
              type: integer
              minimum: 0
              maximum: 9007199254740991
          required:
            - chainId
            - campaignIndex
          additionalProperties: false
        tvl:
          type: string
          pattern: ^(0|[1-9]\d*)$
        participants:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        rewardsDistributed:
          type: string
          pattern: ^(0|[1-9]\d*)$
        rewardsRemaining:
          type: string
          pattern: ^(0|[1-9]\d*)$
        boostApyBps:
          anyOf:
            - type: string
              pattern: ^(0|[1-9]\d*)$
            - type: 'null'
        protocolApyBps:
          anyOf:
            - type: string
              pattern: ^(0|[1-9]\d*)$
            - type: 'null'
      required:
        - id
        - tvl
        - participants
        - rewardsDistributed
        - rewardsRemaining
        - boostApyBps
        - protocolApyBps
      additionalProperties: false
    V1ErrorResponse:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          enum:
            - INVALID_PARAMS
            - NOT_FOUND
            - RATE_LIMITED
            - INTERNAL_ERROR
            - INVALID_SIGNATURE
            - SELF_REFERRAL
            - ALREADY_BOUND
            - ALREADY_PARTICIPATING
            - CAMPAIGN_NOT_BINDABLE
            - INVALID_SESSION
            - WALLET_NOT_LINKED
            - REFERRER_NOT_LINKED
            - CYCLIC_REFERRAL
        details:
          anyOf:
            - {}
            - type: 'null'
      required:
        - error
        - code
        - details
      additionalProperties: false

````