younifyd
Menu

Get Campaign

Get campaign

GET/v1/applications/{applicationId}/campaigns/{campaignId}

Use it in a workflow

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

Request

Path parameters

applicationIdinteger (int64)required

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

campaignIdinteger (int64)required

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

Response

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

idinteger (int64)

Unique ID for this entity.

createdstring (date-time)

The exact moment this entity was created.

applicationIdinteger (int64)

The ID of the Application that owns this entity.

userIdinteger (int64)

The ID of the user associated with this entity.

namestring

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.

statestring

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>

A list of tags for the campaign.

reevaluateOnReturnboolean

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

featuresarray<string>

The features enabled in this campaign.

couponSettingsobject
validCharactersarray<string>required

List of characters used to generate the random parts of a code.

couponPatternstringrequired

The pattern used to generate codes, such as coupon codes, referral codes, and loyalty cards. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set.

referralSettingsobject
validCharactersarray<string>required

List of characters used to generate the random parts of a code.

couponPatternstringrequired

The pattern used to generate codes, such as coupon codes, referral codes, and loyalty cards. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set.

limitsarray<object>

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

actionstringrequired

The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon`

limitnumberrequired

The value to set for the limit.

periodstring

The period on which the budget limit recurs.

One ofdailyweeklymonthlyyearly

entitiesarray<string>required

The entity that this limit applies to.

campaignGroupsarray<integer (int64)>

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

typestring

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>

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.

actionstringrequired

The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon`

limitnumberrequired

The value to set for the limit.

counternumberrequired

The number of occurrences of the limited action in the context of the campaign.

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
{
  "id": 4,
  "created": {},
  "applicationId": 322,
  "userId": 388,
  "name": "Summer promotions",
  "description": "Campaign for all summer 2021 promotions",
  "state": "enabled",
  "tags": [
    "summer"
  ],
  "reevaluateOnReturn": true,
  "features": [
    "coupons",
    "referrals"
  ],
  "limits": [
    {
      "period": "yearly",
      "entities": [
        "Coupon"
      ],
      "limit": 1000,
      "action": "createCoupon"
    }
  ],
  "type": "advanced"
}

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