> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve ad report > Performance report for a company, ad campaigns, ad groups, or ads. Always returns aggregate `summary` totals summed across the scope. Set `granularity` to additionally get a time series, or set `breakdown` (`campaign`/`ad_group`/`ad`) to additionally get per-entity rows inside the requested scope. Exactly one of `companyId`, `adCampaignIds`, `adGroupIds`, or `adIds` must be provided. Required permissions: - `ad_campaign:stats:read` ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/whopsdk/openapi.documented.yml get /ad_reports openapi: 3.1.0 info: title: Whop API description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ version: 1.0.0 x-api-version-date: '2026-06-09' servers: - url: https://api.whop.com/api/v1 description: Production Whop API - url: https://sandbox-api.whop.com/api/v1 description: Sandbox Whop API security: [] tags: - name: Products description: Products - name: Payments description: Payments - name: Refunds description: Refunds - name: Disputes description: Disputes - name: Dispute alerts description: Dispute alerts - name: Resolution center cases description: Resolution center cases - name: Checkout configurations description: Checkout configurations - name: Setup intents description: Setup intents - name: Payment methods description: Payment methods - name: Invoices description: Invoices - name: Promo codes description: Promo codes - name: Card transactions description: Card transactions - name: Ledger accounts description: Ledger accounts - name: Transfers description: Transfers - name: Withdrawals description: Withdrawals - name: Payout methods description: Payout methods - name: Verifications description: Verifications - name: Identity profiles description: Identity profiles - name: Payout accounts description: Payout accounts - name: Topups description: Topups - name: Companies description: Companies - name: Authorized users description: Authorized users - name: Fee markups description: Fee markups - name: Members description: Members - name: Memberships description: Memberships - name: Leads description: Leads - name: Entries description: Entries - name: Shipments description: Shipments - name: Reviews description: Reviews - name: Company token transactions description: Company token transactions - name: Affiliates description: Affiliates - name: Experiences description: Experiences - name: Forums description: Forums - name: Forum posts description: Forum posts - name: Chat channels description: Chat channels - name: Support channels description: Support channels - name: Messages description: Messages - name: Reactions description: Reactions - name: Dm members description: Dm members - name: Dm channels description: Dm channels - name: Notifications description: Notifications - name: Courses description: Courses - name: Course chapters description: Course chapters - name: Course lessons description: Course lessons - name: Course students description: Course students - name: Course lesson interactions description: Course lesson interactions - name: Apps description: Apps - name: Webhooks description: Webhooks - name: App builds description: App builds - name: Access tokens description: Access tokens - name: Account links description: Account links - name: Files description: Files - name: Ai chats description: Ai chats - name: Bounties description: Bounties - name: Stats description: Stats - name: Ad campaigns description: Ad campaigns - name: Ad groups description: Ad groups - name: Ads description: Ads - name: Conversions description: Conversions - name: Ad reports description: Ad reports paths: /ad_reports: get: tags: - Ad reports summary: Retrieve ad report description: >- Performance report for a company, ad campaigns, ad groups, or ads. Always returns aggregate `summary` totals summed across the scope. Set `granularity` to additionally get a time series, or set `breakdown` (`campaign`/`ad_group`/`ad`) to additionally get per-entity rows inside the requested scope. Exactly one of `companyId`, `adCampaignIds`, `adGroupIds`, or `adIds` must be provided. Required permissions: - `ad_campaign:stats:read` operationId: retrieveAdReport parameters: - name: ad_campaign_ids in: query required: false schema: type: - array - 'null' items: type: string description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. description: >- Scope the report to these ad campaigns (max 100); stats are summed across them. Mutually exclusive with `companyId`, `adGroupIds`, and `adIds`. explode: true style: form - name: ad_group_ids in: query required: false schema: type: - array - 'null' items: type: string description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. description: >- Scope the report to these ad groups (max 100); stats are summed across them. Mutually exclusive with `companyId`, `adCampaignIds`, and `adIds`. explode: true style: form - name: ad_ids in: query required: false schema: type: - array - 'null' items: type: string description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. description: >- Scope the report to these ads (max 100); stats are summed across them. Mutually exclusive with `companyId`, `adCampaignIds`, and `adGroupIds`. explode: true style: form - name: breakdown in: query required: false schema: oneOf: - $ref: '#/components/schemas/AdReportBreakdownLevels' - type: 'null' description: >- Entity level to break down the report by. When set, `breakdown` on the response contains one row per entity at the requested level inside the requested scope. `ad` returns one row per ad, `ad_group` per ad group, `campaign` per ad campaign. The breakdown level must be at or below the scope (e.g. `adId` cannot be broken down by `campaign`). The `summary` totals are unaffected. explode: true style: form - name: company_id in: query required: false schema: type: - string - 'null' description: >- The unique identifier of a company. Mutually exclusive with `adCampaignIds`, `adGroupIds`, and `adIds`. Use with `breakdown` to fan out across every campaign, ad group, or ad in the company without paging. example: biz_xxxxxxxxxxxxxx explode: true style: form - name: currency in: query required: false schema: type: - string - 'null' description: >- ISO 4217 currency code to report `spend` in. Defaults to the company's ads reporting currency. explode: true style: form - name: from in: query required: true schema: type: string format: date-time description: Inclusive start of the reporting window. example: '2023-12-01T05:00:00.401Z' explode: true style: form - name: granularity in: query required: false schema: oneOf: - $ref: '#/components/schemas/Granularities' - type: 'null' description: >- Bucket grain for the per-bucket `granularity` time series. Omit (`null`) for summary-only. `hourly`/`daily` max 90 days, `weekly` max 366 days, `monthly` max 4 years. The `summary` totals are unaffected. With `breakdown`, each row gets its own series at the same grain. explode: true style: form - name: to in: query required: true schema: type: string format: date-time description: Inclusive end of the reporting window. example: '2023-12-01T05:00:00.401Z' explode: true style: form responses: '200': description: A successful response content: application/json: schema: $ref: '#/components/schemas/AdReport' '400': description: Bad request content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: invalid_request_error code: parameter_missing message: 'Missing required parameter: amount.' param: amount '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: unauthorized message: Invalid or missing API key '403': description: Forbidden content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: forbidden message: You do not have permission to access this resource '404': description: Not found content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: not_found message: Resource not found '422': description: Verification required content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: null '500': description: Internal server error content: application/json: schema: type: object properties: error: type: object properties: type: type: string message: type: string code: type: - string - 'null' description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' param: type: - string - 'null' description: The parameter that caused the error, if applicable required: - type - message required: - error example: error: type: internal_server_error message: An unexpected error occurred security: - bearerAuth: - ad_campaign:stats:read x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); const adReport = await client.adReports.retrieve({ from: '2023-12-01T05:00:00.401Z', to: '2023-12-01T05:00:00.401Z', }); console.log(adReport.breakdown); - lang: Python source: |- import os from datetime import datetime from whop_sdk import Whop client = Whop( api_key=os.environ.get("WHOP_API_KEY"), # This is the default and can be omitted ) ad_report = client.ad_reports.retrieve( from_=datetime.fromisoformat("2023-12-01T05:00:00.401"), to=datetime.fromisoformat("2023-12-01T05:00:00.401"), ) print(ad_report.breakdown) - lang: Ruby source: >- require "whop_sdk" whop = WhopSDK::Client.new(api_key: "My API Key") ad_report = whop.ad_reports.retrieve(from: "2023-12-01T05:00:00.401Z", to: "2023-12-01T05:00:00.401Z") puts(ad_report) components: schemas: AdReportBreakdownLevels: type: string enum: - campaign - ad_group - ad description: Entity level to group an ad report by. Granularities: type: string enum: - hourly - daily - weekly - monthly description: Bucket size for external ad stat rows. AdReport: type: object properties: summary: type: object properties: clicks: type: integer description: Total clicks over the date range. example: 42 impressions: type: integer description: Total impressions over the date range. example: 42 reach: type: integer description: Unique users reached, deduplicated by the external ad platform. example: 42 spend: type: number description: >- Total spend over the date range in the requested reporting currency. example: 6.9 spend_currency: oneOf: - $ref: '#/components/schemas/Currencies' - type: 'null' description: >- Currency of the `spend` value. Matches the requested `currency` when set. click_through_rate: type: number description: Click-through rate (clicks / impressions). example: 6.9 cost_per_click: type: number description: Cost per click in the requested reporting currency. example: 6.9 cost_per_mille: type: - number - 'null' description: >- Cost per thousand impressions in the requested reporting currency. example: 6.9 frequency: type: - number - 'null' description: Average number of times each reached user saw an ad. example: 6.9 result_count: type: - integer - 'null' description: >- Count of the campaign's primary optimization result (purchases, clicks, etc.) — see `resultLabelKey`. example: 42 result_label_key: oneOf: - $ref: '#/components/schemas/ResultLabelKeys' - type: 'null' description: The type of optimization result represented by `resultCount`. result_label_override: type: - string - 'null' description: >- Advertiser-defined label for the result when `resultLabelKey` is `custom`. cost_per_result: type: - number - 'null' description: Spend divided by `resultCount`. Null when there are no results. example: 6.9 return_on_ad_spend: type: - number - 'null' description: >- Alias for `purchaseReturnOnAdSpend` — return on ad spend for purchases, as reported by the external ad platform. example: 6.9 required: - clicks - impressions - reach - spend - spend_currency - click_through_rate - cost_per_click - cost_per_mille - frequency - result_count - result_label_key - result_label_override - cost_per_result - return_on_ad_spend description: Aggregate totals and rates over the date range. granularity: type: - array - 'null' items: type: object properties: bucket_start: type: string format: date-time description: >- The bucket's start time as a real UTC instant. `(statDate, statHour)` resolved in the ad account's reporting timezone — render this in the viewer's local timezone. example: '2023-12-01T05:00:00.401Z' stat_date: type: string format: date-time description: >- The date these stats cover (midnight UTC). For hourly rows, see `statHour` and `bucketStart`. example: '2023-12-01T05:00:00.401Z' stat_hour: type: - integer - 'null' description: >- Hour of the day in the ad account's reporting timezone (0-23). `null` for daily rows. example: 42 granularity: $ref: '#/components/schemas/Granularities' description: >- The bucket size of this row (`hourly`, `daily`, `weekly`, or `monthly`). spend: type: number description: >- Charged spend in this bucket in the requested reporting currency — the amount billed including platform fees, not the platform-side net spend. example: 6.9 spend_currency: $ref: '#/components/schemas/Currencies' description: Currency of the `spend` value. impressions: type: integer description: Impressions in this bucket. example: 42 clicks: type: integer description: Clicks in this bucket. example: 42 reach: type: integer description: >- Unique users reached in this bucket. Always `0` for hourly rows (Meta does not return reach at hourly grain). example: 42 result_count: type: - integer - 'null' description: Count of the primary optimization result in this bucket. example: 42 result_label_key: oneOf: - $ref: '#/components/schemas/ResultLabelKeys' - type: 'null' description: The type of optimization result represented by `resultCount`. result_label_override: type: - string - 'null' description: >- Advertiser-defined label for the result when `resultLabelKey` is `custom`. required: - bucket_start - stat_date - stat_hour - granularity - spend - spend_currency - impressions - clicks - reach - result_count - result_label_key - result_label_override description: >- Per-bucket ad performance for an ad campaign, ad group, or ad. Bucket grain is set by the `ad_report` query's `granularity` argument. description: >- Per-bucket time series over the date range, ordered ascending by `bucketStart`. `null` when the `granularity` arg on `adReport` is omitted; otherwise contains rows at the requested grain (`daily` or `hourly`). breakdown: type: - array - 'null' items: type: object properties: id: type: string description: Tag of the entity (ad campaign, ad group, or ad). name: type: - string - 'null' description: Display name of the entity, when available. level: $ref: '#/components/schemas/AdReportBreakdownLevels' description: The entity level of this row — matches the `breakdown` arg. summary: type: object properties: clicks: type: integer description: Total clicks over the date range. example: 42 impressions: type: integer description: Total impressions over the date range. example: 42 reach: type: integer description: >- Unique users reached, deduplicated by the external ad platform. example: 42 spend: type: number description: >- Total spend over the date range in the requested reporting currency. example: 6.9 spend_currency: oneOf: - $ref: '#/components/schemas/Currencies' - type: 'null' description: >- Currency of the `spend` value. Matches the requested `currency` when set. click_through_rate: type: number description: Click-through rate (clicks / impressions). example: 6.9 cost_per_click: type: number description: Cost per click in the requested reporting currency. example: 6.9 cost_per_mille: type: - number - 'null' description: >- Cost per thousand impressions in the requested reporting currency. example: 6.9 frequency: type: - number - 'null' description: Average number of times each reached user saw an ad. example: 6.9 result_count: type: - integer - 'null' description: >- Count of the campaign's primary optimization result (purchases, clicks, etc.) — see `resultLabelKey`. example: 42 result_label_key: oneOf: - $ref: '#/components/schemas/ResultLabelKeys' - type: 'null' description: >- The type of optimization result represented by `resultCount`. result_label_override: type: - string - 'null' description: >- Advertiser-defined label for the result when `resultLabelKey` is `custom`. cost_per_result: type: - number - 'null' description: >- Spend divided by `resultCount`. Null when there are no results. example: 6.9 return_on_ad_spend: type: - number - 'null' description: >- Alias for `purchaseReturnOnAdSpend` — return on ad spend for purchases, as reported by the external ad platform. example: 6.9 required: - clicks - impressions - reach - spend - spend_currency - click_through_rate - cost_per_click - cost_per_mille - frequency - result_count - result_label_key - result_label_override - cost_per_result - return_on_ad_spend description: >- Aggregate totals and rates for this entity over the date range. granularity: type: - array - 'null' items: type: object properties: bucket_start: type: string format: date-time description: >- The bucket's start time as a real UTC instant. `(statDate, statHour)` resolved in the ad account's reporting timezone — render this in the viewer's local timezone. example: '2023-12-01T05:00:00.401Z' stat_date: type: string format: date-time description: >- The date these stats cover (midnight UTC). For hourly rows, see `statHour` and `bucketStart`. example: '2023-12-01T05:00:00.401Z' stat_hour: type: - integer - 'null' description: >- Hour of the day in the ad account's reporting timezone (0-23). `null` for daily rows. example: 42 granularity: $ref: '#/components/schemas/Granularities' description: >- The bucket size of this row (`hourly`, `daily`, `weekly`, or `monthly`). spend: type: number description: >- Charged spend in this bucket in the requested reporting currency — the amount billed including platform fees, not the platform-side net spend. example: 6.9 spend_currency: $ref: '#/components/schemas/Currencies' description: Currency of the `spend` value. impressions: type: integer description: Impressions in this bucket. example: 42 clicks: type: integer description: Clicks in this bucket. example: 42 reach: type: integer description: >- Unique users reached in this bucket. Always `0` for hourly rows (Meta does not return reach at hourly grain). example: 42 result_count: type: - integer - 'null' description: Count of the primary optimization result in this bucket. example: 42 result_label_key: oneOf: - $ref: '#/components/schemas/ResultLabelKeys' - type: 'null' description: >- The type of optimization result represented by `resultCount`. result_label_override: type: - string - 'null' description: >- Advertiser-defined label for the result when `resultLabelKey` is `custom`. required: - bucket_start - stat_date - stat_hour - granularity - spend - spend_currency - impressions - clicks - reach - result_count - result_label_key - result_label_override description: >- Per-bucket ad performance for an ad campaign, ad group, or ad. Bucket grain is set by the `ad_report` query's `granularity` argument. description: >- Per-bucket time series for this entity over the date range, ordered ascending by `bucketStart`. `null` when the `granularity` arg on `adReport` is omitted; otherwise contains rows at the requested grain (`daily` or `hourly`). required: - id - name - level - summary - granularity description: >- Per-entity ad performance row. Returned when the `breakdown` arg on `adReport` is set. description: >- Per-entity rows over the date range. `null` when the `breakdown` arg on `adReport` is omitted; otherwise contains one row per ad campaign, ad group, or ad inside the requested scope at the requested level. required: - summary - granularity - breakdown description: >- An ads performance report. Always returns a summary. The `granularity` field contains a per-bucket time series when the `granularity` arg is set; the `breakdown` field contains per-entity rows when the `breakdown` arg is set. Currencies: type: string enum: - usd - sgd - inr - aud - brl - cad - dkk - eur - nok - gbp - sek - chf - hkd - huf - jpy - mxn - myr - pln - czk - nzd - aed - eth - ape - cop - ron - thb - bgn - idr - dop - php - try - krw - twd - vnd - pkr - clp - uyu - ars - zar - dzd - tnd - mad - kes - kwd - jod - all - xcd - amd - bsd - bhd - bob - bam - khr - crc - xof - egp - etb - gmd - ghs - gtq - gyd - ils - jmd - mop - mga - mur - mdl - mnt - nad - ngn - mkd - omr - pyg - pen - qar - rwf - sar - rsd - lkr - tzs - ttd - uzs - rub - btc - cny - usdt - kzt - awg - whop_usd - xau description: The available currencies on the platform ResultLabelKeys: type: string enum: - app_installs - messaging_conversations_started - post_engagement - event_responses - impressions - website_purchases - landing_page_views - leads - link_clicks - quality_calls - appointments_booked - messaging_purchases - page_likes - instagram_profile_visits - reach - reminders_set - new_subscribers - video_views - registrations - content_views - searches - website_schedules - website_submit_applications - custom description: Types of optimization results tracked from external ad platforms securitySchemes: bearerAuth: type: http description: >- 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 ***************************` scheme: bearer bearerFormat: auth-scheme ````