For the complete documentation index, see llms.txt. This page is also available as Markdown.

Call Data

Log Call Data (GET)

get

Logs call data from a call tracking provider. Can be used via POST or GET.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Query parameters
CampaignIdintegerRequired

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

MediaIdintegerRequired

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

EventDatestring · date-timeRequired

The ISO 8601 time when the call event took place.

ActionTrackerIdintegerRequired

A unique identifier for the Event Type (Phone_Action_Tracker_ID).

CallProviderstring · max: 64Required

The vendor or client sending the call event data.

CallSessionIdstringRequired

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

CallerIdstring · max: 64Required

The phone number of the originating call.

CalledPhoneNumberstringRequired

The destination phone number that received the call.

CallDurationintegerRequired

Total duration (in seconds) of the call.

TalkDurationintegerRequired

Actual talk duration (in seconds) of the call.

AdIdintegerOptional

The unique ID of the ad associated with the call.

CallStatusstring · enumOptional

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

Default: ANSWERPossible values:
CallerPhoneNumberCountrystring · max: 64Optional

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

CalledPhoneNumberCountrystring · max: 64Optional

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

SubId1string · max: 64Optional

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

SubId2string · max: 64Optional

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

SubId3string · max: 64Optional

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

ClickIdstringOptional

The ClickId from the landing page URL.

CitystringOptional

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

RegionstringOptional

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

ZipintegerOptional

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

RepeatCallerstringOptional

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

PhoneTypestring · enumOptional

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

Possible values:
CallRecordingstring · uriOptional

Unique URL of the call recording.

IvrDurationintegerOptional

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

KeypressesstringOptional

List of unique keynames pressed.

Key1stringOptional

Name of the first key that was pressed.

Key2stringOptional

Name of the second key that was pressed.

Key3stringOptional

Name of the third key that was pressed.

Key4stringOptional

Name of the fourth key that was pressed.

TrafficSourcestringOptional

Source of the transaction (referring media source).

OptInSmsstringOptional

Whether the caller opted in to receive an SMS promotion.

UserAgentstringOptional

The user agent of the conversion generator.

DispositionNamestringOptional

The Conversion Event Name.

SaleAmountnumberOptional

If there was a sale conversion, the sale amount.

ReferenceIdnumberOptional

Customer Disposition Code for reference.

CustomConversionEvent1NamestringOptional

First custom name for reporting on Conversion events.

CustomConversionEvent2NamestringOptional

Second custom name for reporting on Conversion events.

CustomConversionEvent3NamestringOptional

Third custom name for reporting on Conversion events.

CustomConversionEvent1ValuestringOptional

First custom value for reporting on Conversion events.

CustomConversionEvent2ValuestringOptional

Second custom value for reporting on Conversion events.

CustomConversionEvent3ValuestringOptional

Third custom value for reporting on Conversion events.

VendorEventIdstringOptional

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

PromoNumberDescriptionstringOptional

Describes the Called Phone Number.

CustomCallEvent1NamestringOptional

First custom name for reporting on Call events.

CustomCallEvent2NamestringOptional

Second custom name for reporting on Call events.

CustomCallEvent3NamestringOptional

Third custom name for reporting on Call events.

CustomCallEvent1ValuestringOptional

First custom value for reporting on Call events.

CustomCallEvent2ValuestringOptional

Second custom value for reporting on Call events.

CustomCallEvent3ValuestringOptional

Third custom value for reporting on Call events.

Responses
200

The request was successful.

application/json
StatusstringOptionalExample: OK
get/calldata/logCallData
200

The request was successful.

Log Call Data

post

Logs call data from a call tracking provider. Can be used via POST or GET.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Body
CampaignIdintegerRequired

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

MediaIdintegerRequired

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

EventDatestring · date-timeRequired

The ISO-8601 time when the call event took place.

ActionTrackerIdintegerRequired

A unique identifier for the Event Type (Phone_Action_Tracker_ID).

CallProviderstring · max: 64Required

The vendor or client sending the call event data.

CallSessionIdstringRequired

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

CallerIdstring · max: 64Required

The phone number of the originating call.

CalledPhoneNumberstringRequired

The destination phone number that received the call.

CallDurationintegerRequired

Total duration (in seconds) of the call.

TalkDurationintegerRequired

Actual talk duration (in seconds) of the call.

AdIdintegerOptional

The unique ID of the ad associated with the call.

CallStatusstring · enumOptional

This value indicates the final outcome of the call. If the field is not present in the request, the system makes it ANSWER by default.

Default: ANSWERPossible values:
CallerPhoneNumberCountrystring · max: 64Optional

(64 character UTF-8) This is the Country Code derived from the incoming phone call. When NULL, default to US.

Default: US
CalledPhoneNumberCountrystring · max: 64Optional

(64 character UTF-8) This is the Country Code derived from the receiver of the incoming phone call. When NULL, default to US.

Default: US
SubId1string · max: 64Optional

(64 character UTF-8) The first value specific and only available to the Partner. This is the placeholder where the Partner can add data points that they want impact.com to report back to them.

SubId2string · max: 64Optional

(64 character UTF-8) The second value specific and only available to the Partner. This is the placeholder where the Partner can add data points that they want impact.com to report back to them.

SubId3string · max: 64Optional

(64 character UTF-8) The third value specific and only available to the Partner. This is the placeholder where the Partner can add data points that they want impact.com to report back to them.

ClickIdstringOptional

The ClickId from the landing page URL.

CitystringOptional

City of the CallerId - As identified by the Call Tracking vendor.

RegionstringOptional

Region of the CallerId - As identified by the Call Tracking vendor.

ZipintegerOptional

Zip of the CallerId - As identified by the Call Tracking vendor.

RepeatCallerstringOptional

Repeat vs. New call to indicate whether the caller was recorded as a repeat caller in the Call tracking vendor.

PhoneTypestring · enumOptional

Landline or Mobile or empty string if type is unknown.

Possible values:
CallRecordingstring · uriOptional

Unique URL of the call recording.

IvrDurationintegerOptional

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

KeypressesstringOptional

List of unique keynames pressed.

Key1stringOptional

Name of the first key that was pressed.

Key2stringOptional

Name of the second key that was pressed.

Key3stringOptional

Name of the third key that was pressed.

Key4stringOptional

Name of the fourth key that was pressed.

TrafficSourcestringOptional

Source of the transaction (referring media source).

OptInSmsstringOptional

Whether the caller opted in to receive an SMS promotion.

UserAgentstringOptional

The user agent of the conversion generator.

DispositionNamestringOptional

The Conversion Event Name.

SaleAmountnumberOptional

If there was a sale conversion, this will show the Sale Amount.

ReferenceIdnumberOptional

Customer Disposition Code for reference.

CustomConversionEvent1NamestringOptional

First custom name for reporting on Conversion events.

CustomConversionEvent2NamestringOptional

Second custom name for reporting on Conversion events.

CustomConversionEvent3NamestringOptional

Third custom name for reporting on Conversion events.

CustomConversionEvent1ValuestringOptional

First custom value for reporting on Conversion events.

CustomConversionEvent2ValuestringOptional

Second custom value for reporting on Conversion events.

CustomConversionEvent3ValuestringOptional

Third custom value for reporting on Conversion events.

VendorEventIdstringOptional

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

PromoNumberDescriptionstringOptional

Describes the Called Phone Number.

CustomCallEvent1NamestringOptional

First custom name for reporting on Call events.

CustomCallEvent2NamestringOptional

Second custom name for reporting on Call events.

CustomCallEvent3NamestringOptional

Third custom name for reporting on Call events.

CustomCallEvent1ValuestringOptional

First custom value for reporting on Call events.

CustomCallEvent2ValuestringOptional

Second custom value for reporting on Call events.

CustomCallEvent3ValuestringOptional

Third custom value for reporting on Call events.

Responses
200

The request was successful.

application/json
StatusstringOptionalExample: OK
post/calldata/logCallData
200

The request was successful.

Last updated