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

# Campaigns

> Active and completed revshare campaigns attached to your linked OF accounts.



## OpenAPI

````yaml GET /revshare/campaigns
openapi: 3.0.3
info:
  title: OnlyTraffic Studio API
  version: 1.0.0
  description: >-
    External API for OnlyTraffic Studio. Manage and retrieve data about your
    subscribers, CPL orders, and CPC orders.
servers:
  - url: https://studio-api.onlytraffic.com/api/external/v1
security:
  - ApiKeyAuth: []
tags:
  - name: Account
    description: API key holder's wallet, profile, and aggregate state.
  - name: Accounts
    description: OnlyFans accounts attached to the API key holder.
  - name: Agencies
    description: Agency CRUD and image management. All edits stage in moderation.
  - name: CPL
    description: >-
      Cost-per-lead orders: place, list, cancel, manage settings, browse partner
      offers.
  - name: CPC
    description: Cost-per-click orders and creative management.
  - name: RevShare
    description: Revenue-share campaigns and invoices.
  - name: Swaps
    description: Two-sided traffic swap orders and offers.
  - name: Subscribers
    description: Per-fan delivery feed (cursor-paginated).
  - name: Transactions
    description: Per-transaction OF revenue feed (cursor-paginated).
paths:
  /revshare/campaigns:
    get:
      tags:
        - RevShare
      summary: Campaigns
      description: >-
        Active and completed revshare campaigns attached to your linked OF
        accounts.
      operationId: getRevshareCampaigns
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PageSize'
        - name: of_account_id
          in: query
          schema:
            type: integer
          description: Filter by OnlyFans account id (must be one of your accounts).
        - name: campaign_id
          in: query
          schema:
            type: string
          description: Filter by campaign public ID (e.g. `revc_xxxxx`).
        - name: marketer_uuid
          in: query
          schema:
            type: string
            format: uuid
          description: Filter to campaigns run by a specific marketer.
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - completed
          description: Filter by campaign status.
        - name: type
          in: query
          schema:
            type: string
            enum:
              - date
              - link
              - trial
              - smartlink
              - smartlink_trial
              - smartlink_tracking
              - second
              - shared_link
              - shared_trial
          description: Filter by campaign delivery type.
        - name: source
          in: query
          schema:
            type: string
          description: >-
            Filter by traffic source the campaign is running on (e.g.
            `instagram`, `tiktok`, `reddit`). Use `other` for sources outside
            the standard catalog.
        - name: min_fans
          in: query
          schema:
            type: integer
            minimum: 0
          description: Return only campaigns with at least this many lifetime fans.
        - name: min_income
          in: query
          schema:
            type: number
            minimum: 0
          description: Return only campaigns whose total income is at least this many USD.
        - $ref: '#/components/parameters/SinceChangedAt'
        - $ref: '#/components/parameters/UntilChangedAt'
        - name: sort
          in: query
          schema:
            type: string
            enum:
              - created_at_desc
              - created_at_asc
              - changed_at_desc
              - changed_at_asc
              - arpu_desc
              - total_income_desc
              - income_today_desc
              - fans_desc
              - fans_today_desc
              - purchases_1_desc
              - messages_3_desc
            default: created_at_desc
          description: >-
            Sort order.

            - `arpu_desc`: average revenue per user, descending.

            - `total_income_desc`: total marketer income, descending.

            - `income_today_desc`: today's transactions sum, descending.

            - `fans_desc`: total subscribers, descending.

            - `fans_today_desc`: subscribers added since today's midnight UTC.

            - `purchases_1_desc`: fans who made at least one purchase,
            descending.

            - `messages_3_desc`: fans who exchanged at least 3 messages,
            descending.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RevshareCampaign'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: >-
            Server error. Body always reads `{success:false,
            error:"server_error", message:"Server error"}` (no internal details
            leak).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    Page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
      description: Page number, 1-indexed.
      example: 1
    PageSize:
      name: page_size
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
      description: Items per page. Default 50, max 100.
      example: 50
    SinceChangedAt:
      name: since_changed_at
      in: query
      schema:
        type: integer
        minimum: 0
      description: >-
        Delta-sync filter. Return only rows whose `changed_at` is at or after
        this UNIX timestamp. Pair with `until_changed_at` for a window.
      example: 1738000000
    UntilChangedAt:
      name: until_changed_at
      in: query
      schema:
        type: integer
        minimum: 0
      description: >-
        Delta-sync filter. Return only rows whose `changed_at` is strictly
        before this UNIX timestamp. Useful to lock the upper bound while
        paginating an open delta range.
      example: 1738604800
  schemas:
    RevshareCampaign:
      type: object
      properties:
        campaign_id:
          type: string
          description: Stable public id of the revshare campaign.
          example: revc_xxxxxxx
        of_account_id:
          type: integer
          description: >-
            OnlyFans account id this campaign is running on. Matches the
            `of_account_id` returned by `/accounts`.
          example: 123456
        name:
          type: string
          description: >-
            Campaign name set by the marketer (free-form, used for human
            reference).
          example: Reddit 03.04.2026
        source:
          type: string
          description: Human-readable traffic source name (e.g. `Reddit`, `Twitter`).
          example: Reddit
        type:
          type: string
          enum:
            - date
            - link
            - trial
            - smartlink
            - smartlink_trial
            - smartlink_tracking
            - second
            - shared_link
            - shared_trial
          description: >-
            Campaign delivery type.

            - `link`: OnlyFans tracking link.

            - `trial`: OnlyFans free-trial link.

            - `shared_link` / `shared_trial`: shared link/trial across multiple
            campaigns.

            - `smartlink` / `smartlink_trial` / `smartlink_tracking`:
            OnlyTraffic smartlink products.

            - `date` / `second`: legacy types.
          example: link
        status:
          type: string
          enum:
            - active
            - completed
          description: Campaign status.
          example: active
        marketer:
          $ref: '#/components/schemas/Marketer'
        revshare_percent:
          type: number
          format: float
          description: >-
            Percentage of campaign revenue paid out to the partner running the
            revshare. Set on the studio at
            `studio.onlytraffic.com/of-account/{username}/revshare`.
          example: 50
        campaign_url:
          type: string
          nullable: true
          description: >-
            Tracking URL the marketer is sending traffic to. May be null for
            some campaign types.
          example: https://onlyfans.com/.../c...
        stats:
          $ref: '#/components/schemas/OrderStats'
        created_at:
          type: string
          format: date-time
          description: Campaign start date (ISO 8601).
          example: '2025-11-13T13:45:15+00:00'
        created_at_ts:
          type: integer
          description: Campaign start as Unix timestamp.
          example: 1763030715
        changed_at:
          type: string
          format: date-time
          description: >-
            Last time anything visible on this campaign changed: status, stats
            recalc, new fan, new transaction. Use with `since_changed_at` for
            delta-sync polling.
          example: '2026-05-05T13:24:30+00:00'
        changed_at_ts:
          type: integer
          description: Last-changed date as a Unix timestamp.
          example: 1746450270
        completed_at:
          type: string
          format: date-time
          nullable: true
          description: Date the campaign was stopped (ISO 8601), null if still active.
          example: null
    Pagination:
      type: object
      description: >-
        Page-based pagination, returned by every list endpoint that isn't a
        cursor feed.
      properties:
        page:
          type: integer
          description: Current page number (1-indexed).
          example: 1
        page_size:
          type: integer
          description: Number of items per page. Default 50, max 100.
          example: 50
        total:
          type: integer
          description: Total number of records matching the filters.
          example: 150
        total_pages:
          type: integer
          description: Total pages available.
          example: 3
        has_next:
          type: boolean
          description: >-
            `true` when `page < total_pages` (i.e. there is at least one more
            page to fetch).
          example: true
    ErrorResponse:
      type: object
      description: Standard error envelope for all 4xx/5xx responses.
      required:
        - success
        - error
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
          description: Always false on error responses.
        error:
          type: string
          description: Stable snake_case machine-readable error code. Branch on this.
          example: validation_failed
        message:
          type: string
          description: >-
            Human-friendly text. For 5xx this is always the literal `Server
            error`. For 4xx an actionable validation/auth message is returned.
        details:
          type: object
          nullable: true
          description: >-
            Optional per-field diagnostic information. On 422 carries `{<field>:
            ["error_code", ...]}`. On 402 (`insufficient_balance`) carries
            `{required, current}`. On 426 (`unpaid_invoices`) carries `{count,
            total, oldest_date_ts}`. Absent on most other errors.
          additionalProperties: true
        retry_after:
          type: integer
          nullable: true
          description: >-
            Seconds until the next request will succeed. Present only on 429
            responses (rate limit). Mirrors the `Retry-After` HTTP header.
    Marketer:
      type: object
      description: >-
        Mini-snapshot of an offer's owner. Same shape across CPL offers, CPC
        offers, and revshare campaigns.
      properties:
        uuid:
          type: string
          format: uuid
          nullable: true
          description: Stable public id of the marketer.
          example: 27f029f3-3e07-42a6-82d3-e5fa3ef81880
        display_name:
          type: string
          nullable: true
        display_emoji:
          type: string
          nullable: true
          description: Optional emoji shown next to the partner's name.
        level:
          type: string
          enum:
            - new
            - base
            - pro
            - expert
        registered_ago_days:
          type: integer
          nullable: true
        online:
          type: object
          nullable: true
          description: >-
            Last-active snapshot. `null` when the marketer has never been
            active.
          properties:
            ago:
              type: string
              description: Human-friendly relative time, e.g. `2h 5m`.
            status:
              type: string
              enum:
                - online
                - recently
                - offline
              description: '`online` <30 min, `recently` <24 h, otherwise `offline`.'
    OrderStats:
      type: object
      nullable: true
      description: >-
        Unified delivery-stats block used by /cpl/orders, /cpc/orders,
        /revshare/campaigns and /swaps/orders. `null` when the resource has no
        marketing data yet, or when the income side is hidden (swaps without
        `stats_public_arpu`).
      properties:
        fans_subscribed:
          type: object
          properties:
            total:
              type: integer
            today:
              type: integer
        transactions_sum:
          type: object
          nullable: true
          description: >-
            Sum of OnlyFans transactions on this resource's fans, USD. `null` on
            swap orders where the income side is hidden.
          properties:
            total:
              type: number
              format: float
            today:
              type: number
              format: float
        arpu:
          type: number
          format: float
          nullable: true
          description: >-
            transactions_sum.total / fans_subscribed.total. `null` when income
            is hidden.
        arpu_paying:
          type: number
          format: float
          nullable: true
          description: >-
            ARPU restricted to fans who paid at least once. `null` when income
            is hidden.
        romi:
          type: integer
          nullable: true
          description: >-
            ((transactions_sum.total / cost) - 1) * 100. `null` for revshare or
            when cost is 0.
        pay_subscribe:
          $ref: '#/components/schemas/OrderStatsBucket'
          description: Fans on an initial paid subscription.
        pay_resubscribe:
          $ref: '#/components/schemas/OrderStatsBucket'
          description: Fans on a recurring paid subscription.
        purchases_1:
          $ref: '#/components/schemas/OrderStatsBucket'
          description: Fans who made ≥ 1 paid purchase.
        purchases_2:
          $ref: '#/components/schemas/OrderStatsBucket'
          description: Fans who made ≥ 2 paid purchases.
        purchases_5:
          $ref: '#/components/schemas/OrderStatsBucket'
          description: Fans who made ≥ 5 paid purchases.
        whale:
          $ref: '#/components/schemas/OrderStatsBucket'
          description: Fans who spent ≥ $500 lifetime.
        messages_3:
          $ref: '#/components/schemas/OrderStatsBucket'
          description: Fans who exchanged ≥ 3 messages.
    OrderStatsBucket:
      type: object
      properties:
        total:
          type: integer
          description: Lifetime count.
        today:
          type: integer
          description: Added since today's midnight (server time).
        percent:
          type: number
          format: float
          description: '`total / fans_subscribed.total * 100`.'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your API key from the Studio Dashboard

````