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
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.
Parameter | Required | Accepts | Max Length | Notes | Usage |
---|---|---|---|---|---|
sid | Yes* | string | n/a | Unique DialogTech assigned identifier for the call | Filters the results to only include a specific call sharing the Session ID of the sid provided |
start_date | Yes* | datetime | n/a | Accepts a datetime in ISO-8601 format | Defines the start of the date-range for records to be returned from |
end_date | Yes* | datetime | n/a | Accepts a datetime in ISO-8601 format | Defines the end of the date-range for records to be returned from |
set_id | No | integer | n/a | LeadFlow Set ID from the DialogTech Account Building Block IDs page. | Returns only LeadFlow call records from the specified LeadFlow set. |
active | No | 0 or 1 | n/a | 0 - 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 Key | Description |
---|---|
call_date | Timestamp the call hit the DialogTech system in Eastern Time |
set_name | Name of the LeadFlow set that processed the call |
affiliate | Name of the affiliate that generated the call |
phone_label | The label assigned to the phone number |
affiliate_number | Inbound phone number dialed |
advertiser | Name of the advertiser that received the LeadFlow call; or null if the call was not sent to an advertiser |
offer | Name of the offer owned by the advertiser that received the LeadFlow call; or null if the call was not sent to an advertiser |
transfer_number | Phone number or IVR of the advertiser that received the LeadFlow call |
caller_id | Caller ID of the caller |
lead_status | Indication 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_zip | If prompting for ZIP code, the ZIP entered by the caller |
lf_state | The caller’s state determined by their phone number or prompting for their ZIP code; this value is used to determine matching offers |
first_name | First name of caller if reverse-lookup is enabled and data was found |
last_name | Last name of caller if reverse-lookup is enabled and data was found |
street_address | Street Address of caller if reverse-lookup is enabled and data was found |
city | City of caller if reverse-lookup is enabled and data was found |
state | Sate of caller if reverse-lookup is enabled and data was found |
zipcode | Zip code of caller if reverse-lookup is enabled and data was found |
reroute | Indication if caller is from repeat caller within defined reroute timeframe for the offer - Y - Yes- N - No |
repeat_affiliate_caller | Indication if caller is from repeat caller within defined unique caller timeframe for the affiliate - Y - Yes- N - No |
affiliate_cap | Indication if the caller reach an affiliate capacity setting |
offer_qualified | Indication if caller is a conversion based on offer criteria - Y - Yes- N - No |
offer_price | Price defined for the offer if the call was qualified |
affiliate_qualified | Indication if caller is a conversion based on affiliate criteria - Y - Yes- N - No |
affiliate_price | Price defined to pay the affiliate if the call was qualified |
margin | Price minus affiliate price |
talk_minutes | Duration, in tenths of a minute, that two parties are connected together. |
talk_seconds | Duration, in seconds, that two parties are connected together. |
total_minutes | Call Duration of call in minutes |
total_seconds | Call Duration of call in seconds |
call_duration | Call duration of call rounded up to the nearest minute |
recording_link | A link to the recording of the call, if one exists. |
contest_qualification | Indication if the advertiser challenged paying for the lead |
sid | Unique DialogTech assigned identifier for the call |