List campaigns that match the given attributes
POST {{baseUrl}}/v1/applications/:applicationId/campaigns_search?pageSize=1000&skip=10&sort=value&campaignState=expired
Get a list of all the campaigns that match a set of attributes.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
pageSize | number | The number of items in this response. | |
skip | number | The number of items to skip when paging through large result sets. | |
sort | string | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with - . |
Note: This parameter works only with numeric fields.
|
| campaignState
| string | | Filter results by the state of the campaign.
enabled
: Campaigns that are scheduled, running (activated), or expired.running
: Campaigns that are running (activated).disabled
: Campaigns that are disabled.expired
: Campaigns that are expired.archived
: Campaigns that are archived.draft
: Campaigns that are drafts. |
Request Body
{"attributes"=>{"in__"=>false}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |