Skip to main content
POST
/
advertisers
/
{advertiserID}
/
conversions
Record Conversion
curl --request POST \
  --url https://api.embedads.com/advertisers/{advertiserID}/conversions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "event_name": "<string>",
  "value": 123,
  "currency": "<string>",
  "country": "<string>",
  "ip_address": "<string>",
  "user_agent": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "zip_code": "<string>",
  "event_id": "<string>"
}'
{
    "events_received": 1,
    "success": true
}
We do not store conversion data. We immediately forward it to the Ad Networks, without storing it on our servers.
Do not send data regulated under HIPAA, nor data from minors, non-US persons, or those who have not consented to data sharing.

Path Parameters

advertiserID
string
required
The ID of the advertiser.

Body Parameters

event_name
string
required
The name of the event that triggered the conversion. Should be one of the following:
  • Purchase
  • Lead
  • ViewContent
  • CompleteRegistration
  • AddToCart
  • PhoneCall
value
number
Value of the conversion. Required if event_name is Purchase
currency
string
default:"USD"
Currency of the conversion. Must be specified as "USD". Only include this if you include value.
country
string
default:"us"
A two-letter lowercase country code.
ip_address
string
The IP address of the customer.
user_agent
string
The user agent of the customer.
email
string
The email address of the customer.
phone
string
The phone number of the customer. Optionally including country code. Formatting is flexible.
first_name
string
The first name of the customer.
last_name
string
The last name of the customer.
zip_code
string
The zip code of the customer.
event_id
string
Used to deduplicate events sent within 48 hours of one another. If specified, ensure that it is unique to the event, otherwise conversions may be dropped.

Response

events_received
number
The number of events received.
success
boolean
Whether the conversion was successfully recorded.
{
    "events_received": 1,
    "success": true
}