List ads

GET

/ads

GET

/api/v1/ads

curl https://api.whop.com/api/v1/ads \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "ad_campaign": {
        "id": "adcamp_xxxxxxxxxxx"
      },
      "ad_group": {
        "id": "adgrp_xxxxxxxxxxxx"
      },
      "click_through_rate": 6.9,
      "clicks": 42,
      "cost_per_click": 6.9,
      "cost_per_lead": 6.9,
      "cost_per_mille": 6.9,
      "cost_per_purchase": 6.9,
      "cost_per_result": 6.9,
      "created_at": "2023-12-01T05:00:00.401Z",
      "frequency": 6.9,
      "id": "ad_xxxxxxxxxxxxxxx",
      "impressions": 42,
      "issues": [
        {
          "created_at": "2023-12-01T05:00:00.401Z",
          "error_code": "string",
          "error_message": "string",
          "error_summary": "string",
          "resolution_status": "open",
          "resource_id": "string",
          "resource_type": "string"
        }
      ],
      "leads": 42,
      "platform": "meta",
      "purchase_value": 6.9,
      "purchases": 42,
      "reach": 42,
      "return_on_ad_spend": 6.9,
      "spend": 6.9,
      "spend_currency": "usd",
      "status": "active",
      "title": "string",
      "unique_click_through_rate": 6.9,
      "unique_clicks": 42,
      "updated_at": "2023-12-01T05:00:00.401Z"
    }
  ],
  "page_info": {
    "end_cursor": "string",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "string"
  }
}

List ads scoped by ad group, campaign, or company.

Required permissions:

ad_campaign:basic:read

Authentication

AuthorizationBearer

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 ***************************

Query parameters

afterstring or nullOptional

beforestring or nullOptional

firstinteger or nullOptional

lastinteger or nullOptional

ad_campaign_idslist of strings or nullOptional

ad_group_idstring or nullOptional

ad_group_idslist of strings or nullOptional

company_idstring or nullOptional

created_afterdatetime or nullOptional

created_beforedatetime or nullOptional

directionenum or nullOptional

The direction of the sort.

Allowed values:

orderenum or nullOptional

The fields ad resources can be ordered by.

Allowed values:

querystring or nullOptional

stats_fromdatetime or nullOptional

stats_todatetime or nullOptional

statusenum or nullOptional

The status of an external ad.

campaign_idstring or nullOptional

order_byenum or nullOptional

Columns that the listAds query can sort by. Deprecated — use AdOrder.

Allowed values:

order_directionenum or nullOptional

The direction of the sort.

Allowed values:

ad_campaign_idstring or nullOptional

Response

A successful response

datalist of objects

A list of nodes.

page_infoobject

Information to aid in pagination.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error