{"_id":"58fdfb078fbd2819000db9ea","githubsync":"","user":"58cadf93d223510f005d27db","project":"558d9c32beb7c719007f6319","__v":1,"version":{"_id":"558d9c33beb7c719007f631c","project":"558d9c32beb7c719007f6319","__v":19,"createdAt":"2015-06-26T18:38:43.154Z","releaseDate":"2015-06-26T18:38:43.153Z","categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"category":{"_id":"59082a11beedcf0f00235d87","project":"558d9c32beb7c719007f6319","version":"558d9c33beb7c719007f631c","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-05-02T06:41:21.140Z","from_sync":false,"order":4,"slug":"reporting-apis","title":"Reporting APIs"},"updates":["5b4e1fb89561430003f41f0b"],"next":{"pages":[],"description":""},"createdAt":"2017-04-24T13:17:59.561Z","link_external":false,"link_url":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:api-header]\n{\n  \"title\": \"Use the Call Detail Report API to get Call Details\"\n}\n[/block]\nThe Call Detail Report API is used to get a report of call details over a given date range. With dozens of fields available, the Call Detail Report is DialogTech's most robust and most popular reporting API.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for Call Detail Report\",\n  \"body\": \"https://secure.dialogtech.com/ibp_api.php\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Parameter List\"\n}\n[/block]\n\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\": \"action\",\n    \"0-1\": \"Yes\",\n    \"0-2\": \"String: **report.call_detail**\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Only accepts **report.call_detail** for Call Detail reporting\",\n    \"0-5\": \"Defines the API Call as \\\"Call Detail Report\\\" type\",\n    \"1-0\": \"access_key\",\n    \"1-1\": \"Yes\",\n    \"1-2\": \"String\",\n    \"1-3\": \"n/a\",\n    \"2-0\": \"secret_access_key\",\n    \"2-1\": \"Yes\",\n    \"2-2\": \"String\",\n    \"2-3\": \"n/a\",\n    \"1-4\": \"Access Key from the Key Manager within a DialogTech account\",\n    \"1-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-4\": \"Secret Access Key from the Key Manager within a DialogTech account\",\n    \"3-0\": \"start_date\",\n    \"4-0\": \"end_date\",\n    \"3-1\": \"Yes\",\n    \"3-2\": \"Date\",\n    \"4-2\": \"Date\",\n    \"4-1\": \"Yes\",\n    \"3-3\": \"8\",\n    \"4-3\": \"8\",\n    \"3-4\": \"Date format should be YYYYMMDD\",\n    \"4-4\": \"Date format should be YYYYMMDD\",\n    \"3-5\": \"Defines the start of the date-range for records to be returned from\",\n    \"4-5\": \"Defines the end of the date-range for records to be returned from\",\n    \"5-0\": \"activity_info\",\n    \"5-1\": \"No\",\n    \"5-2\": \"**0** or **1**\",\n    \"5-3\": \"n/a\",\n    \"5-4\": \"**0** - Do not include activity_info\\n**1** - Include activity_info\",\n    \"5-5\": \"A list of the applications and transfers a particular call utilized\",\n    \"6-0\": \"activity_keyword\",\n    \"6-1\": \"No\",\n    \"6-2\": \"**0** or **1**\",\n    \"6-3\": \"n/a\",\n    \"6-4\": \"**0** - Do not include activity_keyword\\n**1** - Include activity_keyword\",\n    \"6-5\": \"The URL tag from SourceTrak that caused the number to rotate (i.e. *gclid=* *)\",\n    \"7-0\": \"adj_enhanced\",\n    \"7-1\": \"No\",\n    \"7-2\": \"**0** or **1**\",\n    \"7-3\": \"n/a\",\n    \"7-4\": \"**0** - Do not include adj_enhanced\\n**1** - Include adj_enhanced\",\n    \"7-5\": \"Duration of enhanced minutes rounded up to the nearest minute\",\n    \"8-0\": \"adj_network\",\n    \"8-1\": \"No\",\n    \"8-2\": \"**0** or **1**\",\n    \"8-3\": \"n/a\",\n    \"8-4\": \"**0** - Do not include adj_network\\n**1** - Include adj_network\",\n    \"8-5\": \"Duration of intelligent minutes rounded up to the nearest minute\",\n    \"9-0\": \"adj_switch\",\n    \"9-1\": \"No\",\n    \"9-2\": \"**0** or **1**\",\n    \"9-3\": \"n/a\",\n    \"9-4\": \"**0** - Do not include adj_switch\\n**1** - Include adj_switch\",\n    \"9-5\": \"Duration of talk minutes rounded up to the nearest minute\",\n    \"10-0\": \"ani\",\n    \"10-1\": \"No\",\n    \"10-2\": \"**0** or **1**\",\n    \"10-3\": \"n/a\",\n    \"10-4\": \"**0** - Do not include ani\\n**1** - Include ani\",\n    \"10-5\": \"Caller ID of the caller\",\n    \"11-0\": \"call_duration\",\n    \"11-1\": \"No\",\n    \"11-2\": \"**0** or **1**\",\n    \"11-3\": \"n/a\",\n    \"11-4\": \"**0** - Do not include call_duration\\n**1** - Include call_duration\",\n    \"11-5\": \"Duration of call rounded up to the nearest minute\",\n    \"12-0\": \"call_transfer_status\",\n    \"12-1\": \"No\",\n    \"12-2\": \"**0** or **1**\",\n    \"12-3\": \"n/a\",\n    \"12-4\": \"**0** - Do not include call_transfer_status\\n**1** - Include call_transfer_status\",\n    \"12-5\": \"The result of a call's transfer from DialogTech\",\n    \"13-0\": \"call_type\",\n    \"13-1\": \"No\",\n    \"13-2\": \"**0** or **1**\",\n    \"13-3\": \"n/a\",\n    \"13-4\": \"**0** - Do not include call_type\\n**1** - Include call_type\",\n    \"13-5\": \"The type of call on DialogTech's platform\",\n    \"14-0\": \"call_type_filter\",\n    \"14-1\": \"No\",\n    \"14-2\": \"**All**, **Inbound**, **Outbound**, or **Click-To**\",\n    \"14-3\": \"n/a\",\n    \"14-4\": \"**All** - Include all calls (Default)\\n**Inbound** - Only include inbound calls\\n**Outbound** - Only include outbound calls\\n**Click-To** - Only include click-to calls\",\n    \"14-5\": \"Filters the results to only include specific call types\",\n    \"15-0\": \"call_type_value\",\n    \"15-1\": \"No\",\n    \"15-2\": \"**0** or **1**\",\n    \"15-3\": \"n/a\",\n    \"15-4\": \"**0** - Do not include call_type_value\\n**1** - Include call_type_value\",\n    \"15-5\": \"If `call_type_filter` is set to **Inbound** then set `call_type_value` to one of your inbound numbers to filter the report by that number.\\n If `call_type_filter` is set to **Click-To** then set `call_type_value` to be the building block ID of one of your Click-To's.\\n If `call_type_filter` is set to **Outbound** then `call_type_value` is not required\",\n    \"16-0\": \"campaign\",\n    \"16-1\": \"No\",\n    \"16-2\": \"**0** or **1**\",\n    \"16-3\": \"n/a\",\n    \"16-4\": \"**0** - Do not include campaign\\n**1** - Include campaign\",\n    \"16-5\": \"The paid search campaign from a SourceTrak click. *Note: `utm_campaign` must be used within the a paid search destination URL*\",\n    \"17-0\": \"city\",\n    \"17-1\": \"No\",\n    \"17-2\": \"**0** or **1**\",\n    \"17-3\": \"n/a\",\n    \"17-4\": \"**0** - Do not include city\\n**1** - Include city\",\n    \"17-5\": \"City of caller if reverse-lookup is enabled and data was found\",\n    \"18-0\": \"click_description\",\n    \"18-1\": \"No\",\n    \"18-2\": \"**0** or **1**\",\n    \"18-3\": \"n/a\",\n    \"18-4\": \"**0** - Do not include click_description\\n**1** - Include click_description\",\n    \"18-5\": \"If the call was initiated using a Click-to-Call this will show the description was assigned to that Click-to-Call.\",\n    \"19-0\": \"conversion\",\n    \"19-1\": \"No\",\n    \"19-2\": \"**0** or **1**\",\n    \"19-3\": \"n/a\",\n    \"19-4\": \"**0** - Do not include conversion\\n**1** - Include conversion\",\n    \"19-5\": \"\",\n    \"20-0\": \"conversion_amount\",\n    \"20-1\": \"No\",\n    \"20-2\": \"**0** or **1**\",\n    \"20-3\": \"n/a\",\n    \"20-4\": \"**0** - Do not include conversion_amount\\n**1** - Include conversion_amount\",\n    \"20-5\": \"\",\n    \"21-0\": \"conversion_note\",\n    \"21-1\": \"No\",\n    \"21-2\": \"**0** or **1**\",\n    \"21-3\": \"n/a\",\n    \"21-4\": \"**0** - Do not include conversion_note\\n**1** - Include conversion_note\",\n    \"21-5\": \"\",\n    \"22-0\": \"custom_id\",\n    \"22-1\": \"No\",\n    \"22-2\": \"**0** or **1**\",\n    \"22-3\": \"n/a\",\n    \"22-4\": \"**0** - Do not include custom_id\\n**1** - Include custom_id\",\n    \"22-5\": \"The value of the `_st_custom_id` variable used with SourceTrak from a website visitor\",\n    \"23-0\": \"custom_value\",\n    \"23-1\": \"No\",\n    \"23-2\": \"**0** or **1**\",\n    \"23-3\": \"n/a\",\n    \"23-4\": \"**0** - Do not include custom_value\\n**1** - Include custom_value\",\n    \"23-5\": \"The value of the `_st_custom_value` variable used with SourceTrak from a website visitor\",\n    \"24-0\": \"date_added\",\n    \"24-1\": \"No\",\n    \"24-2\": \"**0** or **1**\",\n    \"24-3\": \"n/a\",\n    \"24-4\": \"**0** - Do not include date_added\\n**1** - Include date_added\",\n    \"24-5\": \"Date and time the call was made.\",\n    \"25-0\": \"dnis\",\n    \"25-1\": \"No\",\n    \"25-2\": \"**0** or **1**\",\n    \"25-3\": \"n/a\",\n    \"25-4\": \"**0** - Do not include dnis\\n**1** - Include dnis\",\n    \"25-5\": \"The number dialed\",\n    \"26-0\": \"domain\",\n    \"26-1\": \"No\",\n    \"26-2\": \"**0** or **1**\",\n    \"26-3\": \"n/a\",\n    \"26-4\": \"**0** - Do not include domain\\n**1** - Include domain\",\n    \"26-5\": \"The URL where a visitor originated\",\n    \"27-0\": \"end_time\",\n    \"27-1\": \"No\",\n    \"27-2\": \"**0** or **1**\",\n    \"27-3\": \"n/a\",\n    \"27-4\": \"**0** - Do not include end_time\\n**1** - Include end_time\",\n    \"27-5\": \"Daily end time. Must be used with start_time to create a daily time range. Time is in hh:mm:ss 24-hour format. Example: 1:30pm would be written as 13:30:00.\",\n    \"28-0\": \"enhanced_minutes\",\n    \"28-1\": \"No\",\n    \"28-2\": \"**0** or **1**\",\n    \"28-3\": \"n/a\",\n    \"28-4\": \"**0** - Do not include enhanced_minutes\\n**1** - Include enhanced_minutes\",\n    \"28-5\": \"The duration, in tenths of a minute, when a call is being recorded or live-monitored\",\n    \"29-0\": \"extension_adgroup\",\n    \"29-1\": \"No\",\n    \"29-2\": \"**0** or **1**\",\n    \"29-3\": \"n/a\",\n    \"29-4\": \"**0** - Do not include extension_adgroup\\n**1** - Include extension_adgroup\",\n    \"29-5\": \"The Adwords Adgroup associated to a Google Call Extension click-to-call\",\n    \"30-0\": \"extension_keywords\",\n    \"30-1\": \"No\",\n    \"30-2\": \"**0** or **1**\",\n    \"30-3\": \"n/a\",\n    \"30-4\": \"**0** - Do not include extension_keywords\\n**1** - Include extension_keywords\",\n    \"30-5\": \"The Adwords Keywords associated to a Google Call Extension click-to-call\",\n    \"31-0\": \"findme_number_label\",\n    \"31-1\": \"No\",\n    \"31-2\": \"**0** or **1**\",\n    \"31-3\": \"n/a\",\n    \"31-4\": \"**0** - Do not include findme_number_label\\n**1** - Include findme_number_label\",\n    \"31-5\": \"The label associated with a FindMe transfer number\",\n    \"32-0\": \"first_activity\",\n    \"32-1\": \"No\",\n    \"32-2\": \"**0** or **1**\",\n    \"32-3\": \"n/a\",\n    \"32-4\": \"**0** - Do not include first_activity\\n**1** - Include first_activity\",\n    \"32-5\": \"First application/action taken when the call came in\",\n    \"33-0\": \"first_name\",\n    \"33-1\": \"No\",\n    \"33-2\": \"**0** or **1**\",\n    \"33-3\": \"n/a\",\n    \"33-4\": \"**0** - Do not include first_name\\n**1** - Include first_name\",\n    \"33-5\": \"First name of caller if reverse-lookup is enabled and data was found\",\n    \"34-0\": \"format\",\n    \"34-1\": \"No\",\n    \"34-2\": \"**xml** or **csv**\",\n    \"34-3\": \"n/a\",\n    \"34-4\": \"**xml** - Return data in xml format\\n**csv** - Return data in csv format\",\n    \"34-5\": \"Determines the format used to return the report\",\n    \"35-0\": \"ga_client_id\",\n    \"35-1\": \"No\",\n    \"35-2\": \"**0** or **1**\",\n    \"35-3\": \"n/a\",\n    \"35-4\": \"**0** - Do not include ga_client_id\\n**1** - Include ga_client_id\",\n    \"35-5\": \"The Google Universal Analytics assigned Client ID of a website visitor\",\n    \"36-0\": \"gclid\",\n    \"36-1\": \"No\",\n    \"36-2\": \"**0** or **1**\",\n    \"36-3\": \"n/a\",\n    \"36-4\": \"**0** - Do not include gclid\\n**1** - Include gclid\",\n    \"36-5\": \"The Google Adwords assigned Google Click Identifier of a website visitor\",\n    \"37-0\": \"geo_lookup_attempt\",\n    \"37-1\": \"No\",\n    \"37-2\": \"**0** or **1**\",\n    \"37-3\": \"n/a\",\n    \"37-4\": \"**0** - Do not include geo_lookup_attempt\\n**1** - Include geo_lookup_attempt\",\n    \"37-5\": \"\",\n    \"38-0\": \"geo_lookup_result\",\n    \"38-1\": \"No\",\n    \"38-2\": \"**0** or **1**\",\n    \"38-3\": \"n/a\",\n    \"38-4\": \"**0** - Do not include geo_lookup_result\\n**1** - Include geo_lookup_result\",\n    \"38-5\": \"\",\n    \"39-0\": \"inbound_ani_type\",\n    \"39-1\": \"No\",\n    \"39-2\": \"**0** or **1**\",\n    \"39-3\": \"n/a\",\n    \"39-4\": \"**0** - Do not include inbound_ani_type\\n**1** - Include inbound_ani_type\",\n    \"39-5\": \"The type of device used by the inbound caller (ie *mobile* or *landline*)\",\n    \"40-0\": \"last_activity\",\n    \"40-1\": \"No\",\n    \"40-2\": \"**0** or **1**\",\n    \"40-3\": \"n/a\",\n    \"40-4\": \"**0** - Do not include last_activity\\n**1** - Include last_activity\",\n    \"40-5\": \"The last application used, or last action taken for a the call\",\n    \"41-0\": \"last_name\",\n    \"41-1\": \"No\",\n    \"41-2\": \"**0** or **1**\",\n    \"41-3\": \"n/a\",\n    \"41-4\": \"**0** - Do not include last_name\\n**1** - Include last_name\",\n    \"41-5\": \"Last name of caller if reverse-lookup is enabled and data was found\",\n    \"42-0\": \"location_name\",\n    \"42-1\": \"No\",\n    \"42-2\": \"**0** or **1**\",\n    \"42-3\": \"n/a\",\n    \"42-4\": \"**0** - Do not include location_name\\n**1** - Include location_name\",\n    \"42-5\": \"The name of the SourceTrak location associated with the call\",\n    \"43-0\": \"netget_status\",\n    \"43-1\": \"No\",\n    \"43-2\": \"**0** or **1**\",\n    \"43-3\": \"n/a\",\n    \"43-4\": \"**0** - Do not include netget_status\\n**1** - Include netget_status\",\n    \"43-5\": \"A status of a NetGet attempt for the call\",\n    \"44-0\": \"network_minutes\",\n    \"44-1\": \"No\",\n    \"44-2\": \"**0** or **1**\",\n    \"44-3\": \"n/a\",\n    \"44-4\": \"**0** - Do not include network_minutes\\n**1** - Include network_minutes\",\n    \"44-5\": \"Duration, in tenths of a minute, that two parties are connected together. Also referred to as *Talk time*\",\n    \"45-0\": \"phone_label\",\n    \"45-1\": \"No\",\n    \"45-2\": \"**0** or **1**\",\n    \"45-3\": \"n/a\",\n    \"45-4\": \"**0** - Do not include phone_label\\n**1** - Include phone_label\",\n    \"45-5\": \"The label assigned to the phone number\",\n    \"46-0\": \"platform\",\n    \"46-1\": \"No\",\n    \"46-2\": \"**0** or **1**\",\n    \"46-3\": \"n/a\",\n    \"46-4\": \"**0** - Do not include platform\\n**1** - Include platform\",\n    \"46-5\": \"\",\n    \"47-0\": \"pool_name\",\n    \"47-1\": \"No\",\n    \"47-2\": \"**0** or **1**\",\n    \"47-3\": \"n/a\",\n    \"47-4\": \"**0** - Do not include pool_name\\n**1** - Include pool_name\",\n    \"47-5\": \"The SourceTrak pool a particular dialed-number is associated with\",\n    \"48-0\": \"recording\",\n    \"48-1\": \"No\",\n    \"48-2\": \"**0** or **1**\",\n    \"48-3\": \"n/a\",\n    \"48-4\": \"**0** - Do not include recording\\n**1** - Include recording\",\n    \"48-5\": \"A link to the recording of the call, if one exists.\",\n    \"49-0\": \"ring_time\",\n    \"49-1\": \"No\",\n    \"49-2\": \"**0** or **1**\",\n    \"49-3\": \"n/a\",\n    \"49-4\": \"**0** - Do not include ring_time\\n**1** - Include ring_time\",\n    \"49-5\": \"Ring time in seconds. This is populated only for certain transfer types\",\n    \"50-0\": \"search_term\",\n    \"50-1\": \"No\",\n    \"50-2\": \"**0** or **1**\",\n    \"50-3\": \"n/a\",\n    \"50-4\": \"**0** - Do not include search_term\\n**1** - Include search_term\",\n    \"50-5\": \"The literal search string (keywords) that resulted in the display of a phone number on a website.\",\n    \"51-0\": \"sid\",\n    \"51-1\": \"No\",\n    \"51-2\": \"**0** or **1**\",\n    \"51-3\": \"n/a\",\n    \"51-4\": \"**0** - Do not include sid\\n**1** - Include sid\",\n    \"51-5\": \"Unique DialogTech assigned identifier for the call\",\n    \"52-0\": \"sourceguard\",\n    \"52-1\": \"No\",\n    \"52-2\": \"**0** or **1**\",\n    \"52-3\": \"n/a\",\n    \"52-4\": \"**0** - Do not include sourceguard\\n**1** - Include sourceguard\",\n    \"52-5\": \"Returns 0 or 1, 0 indicates the call was not a SourceTrak SourceGuard call, 1 indicates the call was a SourceTrak SourceGuard call\",\n    \"53-0\": \"start_time\",\n    \"53-1\": \"No\",\n    \"53-2\": \"**0** or **1**\",\n    \"53-3\": \"n/a\",\n    \"53-4\": \"**0** - Do not include start_time\\n**1** - Include start_time\",\n    \"53-5\": \"Daily start time. Must be used with end_time to create a daily time range. Time is in hh:mm:ss 24-hour format. Example: 1:30pm would be written as 13:30:00.\",\n    \"54-0\": \"state\",\n    \"54-1\": \"No\",\n    \"54-2\": \"**0** or **1**\",\n    \"54-3\": \"n/a\",\n    \"54-4\": \"**0** - Do not include state\\n**1** - Include state\",\n    \"54-5\": \"State of caller if reverse-lookup is enabled and data was found\",\n    \"55-0\": \"street_address\",\n    \"55-1\": \"No\",\n    \"55-2\": \"**0** or **1**\",\n    \"55-3\": \"n/a\",\n    \"55-4\": \"**0** - Do not include street_address\\n**1** - Include street_address\",\n    \"55-5\": \"Street address of caller if reverse-lookup is enabled and data was found\",\n    \"56-0\": \"switch_minutes\",\n    \"56-1\": \"No\",\n    \"56-2\": \"**0** or **1**\",\n    \"56-3\": \"n/a\",\n    \"56-4\": \"**0** - Do not include switch_minutes\\n**1** - Include switch_minutes\",\n    \"56-5\": \"The duration, in tenths of a minute, a call is on the system while not connected to another party.\",\n    \"57-0\": \"transfer_to_number\",\n    \"57-1\": \"No\",\n    \"57-2\": \"**0** or **1**\",\n    \"57-3\": \"n/a\",\n    \"57-4\": \"**0** - Do not include transfer_to_number\\n**1** - Include transfer_to_number\",\n    \"57-5\": \"The number the call was transferred to.\",\n    \"58-0\": \"transfer_type\",\n    \"58-1\": \"No\",\n    \"58-2\": \"**0** or **1**\",\n    \"58-3\": \"n/a\",\n    \"58-4\": \"**0** - Do not include transfer_type\\n**1** - Include transfer_type\",\n    \"58-5\": \"When a call is transferred, returns what initiated the transfer such as FindMe Transfer\",\n    \"59-0\": \"url_tag\",\n    \"59-1\": \"No\",\n    \"59-2\": \"**0** or **1**\",\n    \"59-3\": \"n/a\",\n    \"59-4\": \"**0** - Do not include url_tag\\n**1** - Include url_tag\",\n    \"59-5\": \"The URL tag from SourceTrak that caused the number to rotate with wildcards replaced by the  value associated with the website visit (i.e. *st-t=google_bogo_campaign* as opposed to *st-t=google_* *)\",\n    \"60-0\": \"valuetrack\",\n    \"60-1\": \"No\",\n    \"60-2\": \"**0** or **1**\",\n    \"60-3\": \"n/a\",\n    \"60-4\": \"**0** - Do not include valuetrack\\n**1** - Include valuetrack\",\n    \"60-5\": \"See ValueTrack Parameters table\",\n    \"61-0\": \"zipcode\",\n    \"61-1\": \"No\",\n    \"61-2\": \"**0** or **1**\",\n    \"61-3\": \"n/a\",\n    \"61-4\": \"**0** - Do not include zipcode\\n**1** - Include zipcode\",\n    \"61-5\": \"Zip code address of caller if reverse-lookup is enabled and data was found\",\n    \"62-0\": \"search_sid\",\n    \"62-1\": \"No\",\n    \"62-2\": \"String\",\n    \"62-3\": \"n/a\",\n    \"62-4\": \"Sid corresponding to a desired call record\",\n    \"62-5\": \"Filters the results to only include a specific call sharing the Session ID of the `search_sid` provided\"\n  },\n  \"cols\": 6,\n  \"rows\": 63\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"ValueTrack Parameters\"\n}\n[/block]\nWhen `valuetrack=1` is added to your API call, a number of fields are automatically added to the response. These values are populated primarily by using DialogTech's ValueTrack parameters with SourceTrak. Please contact your account manager with questions about using ValueTrack parameters within SourceTrak.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"\",\n    \"0-0\": \"Keyword\",\n    \"1-0\": \"Match Type\",\n    \"2-0\": \"Network\",\n    \"3-0\": \"Device\",\n    \"4-0\": \"Device Model\",\n    \"5-0\": \"Creative\",\n    \"6-0\": \"Placement\",\n    \"7-0\": \"Target\",\n    \"8-0\": \"Param1\",\n    \"9-0\": \"Param2\",\n    \"10-0\": \"Random\",\n    \"11-0\": \"Ace ID\",\n    \"12-0\": \"Ad Position\",\n    \"13-0\": \"Product Target\",\n    \"14-0\": \"Ad Type\",\n    \"0-1\": \"For the Search Network: the keyword from your account that is matched to the search query. For the Display Network: the keyword from your account that is matched to the content.\",\n    \"1-1\": \"The match type of the keyword that triggered your ad: \\\"e\\\" for exact, \\\"p\\\" for phrase, or \\\"b\\\" for \\\"broad\\\"\",\n    \"2-1\": \"Where the click came from: \\\"g\\\" for Google search, \\\"s\\\" for a search partner, or \\\"d\\\" for the Display Network\",\n    \"3-1\": \"What device the click came from: \\\"m\\\" for mobile (including WAP), \\\"t\\\" for tablet, and \\\"c\\\" for computer\",\n    \"4-1\": \"What model of phone or tablet the click came from (for example, \\\"Apple+iPhone\\\"). Note: only available on Display Network campaigns\",\n    \"5-1\": \"A unique ID for your ad\",\n    \"6-1\": \"The content site where your ad was clicked (for keyword-targeted campaigns), or the matching placement targeting criteria for the site where your ad was clicked (for placement-targeted campaigns)\",\n    \"7-1\": \"A placement category (works with placement-targeted campaigns only)\",\n    \"8-1\": \"Creative parameter #1, if you're using the AdParamService with the AdWords API\",\n    \"9-1\": \"Creative parameter #2, if you're using the AdParamService with the AdWords API\",\n    \"10-1\": \"A random Google-generated number (an unsigned 64-bit integer), commonly used to force the page to reload\",\n    \"11-1\": \"A Google parameter that is a control or experiment ID from an Adwords campaign experiment.\",\n    \"12-1\": \"The position on the page that your ad appeared in, with a value like \\\"1t2\\\"(this means page 1, top, position 2)\",\n    \"13-1\": \"Identify a specific brand or products and are used in PLA campaigns to match to product targets.\",\n    \"14-1\": \"Google offers several different options for the varieties of ad that may appear on your pages and in your reports.\\n\\nHere's what you may see:\\n* Text (includes text ads that have been rendered in the \\\"display-like\\\" magazine style format)\\n* Image\\n* Rich media\\n* Flash\\n* Video\\n* Animated image\\n* Audio\\n* Link units\"\n  },\n  \"cols\": 2,\n  \"rows\": 15\n}\n[/block]\n*sources:\nhttps://support.google.com/adwords/answer/6305348\nhttps://support.google.com/adsense/answer/164735*\n[block:api-header]\n{\n  \"title\": \"Using this API\"\n}\n[/block]\nThese code examples are meant to show a basic method of accessing DialogTech's IVR Report API.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n\\t/*\\n\\t\\tCall Detail Report EX:\\n\\t\\tThis example request a Call Detail Report. \\n\\t\\tIt will then create an html table to \\n\\t\\tdisplay on the page with the following\\n\\t\\tCall Detail Report fields selected\\n\\n\\t\\tdate_added\\n\\t\\tsid\\n\\t\\tactivity_info\\n\\t\\tdnis\\n\\t\\tani\\n\\t\\tenhanced_minutes\\n\\t\\tcall_duration\\n\\t\\ttransfer_to_number\\n\\t\\tphone_label\\n\\t*/\\n\\n\\t// Create cURL resource\\n\\t$ch = curl_init(); \\n\\t$baseuri = \\\"https://secure.dialogtech.com/ibp_api.php?\\\";\\n\\n\\t// API Specific Static Parameters\\n\\t$action = \\\"report.call_detail\\\";\\n\\n\\t// Required User Parameters To Request the API\\n\\t$access_key = \\\"foo\\\";\\n\\t$secret_access_key = \\\"bar\\\";\\n\\t$start_date = \\\"20170101\\\";\\n\\t$end_date = \\\"20170102\\\";\\n\\n\\t// Parameters that define the fields returned\\n\\t$activity_info = \\\"1\\\";\\n\\t$ani = \\\"1\\\";\\n\\t$call_duration = \\\"1\\\";\\n\\t$call_type_filter = \\\"All\\\";\\n\\t$date_added = \\\"1\\\";\\n\\t$dnis = \\\"1\\\";\\n\\t$enhanced_minutes = \\\"1\\\";\\n\\t$format = \\\"csv\\\";\\n\\t$phone_label = \\\"1\\\";\\n\\t$sid = \\\"1\\\";\\n\\t$transfer_to_number = \\\"1\\\";\\n\\n\\n\\n\\t// Construct the full URL\\n\\t$full_url = $baseuri . \\\"&action=\\\" . $action .\\n\\t\\t\\\"&access_key=\\\" . $access_key .\\n\\t\\t\\\"&secret_access_key=\\\" . $secret_access_key .\\n\\t\\t\\\"&start_date=\\\" . $start_date .\\n\\t\\t\\\"&end_date=\\\" . $end_date .\\n\\t\\t\\\"&activity_info=\\\" . $activity_info .\\n\\t\\t\\\"&ani=\\\" . $ani .\\n\\t\\t\\\"&call_duration=\\\" . $call_duration .\\n\\t\\t\\\"&call_type_filter=\\\" . $call_type_filter .\\n\\t\\t\\\"&date_added=\\\" . $date_added .\\n\\t\\t\\\"&dnis=\\\" . $dnis .\\n\\t\\t\\\"&enhanced_minutes=\\\" . $enhanced_minutes .\\n\\t\\t\\\"&format=\\\" . $format .\\n\\t\\t\\\"&phone_label=\\\" . $phone_label .\\n\\t\\t\\\"&sid=\\\" . $sid .\\n\\t\\t\\\"&transfer_to_number=\\\" . $transfer_to_number;\\n\\n\\t// Set the URL\\n\\tcurl_setopt($ch, CURLOPT_URL, $full_url);\\n\\n\\t// Sets the return options of the cURL to return the actual result from the curl request, and FALSE on failure\\n\\tcurl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\\n\\n\\t// Sets the $output variable to the result of the curl\\n\\t$output = curl_exec($ch);\\n\\n\\t// Close curl resource to free up system resources\\n\\tcurl_close($ch);\\n\\n\\t// Basic CSS for the table formatting\\n\\t$page_html = \\\"<style>\\n\\ttd\\n\\t{\\n\\t\\tborder-left:1px solid black;\\n\\t\\tborder-top:1px solid black;\\n\\t\\ttext-align:center;\\n\\t}\\n\\ttable\\n\\t{\\n\\t\\tborder-right:1px solid black;\\n\\t\\tborder-bottom:1px solid black;\\n\\t}\\n\\t</style>\\\";\\n\\n\\t// Create the table\\n\\t$table = \\\"<table>\\\";\\n\\t$rows = str_getcsv($output, \\\"\\\\n\\\");\\n\\n\\tforeach($rows as &$row) {\\n\\t\\t// Add new row\\n\\t\\t$table .= \\\"<tr>\\\";\\n\\t\\t$cells = str_getcsv($row);\\n\\n\\t\\tforeach($cells as &$cell) {\\n\\t\\t\\t// Add a new cell\\n\\t\\t\\t$table .= \\\"<td>$cell</td>\\\";\\n\\t\\t}\\n\\n\\t\\t// Complete the new row\\n\\t\\t$table .= \\\"</tr>\\\";\\n\\t}\\n\\n\\t// Complete the table\\n\\t$table .= \\\"</table>\\\";\\n\\n\\t// Echo the CSS and table on the page\\n\\techo $page_html . $table;\\n?>\",\n      \"language\": \"php\",\n      \"name\": \"PHP Example\"\n    },\n    {\n      \"code\": \"curl -X \\\"\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ]\n}\n[/block]\n**Example Response**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version='1.0' encoding='iso-8859-1'?>\\n<!DOCTYPE data [\\n    <!ELEMENT data (record+)>\\n    <!ELEMENT record (date_added,sid,activity_info,dnis,ani,enhanced_minutes,call_duration,transfer_to_number,phone_label)>\\n    <!ELEMENT date_added (#PCDATA)>\\n    <!ELEMENT sid (#PCDATA)>\\n    <!ELEMENT activity_info (#PCDATA)>\\n    <!ELEMENT dnis (#PCDATA)>\\n    <!ELEMENT ani (#PCDATA)>\\n    <!ELEMENT enhanced_minutes (#PCDATA)>\\n    <!ELEMENT call_duration (#PCDATA)>\\n    <!ELEMENT transfer_to_number (#PCDATA)>\\n    <!ELEMENT phone_label (#PCDATA)>\\n]>\\n<data>\\n    <record>\\n        <date_added>2017-01-01 09:49:04</date_added>\\n        <sid>170101f3aac4938f</sid>\\n        <activity_info>Login acct: 0000 CID: 5551111111 DNIS: 5552222222</activity_info>\\n        <dnis>5552222222</dnis>\\n        <ani>5551111111</ani>\\n        <enhanced_minutes>0.0</enhanced_minutes>\\n        <call_duration>1</call_duration>\\n        <transfer_to_number></transfer_to_number>\\n        <phone_label></phone_label>\\n    </record>\\n    <record>\\n        <date_added>2017-01-02 08:27:00</date_added>\\n        <sid>1701023daf0f0c79</sid>\\n        <activity_info>Login acct: 0000 CID: 5553333333 DNIS: 5552222222</activity_info>\\n        <dnis>5552222222</dnis>\\n        <ani>5553333333</ani>\\n        <enhanced_minutes>0.0</enhanced_minutes>\\n        <call_duration>1</call_duration>\\n        <transfer_to_number></transfer_to_number>\\n        <phone_label></phone_label>\\n    </record>\\n    <record>\\n        <date_added>2017-01-02 15:06:02</date_added>\\n        <sid>170102f1ca7ab510</sid>\\n        <activity_info>Login acct: 0000 CID: 5554444444 DNIS: 5555555555,Transfer | 5556666666</activity_info>\\n        <dnis>5555555555</dnis>\\n        <ani>5554444444</ani>\\n        <enhanced_minutes>0.7</enhanced_minutes>\\n        <call_duration>1</call_duration>\\n        <transfer_to_number>5556666666</transfer_to_number>\\n        <phone_label>On Call Number</phone_label>\\n    </record>\\n    <record>\\n        <date_added>2017-01-02 15:08:09</date_added>\\n        <sid>170102aaea59fe69</sid>\\n        <activity_info>Login acct: 0000 CID: 5557777777 DNIS: 5558888888</activity_info>\\n        <dnis>5558888888</dnis>\\n        <ani>5557777777</ani>\\n        <enhanced_minutes>0.0</enhanced_minutes>\\n        <call_duration>1</call_duration>\\n        <transfer_to_number></transfer_to_number>\\n        <phone_label>212 Pool</phone_label>\\n    </record>\\n</data>\",\n      \"language\": \"xml\",\n      \"name\": \"xml\"\n    },\n    {\n      \"code\": \"\\\"date_added\\\",\\\"sid\\\",\\\"activity_info\\\",\\\"dnis\\\",\\\"ani\\\",\\\"enhanced_minutes\\\",\\\"call_duration\\\",\\\"transfer_to_number\\\",\\\"phone_label\\\"\\n\\\"2017-01-01 09:49:04\\\",\\\"170101f3aac4938f\\\",\\\"Login acct: 0000 CID: 5551111111 DNIS: 5552222222\\\",\\\"5552222222\\\",\\\"5551111111\\\",\\\"0.0\\\",\\\"1\\\",\\\"\\\",\\\"\\\"\\n\\\"2017-01-02 08:27:00\\\",\\\"1701023daf0f0c79\\\",\\\"Login acct: 0000 CID: 5553333333 DNIS: 5552222222\\\",\\\"5552222222\\\",\\\"5553333333\\\",\\\"0.0\\\",\\\"1\\\",\\\"\\\",\\\"\\\"\\n\\\"2017-01-02 15:06:02\\\",\\\"170102f1ca7ab510\\\",\\\"Login acct: 0000 CID: 5554444444 DNIS: 5555555555,Transfer | 5556666666\\\",\\\"5555555555\\\",\\\"5557777777\\\",\\\"0.7\\\",\\\"1\\\",\\\"5556666666\\\",\\\"On Call Number\\\"\\n\\\"2017-01-02 15:08:09\\\",\\\"170102aaea59fe69\\\",\\\"Login acct: 0000 CID: 5559999999 DNIS: 5558888888\\\",\\\"5558888888\\\",\\\"5559999999\\\",\\\"0.0\\\",\\\"1\\\",\\\"\\\",\\\"PPC Pool\\\"\",\n      \"language\": \"text\",\n      \"name\": \"csv\"\n    }\n  ]\n}\n[/block]","excerpt":"API used to get a report of Call Details over a given date range.","slug":"call-detail-report","type":"basic","title":"Call Detail Report"}

Call Detail Report

API used to get a report of Call Details over a given date range.

Use the Call Detail Report API to get Call Details

The Call Detail Report API is used to get a report of call details over a given date range. With dozens of fields available, the Call Detail Report is DialogTech's most robust and most popular reporting API.

Base URL for Call Detail Report

https://secure.dialogtech.com/ibp_api.php

Parameter List

Parameter
Required
Accepts
Max Length
Notes
Usage

action

Yes

String: report.call_detail

n/a

Only accepts report.call_detail for Call Detail reporting

Defines the API Call as "Call Detail Report" type

access_key

Yes

String

n/a

Access Key from the Key Manager within a DialogTech account

Credentials used for access to the API for a particular DialogTech account

secret_access_key

Yes

String

n/a

Secret Access Key from the Key Manager within a DialogTech account

Credentials used for access to the API for a particular DialogTech account

start_date

Yes

Date

8

Date format should be YYYYMMDD

Defines the start of the date-range for records to be returned from

end_date

Yes

Date

8

Date format should be YYYYMMDD

Defines the end of the date-range for records to be returned from

activity_info

No

0 or 1

n/a

0 - Do not include activity_info
1 - Include activity_info

A list of the applications and transfers a particular call utilized

activity_keyword

No

0 or 1

n/a

0 - Do not include activity_keyword
1 - Include activity_keyword

The URL tag from SourceTrak that caused the number to rotate (i.e. gclid= *)

adj_enhanced

No

0 or 1

n/a

0 - Do not include adj_enhanced
1 - Include adj_enhanced

Duration of enhanced minutes rounded up to the nearest minute

adj_network

No

0 or 1

n/a

0 - Do not include adj_network
1 - Include adj_network

Duration of intelligent minutes rounded up to the nearest minute

adj_switch

No

0 or 1

n/a

0 - Do not include adj_switch
1 - Include adj_switch

Duration of talk minutes rounded up to the nearest minute

ani

No

0 or 1

n/a

0 - Do not include ani
1 - Include ani

Caller ID of the caller

call_duration

No

0 or 1

n/a

0 - Do not include call_duration
1 - Include call_duration

Duration of call rounded up to the nearest minute

call_transfer_status

No

0 or 1

n/a

0 - Do not include call_transfer_status
1 - Include call_transfer_status

The result of a call's transfer from DialogTech

call_type

No

0 or 1

n/a

0 - Do not include call_type
1 - Include call_type

The type of call on DialogTech's platform

call_type_filter

No

All, Inbound, Outbound, or Click-To

n/a

All - Include all calls (Default)
Inbound - Only include inbound calls
Outbound - Only include outbound calls
Click-To - Only include click-to calls

Filters the results to only include specific call types

call_type_value

No

0 or 1

n/a

0 - Do not include call_type_value
1 - Include call_type_value

If call_type_filter is set to Inbound then set call_type_value to one of your inbound numbers to filter the report by that number.
If call_type_filter is set to Click-To then set call_type_value to be the building block ID of one of your Click-To's.
If call_type_filter is set to Outbound then call_type_value is not required

campaign

No

0 or 1

n/a

0 - Do not include campaign
1 - Include campaign

The paid search campaign from a SourceTrak click. Note: utm_campaign must be used within the a paid search destination URL

city

No

0 or 1

n/a

0 - Do not include city
1 - Include city

City of caller if reverse-lookup is enabled and data was found

click_description

No

0 or 1

n/a

0 - Do not include click_description
1 - Include click_description

If the call was initiated using a Click-to-Call this will show the description was assigned to that Click-to-Call.

conversion

No

0 or 1

n/a

0 - Do not include conversion
1 - Include conversion

conversion_amount

No

0 or 1

n/a

0 - Do not include conversion_amount
1 - Include conversion_amount

conversion_note

No

0 or 1

n/a

0 - Do not include conversion_note
1 - Include conversion_note

custom_id

No

0 or 1

n/a

0 - Do not include custom_id
1 - Include custom_id

The value of the _st_custom_id variable used with SourceTrak from a website visitor

custom_value

No

0 or 1

n/a

0 - Do not include custom_value
1 - Include custom_value

The value of the _st_custom_value variable used with SourceTrak from a website visitor

date_added

No

0 or 1

n/a

0 - Do not include date_added
1 - Include date_added

Date and time the call was made.

dnis

No

0 or 1

n/a

0 - Do not include dnis
1 - Include dnis

The number dialed

domain

No

0 or 1

n/a

0 - Do not include domain
1 - Include domain

The URL where a visitor originated

end_time

No

0 or 1

n/a

0 - Do not include end_time
1 - Include end_time

Daily end time. Must be used with start_time to create a daily time range. Time is in hh:mm:ss 24-hour format. Example: 1:30pm would be written as 13:30:00.

enhanced_minutes

No

0 or 1

n/a

0 - Do not include enhanced_minutes
1 - Include enhanced_minutes

The duration, in tenths of a minute, when a call is being recorded or live-monitored

extension_adgroup

No

0 or 1

n/a

0 - Do not include extension_adgroup
1 - Include extension_adgroup

The Adwords Adgroup associated to a Google Call Extension click-to-call

extension_keywords

No

0 or 1

n/a

0 - Do not include extension_keywords
1 - Include extension_keywords

The Adwords Keywords associated to a Google Call Extension click-to-call

findme_number_label

No

0 or 1

n/a

0 - Do not include findme_number_label
1 - Include findme_number_label

The label associated with a FindMe transfer number

first_activity

No

0 or 1

n/a

0 - Do not include first_activity
1 - Include first_activity

First application/action taken when the call came in

first_name

No

0 or 1

n/a

0 - Do not include first_name
1 - Include first_name

First name of caller if reverse-lookup is enabled and data was found

format

No

xml or csv

n/a

xml - Return data in xml format
csv - Return data in csv format

Determines the format used to return the report

ga_client_id

No

0 or 1

n/a

0 - Do not include ga_client_id
1 - Include ga_client_id

The Google Universal Analytics assigned Client ID of a website visitor

gclid

No

0 or 1

n/a

0 - Do not include gclid
1 - Include gclid

The Google Adwords assigned Google Click Identifier of a website visitor

geo_lookup_attempt

No

0 or 1

n/a

0 - Do not include geo_lookup_attempt
1 - Include geo_lookup_attempt

geo_lookup_result

No

0 or 1

n/a

0 - Do not include geo_lookup_result
1 - Include geo_lookup_result

inbound_ani_type

No

0 or 1

n/a

0 - Do not include inbound_ani_type
1 - Include inbound_ani_type

The type of device used by the inbound caller (ie mobile or landline)

last_activity

No

0 or 1

n/a

0 - Do not include last_activity
1 - Include last_activity

The last application used, or last action taken for a the call

last_name

No

0 or 1

n/a

0 - Do not include last_name
1 - Include last_name

Last name of caller if reverse-lookup is enabled and data was found

location_name

No

0 or 1

n/a

0 - Do not include location_name
1 - Include location_name

The name of the SourceTrak location associated with the call

netget_status

No

0 or 1

n/a

0 - Do not include netget_status
1 - Include netget_status

A status of a NetGet attempt for the call

network_minutes

No

0 or 1

n/a

0 - Do not include network_minutes
1 - Include network_minutes

Duration, in tenths of a minute, that two parties are connected together. Also referred to as Talk time

phone_label

No

0 or 1

n/a

0 - Do not include phone_label
1 - Include phone_label

The label assigned to the phone number

platform

No

0 or 1

n/a

0 - Do not include platform
1 - Include platform

pool_name

No

0 or 1

n/a

0 - Do not include pool_name
1 - Include pool_name

The SourceTrak pool a particular dialed-number is associated with

recording

No

0 or 1

n/a

0 - Do not include recording
1 - Include recording

A link to the recording of the call, if one exists.

ring_time

No

0 or 1

n/a

0 - Do not include ring_time
1 - Include ring_time

Ring time in seconds. This is populated only for certain transfer types

search_term

No

0 or 1

n/a

0 - Do not include search_term
1 - Include search_term

The literal search string (keywords) that resulted in the display of a phone number on a website.

sid

No

0 or 1

n/a

0 - Do not include sid
1 - Include sid

Unique DialogTech assigned identifier for the call

sourceguard

No

0 or 1

n/a

0 - Do not include sourceguard
1 - Include sourceguard

Returns 0 or 1, 0 indicates the call was not a SourceTrak SourceGuard call, 1 indicates the call was a SourceTrak SourceGuard call

start_time

No

0 or 1

n/a

0 - Do not include start_time
1 - Include start_time

Daily start time. Must be used with end_time to create a daily time range. Time is in hh:mm:ss 24-hour format. Example: 1:30pm would be written as 13:30:00.

state

No

0 or 1

n/a

0 - Do not include state
1 - Include state

State of caller if reverse-lookup is enabled and data was found

street_address

No

0 or 1

n/a

0 - Do not include street_address
1 - Include street_address

Street address of caller if reverse-lookup is enabled and data was found

switch_minutes

No

0 or 1

n/a

0 - Do not include switch_minutes
1 - Include switch_minutes

The duration, in tenths of a minute, a call is on the system while not connected to another party.

transfer_to_number

No

0 or 1

n/a

0 - Do not include transfer_to_number
1 - Include transfer_to_number

The number the call was transferred to.

transfer_type

No

0 or 1

n/a

0 - Do not include transfer_type
1 - Include transfer_type

When a call is transferred, returns what initiated the transfer such as FindMe Transfer

url_tag

No

0 or 1

n/a

0 - Do not include url_tag
1 - Include url_tag

The URL tag from SourceTrak that caused the number to rotate with wildcards replaced by the value associated with the website visit (i.e. st-t=google_bogo_campaign as opposed to st-t=google_ *)

valuetrack

No

0 or 1

n/a

0 - Do not include valuetrack
1 - Include valuetrack

See ValueTrack Parameters table

zipcode

No

0 or 1

n/a

0 - Do not include zipcode
1 - Include zipcode

Zip code address of caller if reverse-lookup is enabled and data was found

search_sid

No

String

n/a

Sid corresponding to a desired call record

Filters the results to only include a specific call sharing the Session ID of the search_sid provided

ValueTrack Parameters

When valuetrack=1 is added to your API call, a number of fields are automatically added to the response. These values are populated primarily by using DialogTech's ValueTrack parameters with SourceTrak. Please contact your account manager with questions about using ValueTrack parameters within SourceTrak.

Field name
Description

Keyword

For the Search Network: the keyword from your account that is matched to the search query. For the Display Network: the keyword from your account that is matched to the content.

Match Type

The match type of the keyword that triggered your ad: "e" for exact, "p" for phrase, or "b" for "broad"

Network

Where the click came from: "g" for Google search, "s" for a search partner, or "d" for the Display Network

Device

What device the click came from: "m" for mobile (including WAP), "t" for tablet, and "c" for computer

Device Model

What model of phone or tablet the click came from (for example, "Apple+iPhone"). Note: only available on Display Network campaigns

Creative

A unique ID for your ad

Placement

The content site where your ad was clicked (for keyword-targeted campaigns), or the matching placement targeting criteria for the site where your ad was clicked (for placement-targeted campaigns)

Target

A placement category (works with placement-targeted campaigns only)

Param1

Creative parameter #1, if you're using the AdParamService with the AdWords API

Param2

Creative parameter #2, if you're using the AdParamService with the AdWords API

Random

A random Google-generated number (an unsigned 64-bit integer), commonly used to force the page to reload

Ace ID

A Google parameter that is a control or experiment ID from an Adwords campaign experiment.

Ad Position

The position on the page that your ad appeared in, with a value like "1t2"(this means page 1, top, position 2)

Product Target

Identify a specific brand or products and are used in PLA campaigns to match to product targets.

Ad Type

Google offers several different options for the varieties of ad that may appear on your pages and in your reports.

Here's what you may see:

  • Text (includes text ads that have been rendered in the "display-like" magazine style format)
  • Image
  • Rich media
  • Flash
  • Video
  • Animated image
  • Audio
  • Link units

Using this API

These code examples are meant to show a basic method of accessing DialogTech's IVR Report API.

<?php
	/*
		Call Detail Report EX:
		This example request a Call Detail Report. 
		It will then create an html table to 
		display on the page with the following
		Call Detail Report fields selected

		date_added
		sid
		activity_info
		dnis
		ani
		enhanced_minutes
		call_duration
		transfer_to_number
		phone_label
	*/

	// Create cURL resource
	$ch = curl_init(); 
	$baseuri = "https://secure.dialogtech.com/ibp_api.php?";

	// API Specific Static Parameters
	$action = "report.call_detail";

	// Required User Parameters To Request the API
	$access_key = "foo";
	$secret_access_key = "bar";
	$start_date = "20170101";
	$end_date = "20170102";

	// Parameters that define the fields returned
	$activity_info = "1";
	$ani = "1";
	$call_duration = "1";
	$call_type_filter = "All";
	$date_added = "1";
	$dnis = "1";
	$enhanced_minutes = "1";
	$format = "csv";
	$phone_label = "1";
	$sid = "1";
	$transfer_to_number = "1";



	// Construct the full URL
	$full_url = $baseuri . "&action=" . $action .
		"&access_key=" . $access_key .
		"&secret_access_key=" . $secret_access_key .
		"&start_date=" . $start_date .
		"&end_date=" . $end_date .
		"&activity_info=" . $activity_info .
		"&ani=" . $ani .
		"&call_duration=" . $call_duration .
		"&call_type_filter=" . $call_type_filter .
		"&date_added=" . $date_added .
		"&dnis=" . $dnis .
		"&enhanced_minutes=" . $enhanced_minutes .
		"&format=" . $format .
		"&phone_label=" . $phone_label .
		"&sid=" . $sid .
		"&transfer_to_number=" . $transfer_to_number;

	// Set the URL
	curl_setopt($ch, CURLOPT_URL, $full_url);

	// Sets the return options of the cURL to return the actual result from the curl request, and FALSE on failure
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

	// Sets the $output variable to the result of the curl
	$output = curl_exec($ch);

	// Close curl resource to free up system resources
	curl_close($ch);

	// Basic CSS for the table formatting
	$page_html = "<style>
	td
	{
		border-left:1px solid black;
		border-top:1px solid black;
		text-align:center;
	}
	table
	{
		border-right:1px solid black;
		border-bottom:1px solid black;
	}
	</style>";

	// Create the table
	$table = "<table>";
	$rows = str_getcsv($output, "\n");

	foreach($rows as &$row) {
		// Add new row
		$table .= "<tr>";
		$cells = str_getcsv($row);

		foreach($cells as &$cell) {
			// Add a new cell
			$table .= "<td>$cell</td>";
		}

		// Complete the new row
		$table .= "</tr>";
	}

	// Complete the table
	$table .= "</table>";

	// Echo the CSS and table on the page
	echo $page_html . $table;
?>
curl -X ""

Example Response

<?xml version='1.0' encoding='iso-8859-1'?>
<!DOCTYPE data [
    <!ELEMENT data (record+)>
    <!ELEMENT record (date_added,sid,activity_info,dnis,ani,enhanced_minutes,call_duration,transfer_to_number,phone_label)>
    <!ELEMENT date_added (#PCDATA)>
    <!ELEMENT sid (#PCDATA)>
    <!ELEMENT activity_info (#PCDATA)>
    <!ELEMENT dnis (#PCDATA)>
    <!ELEMENT ani (#PCDATA)>
    <!ELEMENT enhanced_minutes (#PCDATA)>
    <!ELEMENT call_duration (#PCDATA)>
    <!ELEMENT transfer_to_number (#PCDATA)>
    <!ELEMENT phone_label (#PCDATA)>
]>
<data>
    <record>
        <date_added>2017-01-01 09:49:04</date_added>
        <sid>170101f3aac4938f</sid>
        <activity_info>Login acct: 0000 CID: 5551111111 DNIS: 5552222222</activity_info>
        <dnis>5552222222</dnis>
        <ani>5551111111</ani>
        <enhanced_minutes>0.0</enhanced_minutes>
        <call_duration>1</call_duration>
        <transfer_to_number></transfer_to_number>
        <phone_label></phone_label>
    </record>
    <record>
        <date_added>2017-01-02 08:27:00</date_added>
        <sid>1701023daf0f0c79</sid>
        <activity_info>Login acct: 0000 CID: 5553333333 DNIS: 5552222222</activity_info>
        <dnis>5552222222</dnis>
        <ani>5553333333</ani>
        <enhanced_minutes>0.0</enhanced_minutes>
        <call_duration>1</call_duration>
        <transfer_to_number></transfer_to_number>
        <phone_label></phone_label>
    </record>
    <record>
        <date_added>2017-01-02 15:06:02</date_added>
        <sid>170102f1ca7ab510</sid>
        <activity_info>Login acct: 0000 CID: 5554444444 DNIS: 5555555555,Transfer | 5556666666</activity_info>
        <dnis>5555555555</dnis>
        <ani>5554444444</ani>
        <enhanced_minutes>0.7</enhanced_minutes>
        <call_duration>1</call_duration>
        <transfer_to_number>5556666666</transfer_to_number>
        <phone_label>On Call Number</phone_label>
    </record>
    <record>
        <date_added>2017-01-02 15:08:09</date_added>
        <sid>170102aaea59fe69</sid>
        <activity_info>Login acct: 0000 CID: 5557777777 DNIS: 5558888888</activity_info>
        <dnis>5558888888</dnis>
        <ani>5557777777</ani>
        <enhanced_minutes>0.0</enhanced_minutes>
        <call_duration>1</call_duration>
        <transfer_to_number></transfer_to_number>
        <phone_label>212 Pool</phone_label>
    </record>
</data>
"date_added","sid","activity_info","dnis","ani","enhanced_minutes","call_duration","transfer_to_number","phone_label"
"2017-01-01 09:49:04","170101f3aac4938f","Login acct: 0000 CID: 5551111111 DNIS: 5552222222","5552222222","5551111111","0.0","1","",""
"2017-01-02 08:27:00","1701023daf0f0c79","Login acct: 0000 CID: 5553333333 DNIS: 5552222222","5552222222","5553333333","0.0","1","",""
"2017-01-02 15:06:02","170102f1ca7ab510","Login acct: 0000 CID: 5554444444 DNIS: 5555555555,Transfer | 5556666666","5555555555","5557777777","0.7","1","5556666666","On Call Number"
"2017-01-02 15:08:09","170102aaea59fe69","Login acct: 0000 CID: 5559999999 DNIS: 5558888888","5558888888","5559999999","0.0","1","","PPC Pool"