The Jacquard Real-time API allows for the instant delivery of variants which are part of a Dynamic Optimization experiment.
The API changes the weighting assigned to different variants as an experiment progresses and results data gets fed back into Phrasee.
More help and support, along with step-by-step setup guides for individual ESPs, can be found here: https://support.jacquard.com
Authentication
Authentication is done via Bearer Authentication, passed in as a header. Where the ability to add headers to an API call is not possible, the ability to pass experiment specific tokens via the campaign_token query parameter is also possible.
Query Parameters
| Parameter | Description | Example Value | Required? |
|---|---|---|---|
| campaign_id | The Jacquard experiment / campaign id | 62a3479f8fcd86d5704b546d | Yes |
| delivery_id | The id for the message delivery, usually provided by your ESP | 742322 | Sometimes |
| recipient_id | The id of the recipient receiving the delivery, usually provided by your ESP. Note: Phrasee hashes the recipient id, and never stores the raw passed in value. | 9283672739 | Sometimes |
| personalization | Boolean string representing whether Language Personalization (currently in Beta) is switched on for this campaign. Defaults to false. | false | No |
| campaign_token | When authentication with a Bearer header token can't be used, campaign specific tokens can be passed in using these param. | bd8896d38d64e5a0bfdcf5c18ac44ec6c4a8968f0bf4f141f063d9517236e9d603bb96d5281afb32058e752b09aa41f5ef03d4b2b5fa310b423515eb63071c93d03cfe3c42e83df287937428d5bbb554bd3fd8d140210d5547c81da75316ad89ef9e795c9becec46dcb7792515edd082 | No |
| replacer_variable | If personalization tag replacers need be done on the API side, the variable to be replaced is passed in this variable. Note that the variable must be URL encoded to avoid the ESP parsing it into the relavent value. | {{FIRST_NAME}} |
No |
| replacer_value | If personalization tag replacers need be done on the API side, the value to be inserted in place of the associated variable. | Bob | No |
| replacer_default | If personalization tag replacers need be done on the API side, a default value to be used if a falsy value is detected for replacer_value. | Awesome Person | No |
Personalization Tag Replacers
Some ESP's do not have the flexibility to allow you to dynamically make changes to the variant returned by the API after it comes back, which can become a problem if variant(s) contain personalization tag replacers.
The real-time API allows for the ability for personalization tag replacement to be done on the API side, so that the variant(s) returned have the personalization tags already replaced.
This can be accomplished by passing values for the replacer_variable and replacer_value query params. A value can also be passed in for replacer_default if there is a concern about empty string values being passed in from the ESP.
The ability to pass in multiple replacers is also supported.
|
Servers
|
|---|
| https://realtime.phrasee.co |