Manage Context API engines

Contact your account manager to enable Context API for your account.

Create an engine

Ensure profile changes have been published before selecting engine attributes.

To create an engine, complete the following steps:

1. Go to Activate > Context API and click + New Engine.

2. In the Details screen, configure the following engine details:

   • Name: Enter a name for the engine.
   • Enable Engine: Toggle the engine on and off. The engine endpoint is off by default. Data for visitors becomes available after you enable the engine and visitors log active sessions and generate events in the system.
   • Domain Allow List: Specify domains that can use this endpoint. For more information, see About Context API > Domain allow list.

3. Click Next.

4. In the Response screen, select the audiences, badges, and attributes to include in the engine. Verify your selections using the Example Response panel.

   If you use the Select all current and future audiences feature, if an audience is deleted later, it could still be included in the Context API engine until you purge the engine data or the data expires.

5. Select whether to use the ID (UID) or name for audiences and visitor attributes in the payload. Using audience, badge, and attribute names instead of IDs in large responses may impact payload size.

6. Click Next to create the engine.

7. On the Summary screen, review endpoint details, including the unique endpoint URL.

8. Click Done. You do not need to publish your profile after creating an engine.

Visitor data is collected after the engine is enabled and your visitors have active sessions.

Edit engine

To edit an engine, go to the Context API screen and click the engine you want to update. From the Edit Engine screen, you can update the engine details and response configuration, purge engine data, and toggle engines on and off as needed.

You do not need to publish your profile after editing an engine. Changes to Context API engines are available five minutes after saving any configuration changes.

Purge data

If a user deletes or renames an audience, badge, and attribute used in an engine, it may cause unexpected results in the endpoint responses. In these cases, you may want to consider purging the engine data. For more information about purging data, see About Context API > Purge Data.

Context API provides two ways for you to purge engine data when needed:

1. In the Context API screen, click the action menu next to the engine you want to purge data from and select Purge Data.
2. In the Edit Engines screen, click Purge Data from the slideout actions.

After a data purge, previously stored visitor data will not be available.