> ## 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 /openapi/api-v1-stable.json get /ad_reports openapi: 3.1.0 info: 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/ title: Whop API version: 1.0.0 x-api-version-date: 2026-07-08-1 servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: Products name: Products - description: Payments name: Payments - description: Refunds name: Refunds - description: Disputes name: Disputes - description: Dispute alerts name: Dispute alerts - description: Resolution center cases name: Resolution center cases - description: Checkout configurations name: Checkout configurations - description: Setup intents name: Setup intents - description: Payment methods name: Payment methods - description: Invoices name: Invoices - description: Promo codes name: Promo codes - description: Card transactions name: Card transactions - description: Ledger accounts name: Ledger accounts - description: Withdrawals name: Withdrawals - description: Payout methods name: Payout methods - description: Verifications name: Verifications - description: Identity profiles name: Identity profiles - description: Payout accounts name: Payout accounts - description: Topups name: Topups - description: Companies name: Companies - description: Authorized users name: Authorized users - description: Fee markups name: Fee markups - description: Members name: Members - description: Memberships name: Memberships - description: Leads name: Leads - description: Entries name: Entries - description: Shipments name: Shipments - description: Reviews name: Reviews - description: Company token transactions name: Company token transactions - description: Affiliates name: Affiliates - description: Experiences name: Experiences - description: Forums name: Forums - description: Forum posts name: Forum posts - description: Chat channels name: Chat channels - description: Support channels name: Support channels - description: Messages name: Messages - description: Reactions name: Reactions - description: Dm members name: Dm members - description: Dm channels name: Dm channels - description: Notifications name: Notifications - description: Courses name: Courses - description: Course chapters name: Course chapters - description: Course lessons name: Course lessons - description: Course students name: Course students - description: Course lesson interactions name: Course lesson interactions - description: Apps name: Apps - description: Webhooks name: Webhooks - description: App builds name: App builds - description: Access tokens name: Access tokens - description: Account links name: Account links - description: Files name: Files - description: Ai chats name: Ai chats - description: Bounties name: Bounties - description: Stats name: Stats - description: Conversions name: Conversions - description: Ad reports name: 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: - explode: true in: query name: ad_campaign_ids required: false schema: description: >- Scope the report to these ad campaigns (max 100); stats are summed across them. Mutually exclusive with `companyId`, `adGroupIds`, and `adIds`. items: 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. type: string type: - array - 'null' style: form - explode: true in: query name: ad_group_ids required: false schema: description: >- Scope the report to these ad groups (max 100); stats are summed across them. Mutually exclusive with `companyId`, `adCampaignIds`, and `adIds`. items: 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. type: string type: - array - 'null' style: form - explode: true in: query name: ad_ids required: false schema: description: >- Scope the report to these ads (max 100); stats are summed across them. Mutually exclusive with `companyId`, `adCampaignIds`, and `adGroupIds`. items: 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. type: string type: - array - 'null' style: form - explode: true in: query name: breakdown required: false schema: 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. oneOf: - $ref: '#/components/schemas/AdReportBreakdownLevels' - type: 'null' style: form - explode: true in: query name: company_id required: false schema: 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 type: - string - 'null' style: form - explode: true in: query name: currency required: false schema: description: >- ISO 4217 currency code to report `spend` in. Defaults to the company's ads reporting currency. type: - string - 'null' style: form - explode: true in: query name: from required: true schema: description: Inclusive start of the reporting window. example: '2023-12-01T05:00:00.401Z' format: date-time type: string style: form - explode: true in: query name: granularity required: false schema: 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. oneOf: - $ref: '#/components/schemas/Granularities' - type: 'null' style: form - explode: true in: query name: to required: true schema: description: Inclusive end of the reporting window. example: '2023-12-01T05:00:00.401Z' format: date-time type: string style: form responses: '200': content: application/json: schema: $ref: '#/components/schemas/AdReport' description: A successful response '400': content: application/json: example: error: code: parameter_missing message: 'Missing required parameter: amount.' param: amount type: invalid_request_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Bad request '401': content: application/json: example: error: message: Invalid or missing API key type: unauthorized schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Unauthorized '403': content: application/json: example: error: message: You do not have permission to access this resource type: forbidden schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Forbidden '404': content: application/json: example: error: message: Resource not found type: not_found schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Not found '422': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Verification required '429': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Too many requests '500': content: application/json: example: error: message: An unexpected error occurred type: internal_server_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Internal server error security: - bearerAuth: - ad_campaign:stats:read components: schemas: AdReportBreakdownLevels: description: Entity level to group an ad report by. enum: - campaign - ad_group - ad type: string Granularities: description: Bucket size for external ad stat rows. enum: - hourly - daily - weekly - monthly type: string AdReport: 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. properties: breakdown: 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. items: description: >- Per-entity ad performance row. Returned when the `breakdown` arg on `adReport` is set. properties: granularity: 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`). items: 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. properties: bucket_start: 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' format: date-time type: string clicks: description: Clicks in this bucket. example: 42 type: integer granularity: $ref: '#/components/schemas/Granularities' description: >- The bucket size of this row (`hourly`, `daily`, `weekly`, or `monthly`). impressions: description: Impressions in this bucket. example: 42 type: integer reach: description: >- Unique users reached in this bucket. Always `0` for hourly rows (Meta does not return reach at hourly grain). example: 42 type: integer result_count: description: Count of the primary optimization result in this bucket. example: 42 type: - integer - 'null' result_label_key: description: >- The type of optimization result represented by `resultCount`. oneOf: - $ref: '#/components/schemas/ResultLabelKeys' - type: 'null' result_label_override: description: >- Advertiser-defined label for the result when `resultLabelKey` is `custom`. type: - string - 'null' spend: 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 type: number spend_currency: $ref: '#/components/schemas/Currencies' description: Currency of the `spend` value. stat_date: description: >- The date these stats cover (midnight UTC). For hourly rows, see `statHour` and `bucketStart`. example: '2023-12-01T05:00:00.401Z' format: date-time type: string stat_hour: description: >- Hour of the day in the ad account's reporting timezone (0-23). `null` for daily rows. example: 42 type: - integer - 'null' required: - bucket_start - stat_date - stat_hour - granularity - spend - spend_currency - impressions - clicks - reach - result_count - result_label_key - result_label_override type: object type: - array - 'null' id: description: Tag of the entity (ad campaign, ad group, or ad). type: string level: $ref: '#/components/schemas/AdReportBreakdownLevels' description: The entity level of this row — matches the `breakdown` arg. name: description: Display name of the entity, when available. type: - string - 'null' summary: description: >- Aggregate totals and rates for this entity over the date range. properties: click_through_rate: description: Click-through rate (clicks / impressions). example: 6.9 type: number clicks: description: Total clicks over the date range. example: 42 type: integer cost_per_click: description: Cost per click in the requested reporting currency. example: 6.9 type: number cost_per_mille: description: >- Cost per thousand impressions in the requested reporting currency. example: 6.9 type: - number - 'null' cost_per_result: description: >- Spend divided by `resultCount`. Null when there are no results. example: 6.9 type: - number - 'null' frequency: description: Average number of times each reached user saw an ad. example: 6.9 type: - number - 'null' impressions: description: Total impressions over the date range. example: 42 type: integer reach: description: >- Unique users reached, deduplicated by the external ad platform. example: 42 type: integer result_count: description: >- Count of the campaign's primary optimization result (purchases, clicks, etc.) — see `resultLabelKey`. example: 42 type: - integer - 'null' result_label_key: description: >- The type of optimization result represented by `resultCount`. oneOf: - $ref: '#/components/schemas/ResultLabelKeys' - type: 'null' result_label_override: description: >- Advertiser-defined label for the result when `resultLabelKey` is `custom`. type: - string - 'null' return_on_ad_spend: description: >- Alias for `purchaseReturnOnAdSpend` — return on ad spend for purchases, as reported by the external ad platform. example: 6.9 type: - number - 'null' spend: description: >- Total spend over the date range in the requested reporting currency. example: 6.9 type: number spend_currency: description: >- Currency of the `spend` value. Matches the requested `currency` when set. oneOf: - $ref: '#/components/schemas/Currencies' - type: 'null' 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 type: object required: - id - name - level - summary - granularity type: object type: - array - 'null' granularity: 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`). items: 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. properties: bucket_start: 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' format: date-time type: string clicks: description: Clicks in this bucket. example: 42 type: integer granularity: $ref: '#/components/schemas/Granularities' description: >- The bucket size of this row (`hourly`, `daily`, `weekly`, or `monthly`). impressions: description: Impressions in this bucket. example: 42 type: integer reach: description: >- Unique users reached in this bucket. Always `0` for hourly rows (Meta does not return reach at hourly grain). example: 42 type: integer result_count: description: Count of the primary optimization result in this bucket. example: 42 type: - integer - 'null' result_label_key: description: The type of optimization result represented by `resultCount`. oneOf: - $ref: '#/components/schemas/ResultLabelKeys' - type: 'null' result_label_override: description: >- Advertiser-defined label for the result when `resultLabelKey` is `custom`. type: - string - 'null' spend: 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 type: number spend_currency: $ref: '#/components/schemas/Currencies' description: Currency of the `spend` value. stat_date: description: >- The date these stats cover (midnight UTC). For hourly rows, see `statHour` and `bucketStart`. example: '2023-12-01T05:00:00.401Z' format: date-time type: string stat_hour: description: >- Hour of the day in the ad account's reporting timezone (0-23). `null` for daily rows. example: 42 type: - integer - 'null' required: - bucket_start - stat_date - stat_hour - granularity - spend - spend_currency - impressions - clicks - reach - result_count - result_label_key - result_label_override type: object type: - array - 'null' summary: description: Aggregate totals and rates over the date range. properties: click_through_rate: description: Click-through rate (clicks / impressions). example: 6.9 type: number clicks: description: Total clicks over the date range. example: 42 type: integer cost_per_click: description: Cost per click in the requested reporting currency. example: 6.9 type: number cost_per_mille: description: >- Cost per thousand impressions in the requested reporting currency. example: 6.9 type: - number - 'null' cost_per_result: description: Spend divided by `resultCount`. Null when there are no results. example: 6.9 type: - number - 'null' frequency: description: Average number of times each reached user saw an ad. example: 6.9 type: - number - 'null' impressions: description: Total impressions over the date range. example: 42 type: integer reach: description: Unique users reached, deduplicated by the external ad platform. example: 42 type: integer result_count: description: >- Count of the campaign's primary optimization result (purchases, clicks, etc.) — see `resultLabelKey`. example: 42 type: - integer - 'null' result_label_key: description: The type of optimization result represented by `resultCount`. oneOf: - $ref: '#/components/schemas/ResultLabelKeys' - type: 'null' result_label_override: description: >- Advertiser-defined label for the result when `resultLabelKey` is `custom`. type: - string - 'null' return_on_ad_spend: description: >- Alias for `purchaseReturnOnAdSpend` — return on ad spend for purchases, as reported by the external ad platform. example: 6.9 type: - number - 'null' spend: description: >- Total spend over the date range in the requested reporting currency. example: 6.9 type: number spend_currency: description: >- Currency of the `spend` value. Matches the requested `currency` when set. oneOf: - $ref: '#/components/schemas/Currencies' - type: 'null' 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 type: object required: - summary - granularity - breakdown type: object ResultLabelKeys: description: Types of optimization results tracked from external ad platforms 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 - adds_to_cart - adds_to_wishlist - adds_of_payment_info - checkouts_initiated - website_schedules - website_submit_applications - website_trials_started - website_subscriptions - website_contacts - website_donations - website_find_locations - website_product_customizations - custom type: string Currencies: description: The available currencies on the platform 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 type: string securitySchemes: bearerAuth: bearerFormat: auth-scheme 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 type: http ````