API ReferenceAnnouncementsCommunity Discussion
API ReferenceCommunity DiscussionAnnouncementsSubscribeLog In
API Reference

Overview

The combined audiences API allows you to create new audiences, by combining existing audiences from My Audiences and/or Marketplace Audiences.

End to end flow

  1. Obtain a list of available audiences to combine.

  2. Using the above IDs, build 1 or more audience components:

    1. Each audience component object consists of 1 or more IDs, with a given relation:
      AND / OR / NOT
    2. Sample objects:
      {
          "relation": "AND",
          "audiences_ids": [
              11,
              21,
              23
          ]
      }
      
      {
          "relation": "NOT",
          "audiences_ids": [
              12,
              22
          ]
      }
      
      {
          "relation": "OR",
          "audiences_ids": [
              13,
              23
          ]
      }
      
  3. Create a combined audience. The request object must contain the following fields:

    • audience_name

    • description

    • combined_audience_components - a collection of audience component objects.

      The system will combine these components via an AND operation. These combined components essentially define your combined audience.

      {
         "audience_name": "My audience name",
         "description": "My audience description",
         "combined_audience_components": [
             {
                 "relation": "AND",
                 "audiences_ids": [
                     11,
                     21,
                     23
                 ]
             },
             {
                 "relation": "NOT",
                 "audiences_ids": [
                     12,
                     22
                 ]
             },
             {
                 "relation": "OR",
                 "audiences_ids": [
                     13,
                     23
                 ]
             }
         ]
      }