TAtalon
Campaigns

List campaigns that match the given attributes

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Get a list of all the campaigns that match a set of attributes.

post/v1/applications/{applicationId}/campaigns_search

Request

Path parameters

applicationIdinteger required

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

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

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.

campaignState'enabled' | 'disabled' | 'archived' | 'scheduled' | 'running' | 'expired' | 'staged'

Filter results by the state of the campaign.

  • enabled: Campaigns that are scheduled, running (active), or expired.
  • running: Campaigns that are running (active).
  • disabled: Campaigns that are disabled.
  • expired: Campaigns that are expired.
  • archived: Campaigns that are archived.

Request body

attributesobject required

Properties to match against a campaign. All provided attributes will be exactly matched against campaign attributes.

Response

OK

totalResultSizeinteger required

Example response

{
  "totalResultSize": 1,
  "data": [
    {
      "id": 4,
      "created": "2020-06-10T09:05:27.993483Z",
      "applicationId": 322,
      "userId": 388,
      "name": "Summer promotions",
      "description": "Campaign for all summer 2021 promotions",
      "startTime": "2021-07-20T22:00:00Z",
      "endTime": "2021-09-22T22:00:00Z",
      "state": "enabled",
      "activeRulesetId": 6,
      "tags": [
        "summer"
      ],
      "reevaluateOnReturn": true,
      "features": [
        "coupons",
        "referrals"
      ],
      "couponSettings": {
        "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"
        ],
        "couponPattern": "SUMMER-####-####"
      },
      "referralSettings": {
        "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"
        ],
        "couponPattern": "SUMMER-####-####"
      },
      "limits": [
        {
          "action": "createCoupon",
          "limit": 1000,
          "period": "yearly",
          "entities": [
            "Coupon"
          ]
        }
      ],
      "campaignGroups": [
        1,
        3
      ],
      "type": "advanced",
      "linkedStoreIds": [
        1,
        2,
        3
      ],
      "budgets": [
        {
          "action": "createCoupon",
          "limit": 1000,
          "counter": 42
        }
      ],
      "couponRedemptionCount": 163,
      "referralRedemptionCount": 3,
      "discountCount": 288,
      "discountEffectCount": 343,
      "couponCreationCount": 16,
      "referralCreationCount": 8,
      "awardedGiveawaysCount": 9,
      "createdLoyaltyPointsCount": 9,
      "createdLoyaltyPointsEffectCount": 2,
      "redeemedLoyaltyPointsCount": 8,
      "redeemedLoyaltyPointsEffectCount": 9,
      "reservecouponEffectCount": 9,
      "lastActivity": "2022-11-10T23:00:00Z",
      "updated": "2022-10-27T15:00:00Z",
      "createdBy": "John Doe",
      "updatedBy": "Jane Doe",
      "templateId": 3,
      "frontendState": "running",
      "storesImported": true,
      "valueMapsIds": [
        100,
        215
      ],
      "experimentId": 1,
      "revisionFrontendState": "revised",
      "activeRevisionId": 6,
      "activeRevisionVersionId": 6,
      "version": 6,
      "currentRevisionId": 6,
      "currentRevisionVersionId": 6
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.