> ## 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.

# Offer orders

> Recent completed orders for a CPL offer.



## OpenAPI

````yaml GET /cpl/offers/{id}/orders
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:
  /cpl/offers/{id}/orders:
    get:
      tags:
        - CPL
      summary: Offer orders
      description: Recent completed orders for a CPL offer.
      operationId: getCplOfferOrders
      parameters:
        - $ref: '#/components/parameters/IdPath'
        - $ref: '#/components/parameters/Page'
        - name: page_size
          in: query
          schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 100
        - name: sort
          in: query
          schema:
            type: string
            enum:
              - date_desc
              - date_asc
              - price_desc
              - price_asc
              - romi_desc
              - dialogs_desc
            default: date_desc
          description: >-
            Sort order.

            - `date_desc`: newest orders first (by campaign end date; default).

            - `date_asc`: oldest orders first.

            - `price_desc`: highest price first.

            - `price_asc`: lowest price first.

            - `romi_desc`: best return on marketing investment first. Orders
            where ROMI is hidden (either party opted out) always sort to the
            bottom; if the offer hides ROMI globally, the API falls back to
            `date_desc`.

            - `dialogs_desc`: most dialogs (3-message threshold) first.
      responses:
        '200':
          description: >-
            Successful response. Capped at the 500 most-recent matching rows;
            `pagination.total` reflects that cap, not the absolute count of
            orders ever placed on this offer.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CplOfferOrder'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Offer not found
          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:
    IdPath:
      name: id
      in: path
      required: true
      schema:
        type: integer
        minimum: 1
      description: Numeric resource id.
      example: 1
    Page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
      description: Page number, 1-indexed.
      example: 1
  schemas:
    CplOfferOrder:
      type: object
      description: >-
        Anonymized recent completed order for a partner offer. Customer identity
        (account, model, order id) is intentionally omitted.
      properties:
        fans_ordered:
          type: integer
          description: How many fans the client bought.
        fans_delivered:
          type: integer
          description: How many fans the campaign actually subscribed.
        duration_seconds:
          type: integer
          nullable: true
          description: Wall-clock time from start to end of the campaign.
        date_from:
          type: string
          format: date-time
          nullable: true
          description: Campaign start (ISO 8601, UTC).
        date_from_ts:
          type: integer
          nullable: true
          description: Campaign start as a Unix timestamp.
        date_to:
          type: string
          format: date-time
          nullable: true
          description: Campaign end (ISO 8601, UTC).
        date_to_ts:
          type: integer
          nullable: true
          description: Campaign end as a Unix timestamp.
        dialogs:
          type: integer
          description: Fans who exchanged at least 3 messages.
        dialogs_rate_percent:
          type: integer
          description: '`dialogs / fans_delivered` as a percent.'
        price:
          type: number
          format: float
          description: Per-fan price (USD) at the time of the order.
        romi_percent:
          type: integer
          nullable: true
          description: >-
            Per-order ROMI. `null` whenever either party has opted out of
            publication: the partner who published the offer hiding ROMI, or the
            client toggling `Hide income stats` for their order.
    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.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your API key from the Studio Dashboard

````