Sign in
Ad Campaigns

Retrieve an Ad Campaign

Retrieves a single ad campaign with stats over the requested window.

get/ad_campaigns/{id}

Query parameters

stats_fromstring

Start of the stats window.

stats_tostring

End of the stats window.

time_zonestring

IANA timezone the stats window is interpreted in. Defaults to UTC.

attribution_model'last_touch' | 'first_touch'

Attribution model the conversion stats count under (defaults to last_touch). Under both models a journey with any whop ad touch attributes to whop; the model picks which whop touch credits the entity and which non-whop source wins otherwise.

Response

ad campaign retrieved

added_to_cart_valuenumber required

USD value attributed to add-to-cart events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

added_to_cartsnumber required

Whop pixel-attributed add-to-cart events, last-click.

bid_type'minimum_cost' | 'average_target' | 'maximum_target' | 'null' nullable

How delivery bids in the ad auction: minimum_cost gets the most results for the budget, average_target holds an average cost per result, and maximum_target never bids above a cap.

budget_amountnumber nullable required

The campaign's budget in USD, which is what it is stored and billed in. null when each ad group sets its own budget instead.

budget_amount_localnumber nullable required

The same budget stated in budget_currency at today's exchange rate, for display in the account's ads reporting currency. null when budget_amount is.

budget_currencystring required

The ISO 4217 code budget_amount_local is in: the account's ads_reporting_currency preference. usd unless the account changed it.

budget_optimization'ad_campaign' | 'ad_group' | 'null' nullable required

Which level owns the budget: the whole campaign (ad_campaign) or each ad group individually (ad_group).

budget_type'daily' | 'lifetime' | 'null' nullable required

Whether budget_amount is spent per day (daily) or over the campaign's full run (lifetime).

click_through_ratenumber required

Clicks divided by impressions, between 0 and 1.

clicksnumber required

The number of clicks.

completed_registration_valuenumber required

USD value attributed to complete-registration events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

completed_registrationsnumber required

Whop pixel-attributed complete-registration events, last-click.

contact_valuenumber required

USD value attributed to contact events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

contactsnumber required

Whop pixel-attributed contact events, last-click.

cost_per_added_to_cartnumber nullable required

Spend divided by attributed add-to-cart events; null when they are not the goal and none are attributed.

cost_per_clicknumber required

Spend divided by clicks; 0 when there are no clicks.

cost_per_completed_registrationnumber nullable required

Spend divided by attributed complete-registration events; null when they are not the goal and none are attributed.

cost_per_contactnumber nullable required

Spend divided by attributed contact events; null when contacts are not the goal and none are attributed.

cost_per_leadnumber nullable required

Spend divided by attributed leads; null when leads are not a goal and none are attributed.

cost_per_millenumber required

Spend per 1,000 impressions; 0 when there are no impressions.

cost_per_purchasenumber nullable required

Spend divided by attributed purchases; null when purchases are not a goal and none are attributed.

cost_per_resultnumber nullable required

Spend divided by Whop pixel-attributed results; null when nothing Whop-attributable is being optimized for.

cost_per_schedulenumber nullable required

Spend divided by attributed schedule events; null when schedules are not the goal and none are attributed.

cost_per_submitted_applicationnumber nullable required

Spend divided by attributed submit-application events; null when they are not the goal and none are attributed.

cost_per_unique_clicknumber nullable required

Spend divided by unique clicks; null when there are no unique clicks.

cost_per_viewed_contentnumber nullable required

Spend divided by attributed view-content events; null when they are not the goal and none are attributed.

created_atstring required

When the campaign was created, as an ISO 8601 timestamp.

custom_conversionsnumber required

Whop pixel-attributed custom (merchant-defined) conversion events, last-click, across all custom event names.

custom_event_countsobject required

Whop pixel-attributed custom conversions, keyed by your event name with its last-click count as the value. Empty when no named custom events are attributed. Custom events fired without a name are counted in custom_conversions but omitted here, so these values sum to at most custom_conversions.

custom_event_valuesobject required

Conversion value attributed to each custom event, keyed by event name like custom_event_counts. Sums the value passed to whop.track, normalized to USD; events fired without a value contribute 0.

delivery_status'payment_failed' | 'in_appeal' | 'all_ads_rejected' | 'draft' | 'no_ad_groups' | 'no_ads' | 'paused' | 'processing' | 'issues' | 'scheduled' | 'completed' | 'ad_groups_off' | 'active' required

Whether the campaign's ads are delivering right now, and if not, why. Account billing failures set payment_failed without changing the configured status. Successful payment retry clears that block and recalculates delivery. When several states apply at once, the highest-precedence one is returned.

desired_cost_per_resultnumber nullable

Google only: the target cost per conversion in USD when bid_type is average_target. null otherwise.

ends_atstring nullable

Google only: when the campaign stops delivering, as an ISO 8601 timestamp. null runs it until paused.

frequencynumber nullable required

Platform-reported impressions divided by reach.

idstring required

Unique identifier for the ad campaign, prefixed adcamp_.

impressionsnumber required

The number of impressions.

lead_valuenumber required

USD value attributed to lead events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

leadsnumber required

Whop pixel-attributed leads, last-click.

link_clicksnumber required

Clicks on links in the ad that lead to your destination, as reported by the ad platform. A subset of clicks, which also counts likes, comments, and other interactions with the ad.

objective'awareness' | 'traffic' | 'engagement' | 'leads' | 'sales' | 'null' nullable required

The goal the campaign optimizes toward.

optimization_goalstring nullable required

The event the campaign optimizes for when a single goal is set campaign-wide. null when each ad group sets its own optimization_goal.

platform'meta' | 'tiktok' | 'google' required

The ad network the campaign runs on.

purchase_valuenumber required

USD value of pixel-attributed purchases.

purchasesnumber required

Whop pixel-attributed purchases, last-click.

reachnumber required

The number of unique people who saw this.

result_event'purchase' | 'lead' | 'schedule' | 'submit_application' | 'contact' | 'complete_registration' | 'view_content' | 'add_to_cart' | 'custom' | 'messaging_conversation' | 'null' nullable required

The Whop pixel conversion event whose attributed count represents results — the optimization goal, or the highest-volume attributed event for campaigns that budget per ad group. Null when the goal isn't a Whop-attributed event.

result_event_namestring nullable required

The merchant-defined event name when result_event is custom; null for the standard events.

resultsnumber nullable required

The Whop pixel-attributed count behind result_event. When a campaign's ad groups optimize different goals there is no single result_event (it is null), and this is instead the sum of each ad group's own attributed results. Null when nothing Whop-attributable is being optimized for.

return_on_ad_spendnumber required

Purchase value divided by spend, both in USD (a currency-neutral ratio); 0 when there is no spend.

schedule_valuenumber required

USD value attributed to schedule events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

schedulesnumber required

Whop pixel-attributed schedule events, last-click.

special_ad_categoriesstring[] required
spendnumber required

The amount charged, in spend_currency.

spend_currencystring nullable required

The ISO 4217 currency code of all monetary metrics.

starts_atstring nullable

Google only: when the campaign starts delivering, as an ISO 8601 timestamp. null starts it as soon as it launches.

status'active' | 'paused' | 'inactive' | 'stale' | 'pending_refund' | 'payment_failed' | 'draft' | 'in_review' | 'flagged' | 'importing' | 'imported' | 'duplicating' required

The configured lifecycle status of the ad campaign. Billing failures preserve active or paused here and set delivery_status to payment_failed.

submitted_application_valuenumber required

USD value attributed to submit-application events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

submitted_applicationsnumber required

Whop pixel-attributed submit-application events, last-click.

titlestring required

Display name of the ad campaign.

unique_click_through_ratenumber nullable required

Unique clicks divided by impressions, between 0 and 1.

unique_clicksnumber required

People who clicked, reported by the Whop pixel, counted once per person.

updated_atstring required

When the campaign was last updated, as an ISO 8601 timestamp.

viewed_content_valuenumber required

USD value attributed to view-content events. Sums the value sent with each event, normalized to USD; events without a value contribute 0.

viewed_contentsnumber required

Whop pixel-attributed view-content events, last-click.

Example response

{
  "added_to_cart_value": 12650,
  "added_to_carts": 165,
  "bid_type": "average_target",
  "budget_amount": 50,
  "budget_amount_local": 50,
  "budget_currency": "usd",
  "budget_optimization": "ad_group",
  "budget_type": "daily",
  "click_through_rate": 0.025,
  "clicks": 5500,
  "completed_registration_value": 1650,
  "completed_registrations": 55,
  "contact_value": 2640,
  "contacts": 88,
  "cost_per_added_to_cart": 8,
  "cost_per_click": 0.24,
  "cost_per_completed_registration": 24,
  "cost_per_contact": 15,
  "cost_per_lead": 10,
  "cost_per_mille": 6,
  "cost_per_purchase": 30,
  "cost_per_result": 40,
  "cost_per_schedule": 22,
  "cost_per_submitted_application": 120,
  "cost_per_unique_click": 0.4,
  "cost_per_viewed_content": 1.1,
  "created_at": "2026-01-01T12:00:00.000Z",
  "custom_conversions": 41,
  "custom_event_counts": {
    "gift_card_purchased": 5,
    "quote_requested": 33
  },
  "custom_event_values": {
    "gift_card_purchased": 750,
    "quote_requested": 0
  },
  "delivery_status": "issues",
  "id": "adcamp_xxxxxxxxxxxxxx",
  "impressions": 220000,
  "issues": [
    {
      "id": "adiss_xxxxxxxxxxxxxx",
      "message": "Your ad was rejected for unacceptable business practices. Edit the ad's content and resubmit.",
      "resource_id": "ad_xxxxxxxxxxxxxx",
      "resource_type": "ad"
    }
  ],
  "lead_value": 3960,
  "leads": 132,
  "link_clicks": 4400,
  "objective": "leads",
  "platform": "meta",
  "purchase_value": 7920,
  "purchases": 44,
  "result_event": "custom",
  "result_event_name": "quote_requested",
  "results": 33,
  "return_on_ad_spend": 6,
  "schedule_value": 5400,
  "schedules": 60,
  "special_ad_categories": [
    "employment"
  ],
  "spend": 1320,
  "spend_currency": "usd",
  "status": "active",
  "submitted_application_value": 1320,
  "submitted_applications": 11,
  "title": "Ceramic coating — Austin leads",
  "unique_clicks": 3300,
  "updated_at": "2026-01-01T12:00:00.000Z",
  "viewed_content_value": 8400,
  "viewed_contents": 1200
}

Changes

Changed in 8 of the 74 revisions of this API.1519

  • c1dceb26e5053See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 7fcefabddb0a12See the full diff
    • ●

      added the new google enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 140d015b99661See the full diff
    • ●

      added the new in_appeal enum value to the response property for the response status

      response-property-enum-value-added

  • 16c82685be351See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c301132dbfd71See the full diff
    • ●

      added the new messaging_conversation enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f1020c3ecda41See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60bbb4a6ffbc1210See the full diff
    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ●

      added the new duplicating enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new tiktok enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional query request parameter attribution_model

      new-optional-request-parameter

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3a06a605784b2See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

Of the 74 revisions, 1 has no diff computed.