API campaigns creation

Created: 26.04.2023

Updated: 08.11.2023

Author: Anastasia N.

Creating an API Campaign

When you click the "Create Campaign" button on the main screen, a new screen will open. Here you can configure your future campaign:

1. Rename the campaign.

2. Include a text comment (describing the campaign) and labels (for example, for categorizing campaigns by page type).

3. Change the campaign status.

The status can be Active, Draft, or Paused.

1. Specify the campaign selector, which you will later use in choose requests.

2. Specify the selector group name (it allows to call all selectors belonging to a group within a single choose request without listing each of them separately).

3. Choose the campaign type — Custom JSON or Recommendations.

4. Cancel or save changes.

5. Edit, duplicate, or delete experiences within the campaign.

Working with Experiences

On the experience creation screen, you can:

1. Provide an experience name.

2. Navigate to the subsection for creating variations and change the experience status.

3. Specify targeting conditions. More details: Targeting conditions definition and their applicability.

   1. Time targeting: when configuring targeting conditions, you can additionally specify the time and/or day of the week required for the user to fall into targeting. Additional intormation can be found by the link: When?

4. Save or discard changes.

Campaign Planning

To set a specific time frame for the experience, click "Set Schedule" in the field of the relevant experience:

In the opened pop-up, you can choose the:

1. Start and end date of the experience;

2. Exact start and end time of the experience;

3. Timezone - either section's or user's.

When choosing the start and end dates for the experience, select the desired date in the displayed calendar.

Creating a Variation

On the variations screen, you can:

1. Choose a testing method: A/B testing or Dynamic Allocation.

1. Select the primary metric:

1. Modify additional experience settings: variation selection frequency for users as well as start and end of the attribution window.

1. Click "Add New Variation" button to create a variation either from scratch or by using existing templates.

2. Set the weight of the variation. The sum of the weights specified for variations should always be 100%.

1. Clicking the "pencil" icon enters variation editing mode.

2. Clicking the "three dots" icon opens an additional menu allowing you to duplicate or delete the variation.

1. Clicking the "Cancel" button cancels the changes you’ve made, clicking the "Save Experience" button saves the changes you’ve made (please note that no changes are saved in a campaign unit you save or publish the campaign).

Creating and Editing Variation Code

On the variation editing screen, you can:

• In Custom JSON campaigns, specify custom JSON. It will be passed in an API-call in response to a request to choose endpoint.

• In Recommendations campaigns, choose a recommendation strategy and specify custom JSON.

You can also set the parameters as variables and use them within the campaign. Variables make it easier to configure campaigns and allow business users to customize campaigns without the need for developers, providing them the ability to replace text, images, colors, and other design element parameters directly from the platform interface. More details Working with Variables in Variations

Changing Experience Status

After making all necessary changes, as well as while working with the campaign in general, you can change the experience status:

• Draft

• Active

• Paused

Saving the campaign

Don’t forget to save the campaign by clicking the “Publish” button at the bottom of the page.