v8

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-2526602.8 MB
Smart Links

List Smart Link Conversions

Query smart link conversions in a date range with optional bot/duplicate and conversion type filtering

get/api/smart-links/{smart_link_id}/conversions

Query parameters

date_startstring

Optional report range start date

Example:2026-01-01T00:00:00Z

Optional report range start date

date_endstring

Optional report range end date

Example:2026-01-07T23:59:59Z

Optional report range end date

limitinteger

Rows per page. Default 100

Example:100

Rows per page. Default 100

offsetinteger

Offset for pagination. Default 0

Offset for pagination. Default 0

include_botsboolean

Include conversions from clicks marked as bots. Default true

Example:true

Include conversions from clicks marked as bots. Default true

include_duplicatesboolean

Include conversions from duplicate clicks. Default true

Example:true

Include conversions from duplicate clicks. Default true

conversion_type'new_subscriber' | 'new_transaction' | 'message_received' | 'fan_sent_3_messages'

Optional conversion type filter

Example:new_transaction

Optional conversion type filter

onlyfans_user_idstring

Optional - Search for conversions by OnlyFans User ID

Example:1234567

Optional - Search for conversions by OnlyFans User ID

Response

Success

Example response

{
  "data": {
    "summary": {
      "conversions_total": 6,
      "subscribers_total": 3,
      "revenue_total": 240.5
    },
    "chart": [
      {
        "timestamp": "2026-01-30",
        "conversions": 2
      },
      {
        "timestamp": "2026-01-31",
        "conversions": 4
      }
    ],
    "rows": [
      {
        "id": "01JTESTCONV0000000000000001",
        "conversion_type": "new_transaction",
        "amount_gross": 120.25,
        "amount_net": 100,
        "conversion_at": "2026-01-31T22:15:00+00:00",
        "fan_onlyfans_id": "123456789",
        "fan": {
          "onlyfans_id": "123456789",
          "username": "demo_fan",
          "name": "Demo Fan",
          "avatar_url": "https://cdn.example.com/avatar.jpg",
          "onlyfans_url": "https://onlyfans.com/demo_fan"
        },
        "click": {
          "id": "01JTESTCLICK000000000000001",
          "created_at": "2026-01-31T21:45:00+00:00",
          "referrer": "example.com",
          "ip_address": "192.168.1.10",
          "user_agent": "Mozilla/5.0",
          "browser_device_type": "Desktop",
          "browser_name": "Chrome",
          "browser_family": "Chrome",
          "browser_platform": "macOS",
          "is_bot": false,
          "is_duplicate": false,
          "country_code": "US",
          "external_click_id": "ext_123",
          "gross_clicks": 1,
          "fbclid": null,
          "gclid": "google-click-id",
          "ttclid": "tiktok-click-id",
          "aff_s1": "campaign-a",
          "aff_s2": null,
          "aff_s3": null,
          "aff_s4": null,
          "aff_s5": null,
          "utm_source": "google",
          "utm_medium": "cpc",
          "utm_campaign": "winter",
          "utm_content": "creative-a",
          "utm_term": "fans"
        }
      }
    ],
    "filters": {
      "date_start": "2026-01-25T00:00:00+00:00",
      "date_end": "2026-01-31T23:59:59+00:00",
      "limit": 100,
      "offset": 0,
      "include_bots": true,
      "include_duplicates": true,
      "conversion_type": "new_transaction"
    }
  },
  "_meta": {
    "_credits": {
      "used": 0,
      "balance": 999999,
      "note": "Free endpoint"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    }
  }
}