Refport
API ReferenceTracking

Track a lead

Records a lead conversion for a click using an API key.

POST
/api/track/lead

Records a lead conversion for a click using an API key.

Authorization

apiKeyAuth
Authorization<token>

API key passed as a Bearer token.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

clickId*string
Length1 <= length
customerAvatar?string
Formaturi
customerEmail?string
Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
customerExternalId*string
Length1 <= length <= 100
customerName?string
eventName*string
Length1 <= length <= 255
metadata?

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/track/lead" \  -H "Content-Type: application/json" \  -d '{    "clickId": "string",    "customerExternalId": "string",    "eventName": "string"  }'
{  "customerId": "string",  "leadId": "string",  "property1": null,  "property2": null}
Empty
{  "error": "string"}
{  "error": "string"}
{  "error": "string"}
{  "error": "string"}

OpenAPI

Generated Refport REST API reference from the OpenAPI schema.

Track a sale POST

Records a sale conversion for a click using an API key.