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

KeyDatatypeRequiredDescription
pageSizenumberThe number of items in this response.
skipnumberThe number of items to skip when paging through large result sets.
sortstringThe 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

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring