{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"LeadFlow History Report","type":"basic","slug":"leadflow-history-report","excerpt":"API used to view LeadFlow call details","body":"[block:api-header]\n{\n  \"title\": \"Use the LeadFlow History Report to view LeadFlow call details\"\n}\n[/block]\nThe LeadFlow History API is used to export and view analytics data from DialogTech's [*LeadFlow*](doc:https://www.dialogtech.com/products/leadflow-for-pay-per-call) application.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for the LeadFlow History Report API\",\n  \"body\": \"https://dialogtechapis.com/report/v1/leadflow/v2/history\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Request Headers\"\n}\n[/block]\nThis is one of DialogTech's [**Newest APIs**](doc:ag-api-overview). This means all requests must meet the security requirements outlined in our [This API Overview](doc:ag-api-overview).\n[block:api-header]\n{\n  \"title\": \"Querystring Parameters\"\n}\n[/block]\nQuerystring parameters are used to specify what information is being requested from the API.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Required\",\n    \"h-2\": \"Accepts\",\n    \"h-3\": \"Max Length\",\n    \"h-4\": \"Notes\",\n    \"h-5\": \"Usage\",\n    \"0-0\": \"sid\",\n    \"0-1\": \"Yes*\",\n    \"0-2\": \"string\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Unique DialogTech assigned identifier for the call\",\n    \"0-5\": \"Filters the results to only include a specific call sharing the Session ID of the `sid` provided\",\n    \"1-0\": \"start_date\",\n    \"1-1\": \"Yes*\",\n    \"1-2\": \"datetime\",\n    \"1-3\": \"n/a\",\n    \"1-4\": \"Accepts a datetime in [ISO-8601](doc:https://en.wikipedia.org/wiki/ISO_8601) format\",\n    \"1-5\": \"Defines the start of the date-range for records to be returned from\",\n    \"2-0\": \"end_date\",\n    \"3-0\": \"set_id\",\n    \"4-0\": \"active\",\n    \"2-1\": \"Yes*\",\n    \"3-1\": \"No\",\n    \"4-1\": \"No\",\n    \"2-2\": \"datetime\",\n    \"2-3\": \"n/a\",\n    \"2-4\": \"Accepts a datetime in [ISO-8601](doc:https://en.wikipedia.org/wiki/ISO_8601) format\",\n    \"2-5\": \"Defines the end of the date-range for records to be returned from\",\n    \"3-2\": \"integer\",\n    \"4-2\": \"**0** or **1**\",\n    \"3-3\": \"n/a\",\n    \"4-3\": \"n/a\",\n    \"3-4\": \"LeadFlow Set ID from the DialogTech Account [Building Block IDs](https://secure.dialogtech.com/building_block_ids.php) page.\",\n    \"3-5\": \"Returns only LeadFlow call records from the specified LeadFlow set.\",\n    \"4-4\": \"**0** - Returns only inactive calls\\n**1** - Returns only active calls\",\n    \"4-5\": \"Determines if the returned records should only reflect active or inactive calls.\"\n  },\n  \"cols\": 6,\n  \"rows\": 5\n}\n[/block]\n*Either `sid` or `start_date` and `end_date` are required. If `sid` is provided, both `start_date` and `end_date` will be ignored.\n[block:api-header]\n{\n  \"title\": \"API Response\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response Key\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"call_date\",\n    \"0-1\": \"Timestamp the call hit the DialogTech system in Eastern Time\",\n    \"1-0\": \"set_name\",\n    \"1-1\": \"Name of the LeadFlow set that processed the call\",\n    \"2-0\": \"affiliate\",\n    \"3-0\": \"phone_label\",\n    \"5-0\": \"advertiser\",\n    \"6-0\": \"offer\",\n    \"7-0\": \"transfer_number\",\n    \"8-0\": \"caller_id\",\n    \"9-0\": \"lead_status\",\n    \"10-0\": \"entered_zip\",\n    \"11-0\": \"lf_state\",\n    \"2-1\": \"Name of the affiliate that generated the call\",\n    \"3-1\": \"The label assigned to the phone number\",\n    \"5-1\": \"Name of the advertiser that received the LeadFlow call; or null if the call was not sent to an advertiser\",\n    \"6-1\": \"Name of the offer owned by the advertiser that received the LeadFlow call; or null if the call was not sent to an advertiser\",\n    \"7-1\": \"Phone number or IVR of the advertiser that received the LeadFlow call\",\n    \"8-1\": \"Caller ID of the caller\",\n    \"9-1\": \"Indication if the call was transferred to an advertiser with possible values\\n - `Connected` - Call was transferred to an advertiser\\n - `Affiliate Cap` - Call was not transferred because the affiliate that generated it reached a capacity limit\\n - `No Buyer` - Call was not transferred because there were no matching offers for the caller\\n - `Hang Up` - Caller hung up\",\n    \"4-0\": \"affiliate_number\",\n    \"4-1\": \"Inbound phone number dialed\",\n    \"10-1\": \"If prompting for ZIP code, the ZIP entered by the caller\",\n    \"11-1\": \"The caller’s state determined by their phone number or prompting for their ZIP code; this value is used to determine matching offers\",\n    \"12-0\": \"first_name\",\n    \"13-0\": \"last_name\",\n    \"14-0\": \"street_address\",\n    \"15-0\": \"city\",\n    \"16-0\": \"state\",\n    \"17-0\": \"zipcode\",\n    \"18-0\": \"reroute\",\n    \"19-0\": \"repeat_affiliate_caller\",\n    \"20-0\": \"affiliate_cap\",\n    \"21-0\": \"offer_qualified\",\n    \"22-0\": \"offer_price\",\n    \"23-0\": \"affiliate_qualified\",\n    \"24-0\": \"affiliate_price\",\n    \"25-0\": \"margin\",\n    \"26-0\": \"talk_minutes\",\n    \"27-0\": \"talk_seconds\",\n    \"28-0\": \"total_minutes\",\n    \"29-0\": \"total_seconds\",\n    \"30-0\": \"call_duration\",\n    \"31-0\": \"recording_link\",\n    \"32-0\": \"contest_qualification\",\n    \"33-0\": \"sid\",\n    \"12-1\": \"First name of caller if reverse-lookup is enabled and data was found\",\n    \"13-1\": \"Last name of caller if reverse-lookup is enabled and data was found\",\n    \"14-1\": \"Street Address of caller if reverse-lookup is enabled and data was found\",\n    \"15-1\": \"City of caller if reverse-lookup is enabled and data was found\",\n    \"16-1\": \"Sate of caller if reverse-lookup is enabled and data was found\",\n    \"17-1\": \"Zip code of caller if reverse-lookup is enabled and data was found\",\n    \"18-1\": \"Indication if caller is from repeat caller within defined reroute timeframe for the offer\\n - `Y` - Yes\\n - `N` - No\",\n    \"19-1\": \"Indication if caller is from repeat caller within defined unique caller timeframe for the affiliate\\n - `Y` - Yes\\n - `N` - No\",\n    \"20-1\": \"Indication if the caller reach an affiliate capacity setting\",\n    \"21-1\": \"Indication if caller is a conversion based on offer criteria\\n - `Y` - Yes\\n - `N` - No\",\n    \"22-1\": \"Price defined for the offer if the call was qualified\",\n    \"23-1\": \"Indication if caller is a conversion based on affiliate criteria\\n - `Y` - Yes\\n - `N` - No\",\n    \"24-1\": \"Price defined to pay the affiliate if the call was qualified\",\n    \"25-1\": \"Price minus affiliate price\",\n    \"26-1\": \"Duration, in tenths of a minute, that two parties are connected together.\",\n    \"27-1\": \"Duration, in seconds, that two parties are connected together.\",\n    \"28-1\": \"Call Duration of call in minutes\",\n    \"29-1\": \"Call Duration of call in seconds\",\n    \"30-1\": \"Call duration of call rounded up to the nearest minute\",\n    \"31-1\": \"A link to the recording of the call, if one exists.\",\n    \"32-1\": \"Indication if the advertiser challenged paying for the lead\",\n    \"33-1\": \"Unique DialogTech assigned identifier for the call\"\n  },\n  \"cols\": 2,\n  \"rows\": 34\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Test Panel\"\n}\n[/block]\n[**View the test panel**](https://apidocs.dialogtech.com/v0.1/docs/leadflow-history-report-test-panel)","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a81e84b761cf3001273182b","project":"558d9c32beb7c719007f6319","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1"],"_id":"558d9c33beb7c719007f631c","createdAt":"2015-06-26T18:38:43.154Z","project":"558d9c32beb7c719007f6319","releaseDate":"2015-06-26T18:38:43.153Z","__v":19},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"New APIs","slug":"new-apis","order":5,"from_sync":false,"reference":false,"_id":"5a81e6ef761cf300127317f8","project":"558d9c32beb7c719007f6319","version":"558d9c33beb7c719007f631c","createdAt":"2018-02-12T19:11:43.729Z","__v":0},"user":"58cadf93d223510f005d27db","createdAt":"2018-02-12T19:17:31.345Z","githubsync":"","__v":0,"parentDoc":null}