Custom Model Service
This service is currently available to a limited set of clients.
The Custom Model service lets you add and maintain custom predictive models (decision trees) for use in campaigns. For background information, see Custom Models.
Before adding a custom model, use theto check the validity and size of your decision tree.
Add a new custom model:
Modify a custom model:
View all custom models:
View a specific custom model:
Delete a custom model:
You cannot delete a custom model that is used by one or more campaigns.
The ID of the custom model.
|string (191)||The name of the custom model. This must be unique and must be no more than 191 characters.|
|string||A custom code that is used as an external ID or as a look-up value for an object. This value must be unique within your member.|
|int||Read-only. The ID of the member to which the custom model belongs.||Member's ID|
|int||The ID of the advertiser to which the custom model belongs.|
|enum||The structure of the custom model. Currently, the only allowed structure is |
The type of custom model. Possible values:
The logic of the model, expressed as a decision tree. You must write your decision tree in our Bonsai Language and then include a base64-encoded version here.
Although it is not visible in the response, Xandr stores your tree in Lisp format. This internal representation tends to be smaller in size, as it has less whitespace and uses ID numbers instead of names and other values. The Lisp version of your tree must be smaller than 3 MB, or 3,145,728 bytes. If it is larger than that, you will not be able to add your tree.
In a GET query, the
Check the Validity and Size of Your Tree
Before adding a custom model, use the Custom Model Parser Service to check the validity and size of your decision tree. See that service for details about validation and error messages.
Read-only. The decision tree in plain text. We provide this in the response so that you can retrieve and review your tree's original format whenever necessary to iterate on tree design. Note that tabs are replaced with
In a GET query, the
|date||Read-only. The date and time when the custom model was last modified.|
View all custom models
View a specific custom model
Add a custom model