Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Ads

List Ads

Lists the ads for an account, with stats over the requested window.

get/ads

Query parameters

account_idstring

The account the ads belong to. Defaults to the account-scoped key's own account.

ad_campaign_idstring

Only return ads in this ad campaign.

ad_campaign_idsstring[]

Only return ads in these ad campaigns (max 100). Repeat the parameter for each id (ad_campaign_ids=a&ad_campaign_ids=b).

ad_group_idstring

Only return ads in this ad group.

ad_group_idsstring[]

Only return ads in these ad groups (max 100). Repeat the parameter for each id (ad_group_ids=a&ad_group_ids=b).

status'active' | 'paused' | 'in_review' | 'rejected'

Only return ads with this status.

querystring

Filter ads by a title or ID substring.

order'created_at' | 'updated_at' | 'spend' | 'impressions' | 'reach' | 'clicks' | 'unique_clicks' | 'frequency' | 'click_through_rate' | 'results' | 'cost_per_mille' | 'cost_per_click' | 'cost_per_result' | 'return_on_ad_spend'

The field to sort by. Defaults to created_at. Stat columns (spend, impressions, …) rank over the stats_from/stats_to window across the whole list, not just the current page. results, cost_per_result and return_on_ad_spend rank by the same Whop pixel-attributed values the response reports.

direction'asc' | 'desc'

The sort direction. Defaults to desc.

created_beforestring

Only return ads created before this timestamp.

created_afterstring

Only return ads created after this timestamp.

stats_fromstring

Start of the stats window. Defaults to all-time.

stats_tostring

End of the stats window. Defaults to now.

time_zonestring

IANA timezone (e.g. America/New_York) the stats window is interpreted in. Bare stats_from/stats_to dates resolve to day boundaries on this clock. 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.

firstinteger

The number of ads to return.

afterstring

Cursor to fetch the page after (from page_info.end_cursor).

lastinteger

The number of ads to return from the end of the range.

beforestring

Cursor to fetch the page before (from page_info.start_cursor).

Response

ads listed

Example response

{
  "data": [
    {
      "call_to_action": "learn_more",
      "creatives": [
        {
          "format": "square"
        }
      ],
      "delivery_status": "rejected",
      "issues": [
        {
          "resource_type": "ad_campaign"
        }
      ],
      "lead_form": {
        "form_type": "more_volume",
        "questions": [
          {
            "options": [
              {
                "logic": {
                  "action": "go_to_question"
                }
              }
            ]
          }
        ]
      },
      "post_source": "facebook",
      "result_event": "purchase",
      "status": "active"
    }
  ]
}