The Personalization Metrics endpoint returns metrics corresponding to performance of personalized campaigns.
NOTE: This route has been decommissioned as of Wednesday, June 14, 2017 and is no longer available. Please reach out to [email protected] if you have any questions, concerns, or needs surrounding this API route.
The Personalization Metrics endpoint returns metrics corresponding to performance of personalized campaigns. These metrics can be derived in aggregate or in a time series of specified resolution.
Each object returned has a key named by the campaign identifier under which the metrics were tracked. In addition, an object with key name "total" represents the aggregations of all campaigns with data.
Each object contains the following fields:
| Field Name | Type | Description |
|---|---|---|
| opens | Number | Total number of recommendation sets opened for Boomtrain emails. Total number of recommendations opened for other Boomtrain recommendations. |
| personalizedOpens | Number | Total number of emails opened with at least one personalized recommendation for Boomtrain emails. Total number of personalized recommendations opened for other Boomtrain recommendations. |
| clicks | Number | Total number of clicks on recommendations. |
| personalizedClicks | Number | Total number of clicks on personalized recommendations. |
| ctor | Number | The Click-to-Open rate for recommendations in this campaign, defined as clicks / opens. |
| personalizedCtor | Number | The Click-to-Open ratio for personalized recommendations in this campaign, defined as personalizedClicks / personalizedOpens. |
| popularCtor | Number | The Click-to-Open ratio for popular recommendations in this campaign, defined as popularClicks / popularOpens. |
| lift | Number | The lift in the Click-to-Open ratio between personalized recommendations and popular recommendations, defined as personalizedCtor / popularCtor. |
| personalizationRate | Number | The percentage of total opens that are personalized, an indicator of Boomtrain's ability to serve personalized results for users, defined as personalizedOpens / opens. |
| views | Number | The number of "viewed" events tracked overall for the given time period. Note that this field will only appear in the "total" object, as it is not campaign-specific. |