latestOpenAPI 3.1.02026-08-1039111206.0 KB

c53422ebb833

Call Data

Log Call Data via GET

Submit call data from a call tracking provider to impact.com using query parameters.

get/calldata/logCallData

Query parameters

CampaignIdinteger required

A unique identifier for your program (formerly known as campaign).

MediaIdinteger required

The ID of the Partner or Media Source in impact.com.

EventDatestring date-time required

The ISO 8601 time when the call event took place.

ActionTrackerIdinteger required

A unique identifier for the Event Type (Phone_Action_Tracker_ID).

CallProviderstring required

The vendor or client sending the call event data.

CallSessionIdstring required

The unique session ID from the vendor to identify the call.

CallerIdstring required

The phone number of the originating call.

CalledPhoneNumberstring required

The destination phone number that received the call.

CallDurationinteger required

Total duration (in seconds) of the call.

TalkDurationinteger required

Actual talk duration (in seconds) of the call.

AdIdinteger

The unique ID of the ad associated with the call.

CallStatus'UNKNOWN_CALLERID' | 'CONGESTION' | 'INCOMPLETE' | 'CANCEL' | 'IVR_DROPOFF' | 'NO_TRANSFER_ATTEMPT' | 'ANSWER' | 'FAILURE'

The final outcome of the call. Defaults to ANSWER if not provided.

CallerPhoneNumberCountrystring

Country code derived from the incoming phone call. Defaults to US.

CalledPhoneNumberCountrystring

Country code derived from the receiver of the incoming phone call. Defaults to US.

SubId1string

First partner-specific value for data points to be reported back.

SubId2string

Second partner-specific value for data points to be reported back.

SubId3string

Third partner-specific value for data points to be reported back.

ClickIdstring

The ClickId from the landing page URL.

Citystring

City of the CallerId, as identified by the Call Tracking vendor.

Regionstring

Region of the CallerId, as identified by the Call Tracking vendor.

Zipinteger

Zip code of the CallerId, as identified by the Call Tracking vendor.

RepeatCallerstring

Indicates whether the caller was recorded as a repeat caller by the Call Tracking vendor.

PhoneTypestring

Landline or Mobile, or empty string if the type is unknown.

CallRecordingstring uri

Unique URL of the call recording.

IvrDurationinteger

Duration in seconds that the call spent in the IVR tree.

Keypressesstring

List of unique keynames pressed.

Key1string

Name of the first key that was pressed.

Key2string

Name of the second key that was pressed.

Key3string

Name of the third key that was pressed.

Key4string

Name of the fourth key that was pressed.

TrafficSourcestring

Source of the transaction (referring media source).

OptInSmsstring

Whether the caller opted in to receive an SMS promotion.

UserAgentstring

The user agent of the conversion generator.

DispositionNamestring

The Conversion Event Name.

SaleAmountnumber

If there was a sale conversion, the sale amount.

ReferenceIdnumber

Customer Disposition Code for reference.

CustomConversionEvent1Namestring

Custom name for reporting on Conversion events.

CustomConversionEvent1Valuestring

Custom value for reporting on Conversion events.

VendorEventIdstring

A unique ID sent from the vendor for the Call and Conversion Event.

PromoNumberDescriptionstring

Describes the Called Phone Number.

CustomCallEvent1Namestring

Custom name for reporting on Call events.

CustomCallEvent1Valuestring

Custom value for reporting on Call events.

Response

Successful request

Statusstring