AMamperity
Campaigns

List campaigns

Return a list of campaigns from your tenant. You may restrict the list of campaigns to those associated with a specific data template.

get/campaigns

Request

Query parameters

api_versionstring

A supported version of the Amperity API. You may use the api-version request header instead of the api_version request parameter.

with_totalboolean

Set this value to true to include a total count of all results. Default value: false. Obtaining the total count of all results can be an expensive operation when there is a high number of pages in the results set.

limitinteger

The maximum number of records to include in a single page of results.

next_tokenstring

An opaque token that is used to paginate results. Omit the next_token property to return the first page. Use the cursor value for next_token that was returned in a response to view the next page of results. The value cannot be empty.

destination_data_template_idstring

Use this parameter to restrict the list of campaigns that are returned to only campaigns that are configured to use a specific data template. To find a data template's ID, open the Destinations page, open the menu in the row for the data template, and select Copy ID. A data template ID looks like ptg-2QLLqXBEq.

Headers

Amperity-Tenantstring required

The ID for the tenant to which a request will be sent.

Api-Versionstring required

A supported version of the Amperity API.

Response

List of campaigns

next_tokenstring

The cursor value to use in a subsequent request to return the next page of results.

totalinteger

The total count of all results. This property is only returned when with_total is set to true in a request.

Example response

{
  "data": [
    {
      "id": "cc-21HCWon6Y",
      "name": "Holiday Campaign"
    }
  ],
  "next_token": "ZVEy1iwsKBs9a6H"
}

Changes

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