younifyd
Menu

Get Campaigns

List campaigns

GET/v1/applications/{applicationId}/campaigns

Use it in a workflow

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

Request

Path parameters

applicationIdinteger (int64)required

The ID of the Application. It is displayed in your Talon.One deployment URL.

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

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

sortstring

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:** You may not be able to use all fields for sorting. This is due to performance limitations.

campaignStatestring

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.

One ofenableddisabledarchivedscheduledrunningexpiredstaged

namestring

Filter results performing case-insensitive matching against the name of the campaign.

tagsstring

Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the "name" query parameter, a logical OR will be performed to search both tags and name for the provided values

createdBeforestring (date-time)

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

createdAfterstring (date-time)

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

startBeforestring (date-time)

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign start time timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

startAfterstring (date-time)

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign start time timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

endBeforestring (date-time)

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign end time timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

endAfterstring (date-time)

Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign end time timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.

campaignGroupIdinteger (int64)

Filter results to campaigns owned by the specified campaign access group ID.

templateIdinteger (int64)

The ID of the campaign template this campaign was created from.

storeIdinteger (int64)

Filter results to campaigns linked to the specified store ID.

Response

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

totalResultSizeinteger (int64)
dataarray<object>
idinteger (int64)required

Unique ID for this entity.

createdstring (date-time)required

The exact moment this entity was created.

applicationIdinteger (int64)required

The ID of the Application that owns this entity.

userIdinteger (int64)required

The ID of the user associated with this entity.

namestringrequired

A user-facing name for this campaign.

descriptionstringrequired

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

A disabled or archived campaign is not evaluated for rules or coupons.

One ofenableddisabledarchivedDefault "enabled"

activeRulesetIdinteger (int64)

[ID of Ruleset](https://docs.talon.one/management-api#tag/Campaigns/operation/getRulesets) this campaign applies on customer session evaluation.

tagsarray<string>required

A list of tags for the campaign.

reevaluateOnReturnbooleanrequired

Indicates whether this campaign should be reevaluated when a customer returns an item.

featuresarray<string>required

The features enabled in this campaign.

couponSettingsobject2 fields
referralSettingsobject2 fields
limitsarray<object>required4 fields

The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign.

campaignGroupsarray<integer (int64)>

The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to.

typestringrequired

The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items.

One ofcartItemadvancedDefault "advanced"

linkedStoreIdsarray<integer (int64)>

A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store.

couponAttributesobject

Arbitrary properties associated with coupons in this campaign.

budgetsarray<object>3 fields

A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined.

couponRedemptionCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign.

referralRedemptionCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign.

discountCountnumber

This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign.

discountEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign.

couponCreationCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign.

customEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign.

referralCreationCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign.

addFreeItemEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign.

awardedGiveawaysCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign.

createdLoyaltyPointsCountnumber

This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign.

createdLoyaltyPointsEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign.

redeemedLoyaltyPointsCountnumber

This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign.

redeemedLoyaltyPointsEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign.

callApiEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign.

reservecouponEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign.

lastActivitystring (date-time)

Timestamp of the most recent event received by this campaign.

updatedstring (date-time)

Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates.

createdBystring

Name of the user who created this campaign if available.

json
{
  "totalResultSize": 1,
  "data": [
    {
      "type": "advanced",
      "templateId": 3,
      "customEffectCount": 0,
      "activeRevisionId": 6,
      "features": [
        "coupons",
        "referrals"
      ],
      "createdLoyaltyPointsCount": 9,
      "storesImported": true,
      "couponSettings": {
        "couponPattern": "SUMMER-####-####",
        "validCharacters": [
          "A",
          "B",
          "C",
          "D",
          "E",
          "F",
          "G",
          "H",
          "I",
          "J",
          "K",
          "L",
          "M",
          "N",
          "O",
          "P",
          "Q",
          "R",
          "S",
          "T",
          "U",
          "V",
          "W",
          "X",
          "Y",
          "Z",
          "0",
          "1",
          "2",
          "3",
          "4",
          "5",
          "6",
          "7",
          "8",
          "9"
        ]
      },
      "experimentId": 1,
      "id": 4,
      "state": "enabled",
      "couponAttributes": "{}",
      "reservecouponEffectCount": 9,
      "updatedBy": "Jane Doe",
      "frontendState": "running",
      "created": {},
      "referralCreationCount": 8,
      "stageRevision": false,
      "couponRedemptionCount": 163,
      "couponCreationCount": 16,
      "version": 6,
      "campaignGroups": [
        1,
        3
      ],
      "tags": [
        "summer"
      ],
      "discountEffectCount": 343,
      "budgets": [
        {
          "limit": 1000,
          "action": "createCoupon",
          "counter": 42
        },
        {
          "limit": 1000,
          "action": "createCoupon",
          "counter": 42
        }
      ],
      "redeemedLoyaltyPointsCount": 8,
      "name": "Summer promotions",
      "valueMapsIds": [
        100,
        215
      ],
      "applicationId": 322,
      "updated": {},
      "callApiEffectCount": 0,
      "createdLoyaltyPointsEffectCount": 2,
      "discountCount": 288,
      "revisionFrontendState": "revised",
      "description": "Campaign for all summer 2021 promotions",
      "activeRevisionVersionId": 6,
      "currentRevisionVersionId": 6,
      "startTime": {},
      "currentRevisionId": 6,
      "limits": [
        {
          "period": "yearly",
          "entities": [
            "Coupon"
          ],
          "limit": 1000,
          "action": "createCoupon"
        },
        {
          "period": "yearly",
          "entities": [
            "Coupon"
          ],
          "limit": 1000,
          "action": "createCoupon"
        }
      ],
      "activeRulesetId": 6,
      "reevaluateOnReturn": true,
      "userId": 388,
      "awardedGiveawaysCount": 9,
      "redeemedLoyaltyPointsEffectCount": 9,
      "linkedStoreIds": [
        1,
        2,
        3
      ],
      "createdBy": "John Doe",
      "addFreeItemEffectCount": 0,
      "referralSettings": {
        "couponPattern": "SUMMER-####-####",
        "validCharacters": [
          "A",
          "B",
          "C",
          "D",
          "E",
          "F",
          "G",
          "H",
          "I",
          "J",
          "K",
          "L",
          "M",
          "N",
          "O",
          "P",
          "Q",
          "R",
          "S",
          "T",
          "U",
          "V",
          "W",
          "X",
          "Y",
          "Z",
          "0",
          "1",
          "2",
          "3",
          "4",
          "5",
          "6",
          "7",
          "8",
          "9"
        ]
      },
      "attributes": "{}",
      "lastActivity": {},
      "endTime": {},
      "referralRedemptionCount": 3
    }
  ]
}

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

Get Campaigns — Talon.One — Documentation