Call Conversion Data

Conversion data reference

Parameter nameFormatRequirementDescription
CampaignIdINTEGERRequiredUnique identifier for the campaign (or program) that the call conversion is associated with.
MediaIdINTEGERRequiredUnique identifier for the partner or media source.
EventDateDATETIME (ISO 8601)RequiredISO 8601 format of the date and time when the call conversion event occurred.
ActionTrackerIdINTEGERRequiredUnique identifier for the action tracker (i.e., event type) that's tracking the phone call.
CallProviderSTRINGRequiredThe vendor or client who is sending the call event data
CallSessionIdSTRINGRequiredA unique session ID that the vendor or client uses to identify the call.
CallerIdSTRINGRequiredThe phone number of the originating call, used to match the final conversion.
CalledPhoneNumberSTRINGRequiredThe destination phone number or the phone number that received the call.
CallDurationSTRINGRequiredTotal duration (in seconds) of the call.
TalkDurationSTRINGRequiredActual talk duration (in seconds) of the call.
AdIdINTEGEROptionalUnique identifier for the ad associated with the call conversion.
CallStatusSTRINGOptionalThis value indicates the final outcome of the call. If the field is not present in request, we make it ANSWER by default. Valid values are: UNKNOWN_CALLERID, FAILURE, CONGESTION, INCOMPLETE, CANCEL, IVR_DROPOFF, NO_TRANSFER_ATTEMPT, ANSWER
CallerPhoneNumberCountrySTRINGOptionalTwo-digit country code for the originating phone number (ISO 3166 alpha-2). When NULL, defaults to US.
CalledPhoneNumberCountrySTRINGOptionalTwo-digit country code for the called phone number (ISO 3166 alpha-2). When NULL, defaults to US.
SubId1STRINGOptionalThis value is specific and only available to the media partner. This is the placeholder where Media Partner can add data points that they want impact.com to report back to them.
SubId2STRINGOptionalThis value is specific and only available to the media partner. This is the placeholder where Media Partner can add data points that they want impact.com to report back to them.
SubId3STRINGOptionalThis value is specific and only available to the media partner. This is the placeholder where Media Partner can add data points that they want impact.com to report back to them.
ClickIdSTRINGOptionalUnique case-sensitive identifier generated by impact.com of a referring click, used to construct a consumer journey.
CountrySTRINGOptionalCountry of the CallerId - as identified by the call tracking vendor.
CitySTRINGOptionalCity of the CallerId - as identified by the call tracking vendor.
RegionSTRINGOptionalRegion of the CallerId - as identified by the call tracking vendor.
ZipINTEGEROptionalZip of the CallerId - As identified by the call tracking vendor.
RepeatCallerSTRINGOptionalRepeat vs New call to indicate whether the caller was recorded as a repeat caller by the call tracking vendor.
PhoneTypeSTRINGOptionalThe type of phone (i.e., landline, mobile).
CallRecordingSTRINGOptionalUnique URL of the call recording.
IvrDurationSTRINGOptionalDuration in seconds that the call spent in the IVR tree.
KeypressesSTRINGOptionalList of unique keynames that were pressed during the call.
Key1STRINGOptionalName of the first key that was pressed.
Key2STRINGOptionalName of the second key that was pressed.
Key3STRINGOptionalName of the third key that was pressed.
Key4STRINGOptionalName of the fourth key that was pressed.
TrafficSourceSTRINGOptionalSource of the transaction (referring media source).
OptInSmsSTRINGOptionalWhether the caller opted in to receive an SMS promotion.
UserAgentSTRINGOptionalThe user agent of the conversion generator.
DispositionNameSTRINGOptionalThe Conversion Event Name.
SaleAmountCURRENCYOptionalIf Sale Conversion, Sale Amount
ReferenceIdSTRINGOptionalCustomer Disposition Code for reference.
CustomConversionEvent1NameSTRINGOptionalCustom name for reporting on conversion events
CustomConversionEvent2NameSTRINGOptionalCustom name for reporting on conversion events
CustomConversionEvent3NameSTRINGOptionalCustom name for reporting on conversion events
CustomConversionEvent1ValueSTRINGOptionalCustom value for reporting on conversion events
CustomConversionEvent2ValueSTRINGOptionalCustom value for reporting on conversion events
CustomConversionEvent3ValueSTRINGOptionalCustom value for reporting on conversion events
VendorEventIdSTRINGOptionalWill be unique for call event and unique for the conversion event.
PromoNumberDescriptionSTRINGOptionalDescribes the called phone number
CustomCallEvent1NameSTRINGOptionalCustom name for reporting on call events
CustomCallEvent2NameSTRINGOptionalCustom name for reporting on call events
CustomCallEvent3NameSTRINGOptionalCustom name for reporting on call events
CustomCallEvent1ValueSTRINGOptionalCustom value for reporting on call events
CustomCallEvent2ValueSTRINGOptionalCustom value for reporting on call events
CustomCallEvent3ValueSTRINGOptionalCustom value for reporting on call events