Log Conversion
This endpoint allows a client to log a conversion event for a specific contact within an organisation. It checks if the contact exists in the organisation before logging the conversion in the background.
Body Parameters
conversion(SubmitConversionV2): JSON object containing the conversion event details such as contact info and conversion type.
Authentication
- This endpoint requires a valid API key associated with the organisation to be passed via the request headers.
Response
- 202 Accepted: If the conversion event is successfully queued for logging in the background.
- 200 OK: If the contact is not associated with the organisation, no conversion is logged, but the request is acknowledged.
- 401 Unauthorized: If the API key is invalid or missing, access is denied.
Example Usage
curl -X POST "https://services.meetchase.ai/api/v2/conversions"
-H "X-API-Key: <YOUR_API_KEY>"
-d '{
"email": "user@example.com",
"conversion_type": "purchase",
"conversion_data": {
"item": "premium_subscription",
"price": 99.99
}
}'
Authorizations
Key used to authenticate user API requests.
Body
This model is used when submitting a new conversion event, such as when a user signs up or makes a purchase.
email(str): The email address of the individual or entity associated with the conversion event.conversion_type(str, optional): An optional string representing the type of conversion. This field is useful when tracking different conversion types, e.g., 'Sign-up', 'Purchase'. Max length is 63 characters.conversion_data(dict, optional): An optional JSON/dict object that contains any additional optional data tied to the conversion event, if required.
Example Usage
{
"email": "hazel@example.com"
"conversion_type": "sign-up",
"conversion_data": {
"product": "premium-subscription",
"price": 99.99
}
}The email address of the person or entity tied to the conversion.
An optional short descriptive string to identify the type of conversion. This field is useful when tracking different conversion types, e.g., 'Sign-up', 'Purchase'. Max length is 63 characters.
63"sign-up"
Optional JSON object that can hold additional data related to the conversion, if required.
Response
Successful Response