SUsuperwall
Campaigns V2

Audience Attribution Breakdown

Changed on

Per-variant paywall viewers, views, conversions, trial starts, paid users and proceeds grouped by install-attribution source (network, campaign, ad set, ad, or Apple Search Ads keyword) — the acquisition_* user attributes set by Superwall MMP, Apple Search Ads or another MMP. Each viewer counts toward their latest source within a variant; conversions and proceeds follow the converting user. Narrow to one network, campaign or ad set with the matching filter to drill down. Covers a trailing window of paywall views. Requires the private campaign_attribution feature flag and campaigns:read and charts:read scopes.

get/v2/campaigns/{id}/audiences/{audience_id}/attribution

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/campaigns/{id}/audiences/{audience_id}/attribution
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Path parameters

idstring required
audience_idstring required

Query parameters

environment'PRODUCTION' | 'SANDBOX'
dimension'network' | 'campaign' | 'ad_set' | 'ad' | 'keyword'

Attribution level to group the audience's paywall viewers by. keyword applies to Apple Search Ads.

window'last_7_days' | 'last_30_days' | 'last_90_days'

Paywall-view window the breakdown covers

networkstring

Only count paywall views attributed to this network: a row's source_id from a breakdown by network. Combine with network to drill down.

campaignstring

Only count paywall views attributed to this campaign: a row's source_id from a breakdown by campaign. Combine with network to drill down.

ad_setstring

Only count paywall views attributed to this ad set: a row's source_id from a breakdown by ad set. Combine with network to drill down.

string
OR
string[]
refresh'true' | 'false'

Bypass the cached snapshot and force a fresh computation

Response

Audience results broken down by install-attribution source

object'audience_attribution' required
dimension'network' | 'campaign' | 'ad_set' | 'ad' | 'keyword' required

Attribution level to group the audience's paywall viewers by. keyword applies to Apple Search Ads.

window'last_7_days' | 'last_30_days' | 'last_90_days' required

Paywall-view window the breakdown covers

date_fromstring required

ISO start of the window

date_tostring required

ISO end of the window

computed_atnumber required
revalidatingboolean

True when the returned snapshot is stale and the server is recomputing it in the background; a later request returns the refreshed snapshot.

Changes

  • 778a11cd2c15Revision changes
    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status

  • f9828dcdf341Revision changes
    • info

      endpoint added