SUsuperwall
Campaigns V2

List Campaigns

Changed on

Returns a list of campaigns for the specified application. Requires campaigns:read scope. The application_id query parameter is required.

get/v2/campaigns

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/campaigns
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Query parameters

limitstring
starting_afterstring

Cursor for forward pagination - returns items after this campaign ID

ending_beforestring

Cursor for backward pagination - returns items before this campaign ID

application_idstring required
archived'true' | 'false'
include_sort_metrics'true' | 'false'

Include lightweight, non-fatal analytics metrics used for list ordering

sort_metric'transactionCompletes'

Metric to include when include_sort_metrics is true

sort_metrics_date_preset'last_24_hours' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days' | 'last_180_days' | 'last_365_days' | 'year_to_date'

Preset date range for included campaign sort metrics

sort_metrics_fromstring

Custom window start for included sort metrics; requires sort_metrics_to

sort_metrics_tostring

Custom window end for included sort metrics; requires sort_metrics_from

sort_metrics_environment'PRODUCTION' | 'SANDBOX'

Environment used for included sort metrics

Response

Success

object'list' required

Object type, always list

url'/v2/campaigns' required

API endpoint URL for this list

has_moreboolean required

Whether there are more results available beyond this page

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

  • bfb85c07a3d3Revision changes
    • info

      added the optional property // to the response with the status