Sign in
Campaigns V2

List Campaigns

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

get/v2/campaigns

Query parameters

limitstring

a string to be decoded into a number

Maximum number of items to return (1-100, default: 10)

starting_afterstring

a string to be decoded into a number

a string to be decoded into a number

ending_beforestring

a string to be decoded into a number

a string to be decoded into a number

application_idstring required

Filter by application ID (required)

Filter by application ID (required)

archived'true' | 'false'

a string to be decoded into a boolean

Include archived campaigns (default: false)

include_sort_metrics'true' | 'false'

a string to be decoded into a boolean

sort_metric'transactionCompletes'
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

Preset date range for included campaign sort metrics

sort_metrics_environment'PRODUCTION' | 'SANDBOX'

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

No recorded changes to this endpoint across all 1 revision of this API.