API & DOCS

My Account            

API used to view LeadFlow call details

Use the LeadFlow History Report to view LeadFlow call details

The LeadFlow History API is used to export and view analytics data from DialogTech's LeadFlow application.

📘

Base URL for the LeadFlow History Report API

https://dialogtechapis.com/report/v1/leadflow/v2/history

Request Headers

This is one of DialogTech's Newest APIs. This means all requests must meet the security requirements outlined in our This API Overview.

Querystring Parameters

Querystring parameters are used to specify what information is being requested from the API.

ParameterRequiredAcceptsMax LengthNotesUsage
sidYes*stringn/aUnique DialogTech assigned identifier for the callFilters the results to only include a specific call sharing the Session ID of the sid provided
start_dateYes*datetimen/aAccepts a datetime in ISO-8601 formatDefines the start of the date-range for records to be returned from
end_dateYes*datetimen/aAccepts a datetime in ISO-8601 formatDefines the end of the date-range for records to be returned from
set_idNointegern/aLeadFlow Set ID from the DialogTech Account Building Block IDs page.Returns only LeadFlow call records from the specified LeadFlow set.
activeNo0 or 1n/a0 - Returns only inactive calls
1 - Returns only active calls
Determines if the returned records should only reflect active or inactive calls.

*Either sid or start_date and end_date are required. If sid is provided, both start_date and end_date will be ignored.

API Response

Response KeyDescription
call_dateTimestamp the call hit the DialogTech system in Eastern Time
set_nameName of the LeadFlow set that processed the call
affiliateName of the affiliate that generated the call
phone_labelThe label assigned to the phone number
affiliate_numberInbound phone number dialed
advertiserName of the advertiser that received the LeadFlow call; or null if the call was not sent to an advertiser
offerName of the offer owned by the advertiser that received the LeadFlow call; or null if the call was not sent to an advertiser
transfer_numberPhone number or IVR of the advertiser that received the LeadFlow call
caller_idCaller ID of the caller
lead_statusIndication if the call was transferred to an advertiser with possible values
- Connected - Call was transferred to an advertiser
- Affiliate Cap - Call was not transferred because the affiliate that generated it reached a capacity limit
- No Buyer - Call was not transferred because there were no matching offers for the caller
- Hang Up - Caller hung up
entered_zipIf prompting for ZIP code, the ZIP entered by the caller
lf_stateThe caller’s state determined by their phone number or prompting for their ZIP code; this value is used to determine matching offers
first_nameFirst name of caller if reverse-lookup is enabled and data was found
last_nameLast name of caller if reverse-lookup is enabled and data was found
street_addressStreet Address of caller if reverse-lookup is enabled and data was found
cityCity of caller if reverse-lookup is enabled and data was found
stateSate of caller if reverse-lookup is enabled and data was found
zipcodeZip code of caller if reverse-lookup is enabled and data was found
rerouteIndication if caller is from repeat caller within defined reroute timeframe for the offer
- Y - Yes
- N - No
repeat_affiliate_callerIndication if caller is from repeat caller within defined unique caller timeframe for the affiliate
- Y - Yes
- N - No
affiliate_capIndication if the caller reach an affiliate capacity setting
offer_qualifiedIndication if caller is a conversion based on offer criteria
- Y - Yes
- N - No
offer_pricePrice defined for the offer if the call was qualified
affiliate_qualifiedIndication if caller is a conversion based on affiliate criteria
- Y - Yes
- N - No
affiliate_pricePrice defined to pay the affiliate if the call was qualified
marginPrice minus affiliate price
talk_minutesDuration, in tenths of a minute, that two parties are connected together.
talk_secondsDuration, in seconds, that two parties are connected together.
total_minutesCall Duration of call in minutes
total_secondsCall Duration of call in seconds
call_durationCall duration of call rounded up to the nearest minute
recording_linkA link to the recording of the call, if one exists.
contest_qualificationIndication if the advertiser challenged paying for the lead
sidUnique DialogTech assigned identifier for the call

Test Panel

View the test panel