Retrieve an Ad Campaign

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const adCampaign = await client.adCampaigns.retrieve('id');

console.log(adCampaign.id);

curl --request GET \
  --url https://api.whop.com/api/v1/ad_campaigns/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.whop.com/api/v1/ad_campaigns/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/ad_campaigns/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/ad_campaigns/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.whop.com/api/v1/ad_campaigns/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/ad_campaigns/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "added_to_cart_value": 123,
  "added_to_carts": 123,
  "bid_type": "minimum_cost",
  "budget_amount": 123,
  "budget_optimization": "ad_campaign",
  "budget_type": "daily",
  "click_through_rate": 123,
  "clicks": 123,
  "completed_registration_value": 123,
  "completed_registrations": 123,
  "contact_value": 123,
  "contacts": 123,
  "cost_per_added_to_cart": 123,
  "cost_per_click": 123,
  "cost_per_completed_registration": 123,
  "cost_per_contact": 123,
  "cost_per_lead": 123,
  "cost_per_mille": 123,
  "cost_per_purchase": 123,
  "cost_per_result": 123,
  "cost_per_schedule": 123,
  "cost_per_submitted_application": 123,
  "cost_per_viewed_content": 123,
  "created_at": "<string>",
  "custom_conversions": 123,
  "custom_event_counts": {},
  "custom_event_values": {},
  "delivery_status": "payment_failed",
  "frequency": 123,
  "id": "<string>",
  "impressions": 123,
  "issues": [
    {
      "id": "<string>",
      "message": "<string>",
      "resource_id": "<string>",
      "resource_type": "ad_campaign"
    }
  ],
  "lead_value": 123,
  "leads": 123,
  "objective": "awareness",
  "optimization_goal": "<string>",
  "platform": "meta",
  "purchase_value": 123,
  "purchases": 123,
  "reach": 123,
  "result_event": "purchase",
  "result_event_name": "<string>",
  "results": 123,
  "return_on_ad_spend": 123,
  "schedule_value": 123,
  "schedules": 123,
  "special_ad_categories": [
    "housing"
  ],
  "spend": 123,
  "spend_currency": "<string>",
  "status": "active",
  "submitted_application_value": 123,
  "submitted_applications": 123,
  "title": "<string>",
  "unique_click_through_rate": 123,
  "unique_clicks": 123,
  "updated_at": "<string>",
  "viewed_content_value": 123,
  "viewed_contents": 123
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

GET

ad_campaigns

{id}

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const adCampaign = await client.adCampaigns.retrieve('id');

console.log(adCampaign.id);

curl --request GET \
  --url https://api.whop.com/api/v1/ad_campaigns/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.whop.com/api/v1/ad_campaigns/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/ad_campaigns/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/ad_campaigns/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.whop.com/api/v1/ad_campaigns/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/ad_campaigns/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "added_to_cart_value": 123,
  "added_to_carts": 123,
  "bid_type": "minimum_cost",
  "budget_amount": 123,
  "budget_optimization": "ad_campaign",
  "budget_type": "daily",
  "click_through_rate": 123,
  "clicks": 123,
  "completed_registration_value": 123,
  "completed_registrations": 123,
  "contact_value": 123,
  "contacts": 123,
  "cost_per_added_to_cart": 123,
  "cost_per_click": 123,
  "cost_per_completed_registration": 123,
  "cost_per_contact": 123,
  "cost_per_lead": 123,
  "cost_per_mille": 123,
  "cost_per_purchase": 123,
  "cost_per_result": 123,
  "cost_per_schedule": 123,
  "cost_per_submitted_application": 123,
  "cost_per_viewed_content": 123,
  "created_at": "<string>",
  "custom_conversions": 123,
  "custom_event_counts": {},
  "custom_event_values": {},
  "delivery_status": "payment_failed",
  "frequency": 123,
  "id": "<string>",
  "impressions": 123,
  "issues": [
    {
      "id": "<string>",
      "message": "<string>",
      "resource_id": "<string>",
      "resource_type": "ad_campaign"
    }
  ],
  "lead_value": 123,
  "leads": 123,
  "objective": "awareness",
  "optimization_goal": "<string>",
  "platform": "meta",
  "purchase_value": 123,
  "purchases": 123,
  "reach": 123,
  "result_event": "purchase",
  "result_event_name": "<string>",
  "results": 123,
  "return_on_ad_spend": 123,
  "schedule_value": 123,
  "schedules": 123,
  "special_ad_categories": [
    "housing"
  ],
  "spend": 123,
  "spend_currency": "<string>",
  "status": "active",
  "submitted_application_value": 123,
  "submitted_applications": 123,
  "title": "<string>",
  "unique_click_through_rate": 123,
  "unique_clicks": 123,
  "updated_at": "<string>",
  "viewed_content_value": 123,
  "viewed_contents": 123
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-07-18"

Path Parameters

string

required

The ad campaign ID.

Query Parameters

stats_from

string

Start of the stats window.

stats_to

string

End of the stats window.

time_zone

string

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

Response

ad campaign retrieved

added_to_cart_value

number

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_carts

number

required

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

bid_type

enum<string> | null

required

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.

Available options:

minimum_cost,

average_target,

maximum_target,

null

Example:

"minimum_cost"

budget_amount

number | null

required

The campaign's budget, in the ad account's currency. null when each ad group sets its own budget instead.

budget_optimization

enum<string> | null

required

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

Available options:

ad_campaign,

ad_group,

null

Example:

"ad_campaign"

budget_type

enum<string> | null

required

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

Available options:

daily,

lifetime,

null

Example:

"daily"

click_through_rate

number

required

Clicks divided by impressions, between 0 and 1.

clicks

number

required

The number of clicks.

completed_registration_value

number

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_registrations

number

required

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

contact_value

number

required

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

contacts

number

required

Whop pixel-attributed contact events, last-click.

cost_per_added_to_cart

number | null

required

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

cost_per_click

number

required

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

cost_per_completed_registration

number | null

required

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

cost_per_contact

number | null

required

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

cost_per_lead

number | null

required

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

cost_per_mille

number

required

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

cost_per_purchase

number | null

required

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

cost_per_result

number | null

required

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

cost_per_schedule

number | null

required

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

cost_per_submitted_application

number | null

required

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

cost_per_viewed_content

number | null

required

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

created_at

string

required

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

custom_conversions

number

required

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

custom_event_counts

object

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_values

object

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

enum<string>

required

Whether the campaign's ads are delivering right now, and if not, why. When several states apply at once, the highest-precedence one is returned.

Available options:

payment_failed,

all_ads_rejected,

draft,

no_ad_groups,

no_ads,

paused,

processing,

issues,

scheduled,

completed,

ad_groups_off,

active

Example:

"payment_failed"

frequency

number | null

required

Platform-reported impressions divided by reach.

string

required

Unique identifier for the ad campaign, prefixed adcamp_.

impressions

number

required

The number of impressions.

issues

object[]

required

Show child attributes

lead_value

number

required

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

leads

number

required

Whop pixel-attributed leads, last-click.

objective

enum<string> | null

required

The goal the campaign optimizes toward.

Available options:

awareness,

traffic,

engagement,

leads,

sales,

null

Example:

"awareness"

optimization_goal

string | null

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

enum<string>

required

The ad network the campaign runs on.

Available options:

meta

Example:

"meta"

purchase_value

number

required

USD value of pixel-attributed purchases.

purchases

number

required

Whop pixel-attributed purchases, last-click.

reach

number

required

The number of unique people who saw this.

result_event

enum<string> | null

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.

Available options:

purchase,

lead,

schedule,

submit_application,

contact,

complete_registration,

view_content,

add_to_cart,

custom,

null

Example:

"purchase"

result_event_name

string | null

required

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

results

number | null

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_spend

number

required

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

schedule_value

number

required

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

schedules

number

required

Whop pixel-attributed schedule events, last-click.

special_ad_categories

enum<string>[]

required

Regulated categories the campaign is declared under. Ads in these categories are subject to extra targeting restrictions. Empty when none apply.

Available options:

housing,

employment,

financial_products,

politics

spend

number

required

The amount charged, in spend_currency.

spend_currency

string | null

required

The ISO 4217 currency code of all monetary metrics.

status

enum<string>

required

The lifecycle status of the ad campaign.

Available options:

active,

paused,

inactive,

stale,

pending_refund,

payment_failed,

draft,

in_review,

flagged,

importing,

imported

Example:

"active"

submitted_application_value

number

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_applications

number

required

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

title

string

required

Display name of the ad campaign.

unique_click_through_rate

number | null

required

Unique clicks divided by impressions, between 0 and 1.

unique_clicks

number

required

The number of unique clicks.

updated_at

string

required

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

viewed_content_value

number

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_contents

number

required

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

Create an Ad Campaign

Update an Ad Campaign

⌘I

Introduction

Reference

Core Resources

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Retrieve an Ad Campaign

Authorizations

Headers

Path Parameters

Query Parameters

Response