younifyd
Menu

Integration Get All Campaigns

List all running campaigns

GET/v1/integration/campaigns

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Integration Get All Campaigns action (under integration).
  3. Fill in the fields below, then reference the result from later steps as {{integrationGetAllCampaigns.response.data}}.

Request

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 50

skipinteger (int64)

The number of items to skip when paging through large result sets.

campaignIdsarray<string>

Filter by one or more campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned.

startAfterstring (date-time)

Filter results to only include campaigns that start on or after the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.

startBeforestring (date-time)

Filter results to only include campaigns that start on or before the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.

endAfterstring (date-time)

Filter results to only include campaigns that end on or after the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.

endBeforestring (date-time)

Filter results to only include campaigns that end on or before the specified timestamp. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.

Response

Returns 200 with an object. Read it in later steps with {{integrationGetAllCampaigns.response.data.<field>}}.

hasMoreboolean
dataarray<object>
idinteger (int64)required

Unique ID of Campaign.

applicationIdinteger (int64)required

The ID of the Application that owns this entity.

namestringrequired

A user-facing name for this campaign.

descriptionstring

A detailed description of the campaign.

startTimestring (date-time)

Timestamp when the campaign will become active.

endTimestring (date-time)

Timestamp when the campaign will become inactive.

attributesobject

Arbitrary properties associated with this campaign.

statestringrequired

The state of the campaign.

One ofenabledDefault "enabled"

tagsarray<string>required

A list of tags for the campaign.

featuresarray<string>required

The features enabled in this campaign.

json
{
  "hasMore": false,
  "data": [
    {
      "features": [
        "coupons",
        "referrals"
      ],
      "name": "Summer promotions",
      "description": "Campaign for all summer 2021 promotions",
      "startTime": {},
      "attributes": "{}",
      "id": 4,
      "endTime": {},
      "state": "enabled",
      "applicationId": 322,
      "tags": [
        "summer"
      ]
    }
  ]
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.