Use dynamic guest data in the API response for an interactive experiment

You can copy attributes or paths from the guest data model and use them in the API response.

To include dynamic guest data in the API response:

In the API editor, from the API tab, click the Data tab.
To insert dynamic data into the API response, enter a guest's email address or other identifier to search in the Data Selector search box. This enables you to access data model attributes and paths.

Tip

If there is a guest whose data you often use when configuring or testing code, just click the star icon to bookmark the guest so you no longer have to search for them.
Under Guest data model, click next to the attribute or path and click Copy Path as Freemarker.
Paste into the API tab.

Tip

There are some situations when you might want to insert a custom field in your API response, using FreeMarker. For example, you might want to retrieve the logged in state of the site visitor. To do this, create a custom fieldcreate a custom field called loggedInState. Then use the following path in FreeMarker when configuring the API response: "customField": "${request.params.customField}"
Click Save.
Click to close the API editor.

If you have suggestions for improving this article, let us know!