ZUzuora
Web Analytics

Submit user conversion data

Records a user conversion. In Zephr, a conversion typically represents a user state change, such as transitioning from anonymous to registered or becoming a paying customer. This endpoint can also be used to record any event, like a user clicking on an advert. Conversions are tracked against specific rule versions and outcomes, enabling performance comparison between different outcomes. <br /> Recording this data enables the comparison of performance of different outcomes in a rule. For example, a split test could be set up with two slightly different 'advert' outcomes that each record a conversion when a user interacts with them. After traffic has been processed by the rule, the conversion rates between the two outcomes can be compared in 'analytics' mode in the console. For example, it might show that 5% of users who saw Outcome1 clicked a button, compared to 8% for Outcome2. This analytics data can be downloaded in CSV format for further analysis. <br /> Conversion data is only used to evaluate the performance of outcomes in rules and cannot be accessed on a per-user basis. To track if a particular registered user has interacted with an outcome, update a user attribute value. <br /> This endpoint is only relevant where the Zephr in-rule analytics feature is enabled. <br /> This endpoint must be called with a populated blaize_tracking_id cookie. If this cookie is missing, a 400 response code is returned.

post/zephr/public/rule-outcomes/v1/conversions

Request

  • Base URL
    https://demo-site
  • URL
    https://demo-site/zephr/public/rule-outcomes/v1/conversions
  • Auth
    • API key in cookie blaize_session
    • or API key in query parameter jwt
    • or API key in header x-blaize-jwt
    • or API key in header x-zephr-jwt
    • or HTTP bearer
    • or API key in cookie blaize_jwt

Cookies

blaize_tracking_idstring required

Zephr tracking ID cookie used to uniquely identify the user or anonymous session

Request body

ruleIdstring required

The ID of the specific Zephr rule version that led to the outcome causing this conversion.

outcomeIdstring required

The ID of the outcome in the rule that triggered this conversion.

conversionstring required

The type of conversion to be recorded. For example, Zephr out-of-the-box components will submit conversion strings 'REGISTERED' and 'CUSTOMER' when registering a user or when a user purchases a product. Any string can be used for custom conversions.

Example request

{
  "ruleId": "article-22",
  "outcomeId": "graph/1#1,graph/1#2,graph/1#3,graph/2#1,graph/2#2",
  "conversion": "REGISTERED"
}

Response

OK. The user conversion data has been successfully recorded.

Changes

No recorded changes to this operation across all 2 revisions of this API.