The Performance Reporting API enables customers to record lead conversions in Opta.
This API accepts conversion data in JSON format via a POST request. Use test mode to validate your request before sending live conversion data.
API Endpoint
Method: POST
URL: https://app.opta.io/c_api/conversions
Request Format
The request body must be in JSON format.
Field | Type | Required | Description |
compid | string | Yes | The company ID assigned to you. This value is fixed and provided in your documentation. |
campid | string | Yes | The campaign ID assigned to you. This value is fixed and provided in your documentation. |
buyerid | string | Yes | The buyer ID assigned to you. This value is fixed and provided in your documentation. |
opta_lead_id | string | No | The unique lead ID originally generated in the Opta system. |
string | Yes | The email address of the converted lead. | |
phone | number | No | The phone number associated with the conversion (example: 1234567890). |
test | boolean | No | Optional, but recommended. Set test: true to validate your request without recording an actual conversion. |
Example Request
Content-Type: application/json
{
"compid": "7ZZQ5",
"campid": "E9MPN5",
"buyerid": "A4BGD",
"opta_lead_id": "lokhij123456789101112",
"email": "[email protected]",
"phone": "1234567890",
"test": true
}
Response
The API responds in JSON format indicating whether the conversion was recorded successfully or if any validation errors occurred.
Success – Conversion Recorded
{
"message": "Conversion recorded successfully."
}
Success – Test Conversion Validated
{
"message": "Test conversion received successfully."
}
Failure – Validation Error
{
"message": "Missing required field: campid"
}
Notes
Ensure compid, campid, and buyerid exactly match the credentials provided to you. Incorrect IDs will trigger validation errors.
opta_lead_id should reference the original lead ID returned during lead posting.
Use test: true to confirm your integration before sending actual conversions.
All successful conversion requests are logged and reflected in your Opta performance reports.
Questions?
Reach out to [email protected] and we're happy to help.