soap api

 

SOAP API

To communicate to the web service you will need to request the following URL as a web service URL using your programming language.

Web Service URL: https://AvidTrak.com/webservice/service.php?wsdl

Web Service Type: SOAP

After establishing the connection via the web service you will call the following functions to get the required data.

Web Service Methods

Method Description
visits_data To get visit data for Google, Yahoo and Bing
visit_call_detail Get call data for visits by using keyword
linksource_data Link source visit data
linksource_call_detail Call details for link source visits
call_summary Summarized calls data by keyword
call_summary_detail Call details for summarized call data
matched_search_calls All matched search calls
post_session_calls Post session calls
lite_campaign LITE campaigns
all_lite_calls All Avid Lite calls
lite_campaign_call_detial Call detail for specific Lite campaigns
show_client_summary Agency client list
show_group_client Show client groups

Visit Data

Method name: visits_data

Parameters to pass:

Parameter name Details
pin code Numeric pin code provided by AvidTrak
This parameter must contain valid PIN Code
filter Fixed values for search engine:
gppc = Google PPC
gseo = Google Organic
yppc = Yahoo PPC
yseo = Yahoo Organic
bppc = Bing PPC
bseo = Bing Organic
startdate Start date in “YYYY-mm-dd hh:mm:ss” format
This parameter must contain valid date in mentioned format
enddate End date in “YYYY-mm-dd hh:mm:ss” format
orderby Provide fieldname from field list below to sort data. By default it will sort by “calls” if you leave the string blank in the parameter
ordertype “asc” for ascending and “desc” for descending
By default its asc
perpage Numeric value to get specific number of records
By default its 20
page Numeric value to get records of specific page number if you use “perpage”
By default its 1
xml Pass TRUE to get response in xml format
Pass FALSE to get response in comma delimited format
By default its comma delimited
use_paging If you do not want use paging set this parameter to FALSE, else set it TRUE to get specific number or records mentioned in perpage and page parameters.
By default it is FALSE

Fields:

Field name Detail
keyword Visit keyword
visits Total number of visits for the keyword
calls Total number of calls for the keyword
tracking_number Tracking number / dialed number
group Campaign group
campaign Campaign
adposition Ad position
match_type Keyword type
first_visit_datetime First visit date and time
last_visit_datetime Last visit date and time

Correct Response in Comma delimited format:

keyword,visits,calls,tracking_number,group,campaign,adposition,match_type,first_visit_datetime,last_visit_datetime some keyword
1,76,15,8881234567,,,,broad,2011-12-17 19:31:36,2012-12-15 12:42:44
some keyword 2,513,27, 8887654321,,,,broad,2011-09-19 08:19:03,2013-02-12 19:22:14
some keyword 3,386,95, 8881234567,,,,broad,2011-09-19 08:18:08,2013-02-11 07:30:44
some keyword 4,2,0,8887654321,,,,broad,2011-09-19 08:19:24,2011-09-19 08:21:11
some keyword 5,18,4, 8881234567,,,,broad,2011-09-19 08:16:43,2013-02-11 08:41:10

Note:

  • First row in the result set is field name
  • Each row is separated by “\n”
  • Each column is separated by comma (,)

Correct Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<result>

<data>
<keyword> some keyword 1</keyword>
<visits>76</visits>
<calls>15</calls>
<tracking_number>8881234567</tracking_number>
<group> group 1</group>
<campaign>Camp 1</campaign>
<adposition>s1</adposition>
<match_type>broad</match_type>
<first_visit_datetime>2011-12-17 19:31:36</first_visit_datetime>
<last_visit_datetime>2012-12-15 12:42:44</last_visit_datetime>
</data>
<data>
<keyword>some keyword 2</keyword>
<visits>77</visits>
<calls>10</calls>
<tracking_number>8887654321</tracking_number>
<group>group 2</group>
<campaign>camp 2</campaign>
<adposition>s2</adposition>
<match_type>broad</match_type>
<first_visit_datetime>2011-12-17 19:31:36</first_visit_datetime>
<last_visit_datetime>2012-12-15 12:42:44</last_visit_datetime>
</data>
</result>

Error Response in Comma Delimited:

startdate,orderby,message

Start date is not a valid date time,Order by is not valid,Error

Error Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<detail>


<startdate>Start date is not a valid date time</startdate>
<orderby>Order by is not valid</orderby>
<message>Error</message>

</detail>

Visit Call Detail

By using this function you will get the call details of the specific keyword listed in the result of “visit_data” method. These details can be obtained by providing the keyword and filter in the parameters.

Note: the filter should be same as that used in visit_date method to get the data.

Method name:  visit_call_detail

Parameters to pass:

Parameter name Details
pin code Numeric pin code provided by AvidTrak
This parameter must contain valid PIN Code
filter Fixed values for search engine:
gppc = Google PPC
gseo = Google Organic
yppc = Yahoo PPC
yseo = Yahoo Organic
bppc = Bing PPC
bseo = Bing Organic
keyword One keyword obtained using visit_data method
startdate Start date in “YYYY-mm-dd hh:mm:ss” format
This parameter must contain valid date in mentioned format
enddate End date in “YYYY-mm-dd hh:mm:ss” format
orderby Provide fieldname from field list below to sort data. By default it will sort by “calls” if you leave blank string in the parameter
ordertype “asc” for ascending and “desc” for descending
By default its asc
perpage Numeric value to get specific number of records
By default its 20
page Numeric value to get records of specific page number if you use “perpage”
By default its 1
xml Pass TRUE to get response in xml format
Pass FALSE to get response in comma delimited format
By default its comma delimited
use_paging If you do not want use paging set this parameter to FALSE, else set it TRUE to get specific number or records as mentioned in perpage and page parameters.
By default its FALSE

Fields:

Field name Detail
caller Caller Number
searched_keyword The keyword searched
support_call
duration Call duration
tracking_number Tracking number
adid Ad ID if available
visit_datetime Matched visit date time
call_datetime Call date and time
recording URL of recording if applicable
difference Difference in visit time and call time (you need to enable this feature to get this data)
unique_id Unique ID of analytics
caller_city Caller city
caller_state Caller state
utm_source UTM Sorce
utm_medium UTM Medium
utm_content UTM Content
adposition Ad Position
match_type Keyword type

Correct Response in Comma delimited format:

caller,searched_keyword,rating,support_call,duration,tracking_number,adid,visit_datetime,call_datetime,recording,difference,
unique_id,caller_city,caller_state,utm_source,utm_medium,utm_content,adposition,match_type

3051234567,some searched keyword,,,8881234567,,2011-12-17 19:31:36,2011-12-17 20:31:47,0-day 01:00:11,https://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/RE126e09cecd83b386e7b2c3a720bcdec.mp3,458338,MIAMI,FL,google,ppc,res,,broad

3471234567, some searched keyword,,, 8881234567,,2011-12-18 10:32:23,2011-12-20 15:30:23,2-day 04:58:00,https://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/RE9af9123f2e23225a71814afbc70d7b5.mp3,308376,BROOKLYN,NY,google,ppc,res,,broad

Note:

  • First row in the result set is field name
  • Each row is separated by “\n”
  • Each column is separated by comma (,)

Correct Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<result>

<data>
<caller>3051234567</caller>
<searched_keyword>some searched keyword</searched_keyword>
<support_call></support_call>
<tracking_number>8881234567</tracking_number>
<adid></adid>
<visit_datetime>2011-12-17 19:31:36</visit_datetime>
<call_datetime>2011-12-17 20:31:47</call_datetime>
<difference>0-day 01:00:11</difference>
<recording>https://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/RE126e09cecd83b386e7b2c3a720bcdec.mp3</recording >
<caller_city>MIAMI</caller_city>
<caller_state>FL</caller_state>
<unique_id>458338</unique_id>
<utm_source>google</utm_source>
<utm_medium>ppc</utm_medium>
<utm_content>res </utm_content>
<adposition></adposition>
<match_type>broad</match_type>
</data>

</result>

Error Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<detail>

<startdate>Start date is not a valid date time</startdate>
<orderby>Order by is not valid</orderby>
<message>Error</message>

</detail>

Link Source Data

Method name:  linksource_data

Parameters to pass:

Parameter name Details
pin code Numeric pin code provided by AvidTrak
This parameter must contain valid PIN Code
startdate Start date in “YYYY-mm-dd hh:mm:ss” format
This parameter must contain valid date in mentioned format
enddate End date in “YYYY-mm-dd hh:mm:ss” format
orderby Provide fieldname from field list below to sort data. By default it will sort by “calls” if you leave blank string in the parameter
ordertype “asc” for ascending and “desc” for descending
By default its asc
perpage Numeric value to get specific number of records
By default its 20
page Numeric value to get records of specific page number if you use “perpage”
By default its 1
xml Pass TRUE to get response in xml format
Pass FALSE to get response in comma delimited format
By default its comma delimited
use_paging If you do not want use paging set this parameter to FALSE, else set it TRUE to get specific number or records mentioned in perpage and page parameters.
By default it is FALSE

Fields:

Field name Detail
link_source Visit keyword
visits Total number of visits for the link source
calls Total number of calls for the link source
domain_id Link source ID
first_visit First visit date time
last_visit Last visit date time

Correct Response in Comma delimited format:

link_source,visits,calls,domain_id,first_visit,last_visit
dlinksearch.com,23,0,240367546757,04/10/2012, 01:01:04,11/29/2012, 15:44:04
inbox.com,50,7,512085525629,07/11/2012, 08:10:55,02/01/2013, 09:11:52
interviewmonster.com,1,0,749466037368,12/16/2012, 10:00:31,12/16/2012, 10:00:31

Note:

  • First row in the result set is field name
  • Each row is separated by “\n”
  • Each column is separated by comma (,)

Correct Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<result>

<data>
<link_source>dlinksearch.com</link_source>
<visits>23</visits>
<calls>0</calls>
<domain_id>240367546757</domain_id>
<first_visit>04/10/2012, 01:01:04</first_visit>
<last_visit>11/29/2012, 15:44:04</last_visit>
</data>

<data>
<link_source>.inbox.com</link_source>
<visits>50</visits>
<calls>7</calls>
<domain_id>512085525629</domain_id>
<first_visit>07/11/2012, 08:10:55</first_visit>
<last_visit>02/01/2013, 09:11:52</last_visit>
</data>

</result>

Error Response in Comma Delimited:


startdate,orderby,message
Start date is not a valid date time,Order by is not valid,Error

Error Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<detail>

<startdate>Start date is not a valid date time</startdate>
<orderby>Order by is not valid</orderby>
<message>Error</message>

</detail>

Link Source Call Detail

By using this function you will get the call details for the specific link source listed in the results of “linksource_data” method. These details can be obtained by providing the domain Id in the parameters retrieved from the data of the “linksource_data” method.

Link Source Data

Method name:  linksource_data

Parameters to pass:

Parameter name Details
pin code Numeric pin code provided by AvidTrak
This parameter must contain valid PIN Code
domain_id Domain id get from linksource_data method
startdate Start date in “YYYY-mm-dd hh:mm:ss” format
This parameter must contain valid date in mentioned format
enddate End date in “YYYY-mm-dd hh:mm:ss” format
orderby Provide fieldname from field list below to sort data. By default it will sort by “calls” if you leave blank string in the parameter
ordertype “asc” for ascending and “desc” for descending
By default its asc
perpage Numeric value to get specific number of records
By default its 20
page Numeric value to get records of specific page number if you use “perpage”
By default its 1
xml Pass TRUE to get response in xml format
Pass FALSE to get response in comma delimited format
By default its comma delimited
use_paging If you do not want use paging set this parameter to FALSE, else set it TRUE to get specific number or records as mentioned in perpage and page parameters.

By default its FALSE

Fields:

Field name Detail
caller Caller Number
duration Call duration
tracking_number Tracking number
visit_datetime Matched visit date time
call_datetime Call date and time
difference Difference in visit time and call time (you need to enable this feature to get this data)
recording URL of recording if applicable
caller_city Caller city
caller_state Caller state

Correct Response in Comma delimited format:

caller,duration,tracking_number,visit_datetime,call_datetime,difference,recording,caller_city,caller_state 2702526603,00:07:28,8775775451,2012-10-02 23:18:19,2012-10-03 13:02:26,0-day 13:44:07,Not Available,Not Available,Not Available

Note:

  • First row in the result set is field name
  • Each row is separated by “\n”
  • Each column is separated by comma (,)

Correct Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<result>

<data>
<caller>2702526603</caller>
<duration>00:07:28</duration>
<tracking_number>8775775451</tracking_number>
<visit_datetime>2012-10-02 23:18:19</visit_datetime>
<call_datetime>2012-10-03 13:02:26</call_datetime>
<difference>0-day 13:44:07</difference>
<recording>Not Available</recording>
<caller_city>Not Available</caller_city>
<caller_state>Not Available</caller_state>
</data>

</result>

Error Response in Comma Delimited:

startdate,orderby,message

Start date is not a valid date time,Order by is not valid,Error

Error Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<detail>

<startdate>Start date is not a valid date time</startdate>
<orderby>Order by is not valid</orderby>
<message>Error</message>

</detail>

Call Summary

Method name:  call_summary

Parameters to pass:

Parameter name Details
pin code Numeric pin code provided by AvidTrak
This parameter must contain valid PIN Code
startdate Start date in “YYYY-mm-dd hh:mm:ss” format
This parameter must contain valid date in mentioned format
enddate End date in “YYYY-mm-dd hh:mm:ss” format
orderby Provide fieldname from field list below to sort data. By default it will sort by “calls” if you leave blank string in the parameter
ordertype “asc” for ascending and “desc” for descending
By default its asc
perpage Numeric value to get specific number of records
By default its 20
page Numeric value to get records of specific page number if you use “perpage”
By default its 1
xml Pass TRUE to get response in xml format
Pass FALSE to get response in comma delimited format
By default its comma delimited
use_paging If you do not want use paging set this parameter to FALSE, else set it TRUE to get the specific number or records as mentioned in perpage and page parameters.

By default its FALSE

Fields:

Field name Detail
keyword Caller Number
link_source Call duration
calls Tracking number
first_call_datetime Matched visit date time
last_call_datetime Call date and time
visit_datetime Difference in visit time and call time (you need to enable this feature to get this data)
match_type URL of recording if applicable

Correct Response in Comma delimited format:

keyword,link_source,calls,first_call_datetime,last_call_datetime,visit_datetime,match_type sample keyword,Google PPC,6,2013-02-07 06:16:16,2013-02-09 11:12:26,2013-02-07 05:14:30,broad keyword 2,Google PPC,4,2013-02-05 14:23:27,2013-02-09 13:45:16,2013-02-05 13:21:27,broad

Note:

  • First row in the result set is field name
  • Each row is separated by “\n”
  • Each column is separated by comma (,)

Correct Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<result>

<data>
<keyword>sample keyword</keyword>
<link_source>Google PPC</link_source>
<calls>6</calls>
<first_call_datetime>2013-02-07 06:16:16</first_call_datetime>
<last_call_datetime>2013-02-09 11:12:26</last_call_datetime>
<visit_datetime>2013-02-07 05:14:30</visit_datetime>
<match_type>broad</match_type>
</data>
<data>
<keyword>keyword 2</keyword>
<link_source>Google PPC</link_source>
<calls>4</calls>
<first_call_datetime>2013-02-05 14:23:27</first_call_datetime>
<last_call_datetime>2013-02-09 13:45:16</last_call_datetime>
<visit_datetime>2013-02-05 13:21:27</visit_datetime>
<match_type>broad</match_type>
</data>
</result>

Error Response in Comma Delimited:

startdate,orderby,message
Start date is not a valid date time,Order by is not valid,Error

Error Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<detail>

<startdate>Start date is not a valid date time</startdate>
<orderby>Order by is not valid</orderby>
<message>Error</message>

</detail>

Call Summary Detail

By using this function you will get the call details of the specific keywords listed in the results of the “call_summary” method. These details can be obtained by providing the keyword and link source in the parameters.

Method name:  call_summary_detail

Parameters to pass:

Parameter name Details
pin code Numeric pin code provided by AvidTrak
This parameter must contain valid PIN Code
link_source Link source contained in data set of the call_summary method
keyword One keyword obtained from call_summary method
startdate Start date in “YYYY-mm-dd hh:mm:ss” format
This parameter must contain valid date in mentioned format
enddate End date in “YYYY-mm-dd hh:mm:ss” format
orderby Provide fieldname from field list below to sort data. By default it will sort by “calls” if you leave blank string in the parameter
ordertype “asc” for ascending and “desc” for descending
By default its asc
perpage Numeric value to get specific number of records
By default its 20
page Numeric value to get records of specific page number if you use “perpage”
By default its 1
xml Pass TRUE to get response in xml format
Pass FALSE to get response in comma delimited format
By default its comma delimited
use_paging If you do not want use paging set this parameter to FALSE, else set it TRUE to get specific number or records as mentioned in perpage and page parameters.

By default its FALSE

Fields:

Field name Detail
caller Caller Number
keyword Keyword
searched_keyword The keyword searched
duration Call duration
tracking_number Tracking number
visit_datetime Matched visit date time
call_datetime Call date and time
ppc_organic Display whether PPC or Organic call
search_engine Google, yahoo or bing
recording Recording URL
caller_city Caller city
caller_state Caller state
utm_source UTM Sorce
utm_medium UTM Medium
utm_content UTM Content
adposition Ad Position
match_type Keyword type

Correct Response in Comma delimited format:

caller,keyword,searched_query,duration,tracking_number,visit_datetime,call_datetime,ppc_organic,search_engine,recording,caller_city,caller_state,utm_source,utm_medium,utm_content,adposition,match_type 5624326161,keyword 1,search keyword 1,00:12:25,8881234567,2013-02-06 20:31:38,2013-02-07 12:15:59,PPC,google,https://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/RE5382ba27d4f6c47539bb02e86db7f75f.mp3,LONG BEACH,CA,google,ppc,res,Not Available,broad 6145045555,keyword 2,search keyword 2,00:07:18,8881234567,2013-02-07 05:14:30,2013-02-07 06:16:16,PPC,google,https://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/RE8c7315f2ea53fa826f5f7d91b497f002.mp3,PLAIN CITY,OH,google,ppc,res,Not Available,broad

Note:

  • First row in the result set is field name
  • Each row is separated by “\n”
  • Each column is separated by comma (,)


<?xml version=”1.0″ standalone=”yes”?>
<result>

<data>
<caller>5624326161</caller>
<keyword>keyword 1</keyword>
<searched_query>search keyword 1</searched_query>
<duration>00:12:25</duration>
<tracking_number>8881234567</tracking_number>
<visit_datetime>2013-02-06 20:31:38</visit_datetime>
<call_datetime>2013-02-07 12:15:59</call_datetime>
<ppc_organic>PPC</ppc_organic>
<search_engine>google</search_engine>

<recording>
https://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/RE5382ba27d4f6c47539bb02e86db7f75f.mp3</recording >

<caller_city>LONG BEACH</caller_city>
<caller_state>CA</caller_state>
<utm_source>google</utm_source>
<utm_medium>ppc</utm_medium>
<utm_content>res </utm_content>
<adposition>Not Available</adposition>
<match_type>broad</match_type>
</data>

</result>

Error Response in Comma Delimited:

startdate,orderby,message
Start date is not a valid date time,Order by is not valid,Error

Error Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<detail>

 

<startdate>Start date is not a valid date time</startdate>
<orderby>Order by is not valid</orderby>
<message>Error</message>

</detail>

Matched Search Calls

Method name:  matched_search_calls

Parameters to pass:

Parameter name Details
pin code Numeric pin code provided by AvidTrak
This parameter must contain valid PIN Code
startdate Start date in “YYYY-mm-dd hh:mm:ss” format
This parameter must contain valid date in mentioned format
enddate End date in “YYYY-mm-dd hh:mm:ss” format
orderby Provide fieldname from field list below to sort data. By default it will sort by “calls” if you leave blank string in the parameter
ordertype “asc” for ascending and “desc” for descending
By default its asc
perpage Numeric value to get specific number of records
By default its 20
page Numeric value to get records of specific page number if you use “perpage”
By default its 1
xml Pass TRUE to get response in xml format
Pass FALSE to get response in comma delimited format
By default its comma delimited
use_paging If you do not want use paging set this parameter to FALSE, else set it TRUE to get specific number or records as mentioned in perpage and page parameters.

By default its FALSE

Fields:

Field name Detail
keyword Keyword
searched_query The keyword searched
caller Caller Number
duration Call duration
tracking_number Tracking number
visit_datetime Matched visit date time
call_datetime Call date and time
difference Difference between visit and time and call time
ppc_organic Display whether PPC or Organic call
search_engine Google, yahoo or bing
recording Recording URL
city Caller city
state Caller state
direction direction
unique_id Unique ID of analytics
utm_source UTM Sorce
utm_medium UTM Medium
utm_content UTM Content
adposition Ad Position
match_type Keyword type

Correct Response in Comma delimited format:

keyword,searched_query,caller,duration,tracking_number,visit_datetime,call_datetime,difference,ppc_organic,search_engine,
recording,caller_name,city,state,direction,unique_id,utm_source,utm_medium,utm_content,adposition,match_type keyword 1,search query 1,6613804338,00:16:32,8881234567,2013-01-29 13:58:09,2013-01-29 15:07:48,0-day 01:09:39,PPC,google,https://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/RE61281e603a46fa61aafaa7a2d98d2b8b.mp3,Not Available,LOS ANGELES,CA,inbound,696141,google,ppc,res,Not Available,broad keyword 2,Not Available,8475504326,00:04:31,8881234567,2013-01-30 09:46:26,2013-01-30 12:55:40,0-day 03:09:14,PPC,google,https://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/RE1f1d8e8d6640e615f58e44a7e3477bfd.mp3,Not Available,LAKE ZURICH,IL,inbound,418767,google,ppc,res,Not Available,broad

Note:

  • First row in the result set is field name
  • Each row is separated by “\n”
  • Each column is separated by comma (,)

Correct Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<result>

<data>
<keyword>keyword 1</keyword>
<searched_query>query string 1</searched_query>
<caller>6613804338</caller>
<duration>00:16:32</duration>
<tracking_number>8881234567</tracking_number>
<visit_datetime>2013-01-29 13:58:09</visit_datetime>
<call_datetime>2013-01-29 15:07:48</call_datetime>
<difference>0-day 01:09:39</difference>
<ppc_organic>PPC</ppc_organic>
<search_engine>google</search_engine>

<recording>
https://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/RE61281e603a46fa61aafaa7a2d98d2b8b.mp3</recording>

<caller_name>Not Available</caller_name>
<city>LOS ANGELES</city>
<state>CA</state>
<direction>inbound</direction>
<unique_id>696141</unique_id>
<utm_source>google</utm_source>
<utm_medium>ppc</utm_medium>
<utm_content> exterminator</utm_content>
<adposition>Not Available</adposition>
<match_type>broad</match_type>
</data>

</result>

Error Response in Comma Delimited:

startdate,orderby,message
Start date is not a valid date time,Order by is not valid,Error

Error Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<detail>

<startdate>Start date is not a valid date time</startdate>
<orderby>Order by is not valid</orderby>
<message>Error</message>

</detail>

Post Session Calls

Method name:  post_session_calls

Parameters to pass:

Parameter name Details
pin code Numeric pin code provided by AvidTrak
This parameter must contain valid PIN Code
startdate Start date in “YYYY-mm-dd hh:mm:ss” format
This parameter must contain valid date in mentioned format
enddate End date in “YYYY-mm-dd hh:mm:ss” format
orderby Provide fieldname from field list below to sort data. By default it will sort by “calls” if you leave blank string in the parameter
ordertype “asc” for ascending and “desc” for descending
By default its asc
perpage Numeric value to get specific number of records
By default its 20
page Numeric value to get records of specific page number if you use “perpage”
By default its 1
xml Pass TRUE to get response in xml format
Pass FALSE to get response in comma delimited format
By default its comma delimited
use_paging If you do not want use paging set this parameter to FALSE, else set it TRUE to get specific number or records as mentioned in per page and page parameters.

By default its FALSE

Fields:

Field name Detail
caller Caller number
duration Call duration
tracking_number Avid number / tracking number
date_time Call date and time
recording Recording URL if applicable

Correct Response in Comma delimited format:

caller,duration,tracking_number,date_time,recording 904511111,1,8881234567,2013-01-10 – 01:45:14,https://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/REba59f6af32f92fb3cc1ce127b38acac.mp3 918311111,1,8881235687,2013-01-17 – 07:13:00,https://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/REd876a7ccb901971a72035025ba6a172.mp3

Note:

  • First row in the result set is field name
  • Each row is separated by “\n”
  • Each column is separated by comma (,)

Correct Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<result>

<data>
<caller>9045256651</caller>
<duration>1</duration>
<tracking_number>8882930544</tracking_number>
<date_time>2013-01-10 – 01:45:14</date_time>

<recording>http://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/REba59f6af32f92fb3cc1ce127b38ac7ac.mp3</recording>

</data>
<data>
<caller>9183460389</caller>
<duration>1</duration>
<tracking_number>8882892606</tracking_number>
<date_time>2013-01-17 – 07:13:00</date_time>

<recording>http://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/REd876a7ccb901971a72035025ba6a1772.mp3</recording>

</data>

</result>

Error Response in Comma Delimited:

startdate,orderby,message
Start date is not a valid date time,Order by is not valid,Error

Correct Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>

<detail>

<startdate>Start date is not a valid date time</startdate>
<orderby>Order by is not valid</orderby>
<message>Error</message>

</detail>

Lite Campaign

Method name: lite_campaign

Parameters to pass:

Parameter name Details
pin code Numeric pin code provided by AvidTrak
This parameter must contain valid PIN Code
startdate Start date in “YYYY-mm-dd hh:mm:ss” format
This parameter must contain valid date in mentioned format
enddate End date in “YYYY-mm-dd hh:mm:ss” format
orderby Provide fieldname from field list below to sort data. By default it will sort by “calls” if you leave blank string in the parameter
ordertype “asc” for ascending and “desc” for descending
By default its asc
perpage Numeric value to get specific number of records
By default its 20
page Numeric value to get records of specific page number if you use “perpage”
By default its 1
xml Pass TRUE to get response in xml format
Pass FALSE to get response in comma delimited format
By default its comma delimited
use_paging If you do not want use paging set this parameter to FALSE, else set it TRUE to get specific number or records as mentioned in per page and page parameters.

By default its FALSE

Fields:

Field name Detail
affiliate_id ID to be used in campaign call detail
title Campaign Title
tracking_number Avid number
forward_number Forwarding number
calls Number of calls
number_of_comments Number of comments
summed_duration Total call duration
average_call_length Average call length
first_customer_number First caller number
first_call_datetime First call date and time
last_customer_number Last caller number
last_call_datetime Last caller date time
status Campaign status

Correct Response in Comma delimited format:

affiliate_id,title,tracking_number,forward_number,calls,number_of_comments,summed_duration,average_call_length,first_customer_number,first_call_datetime,last_customer_number,last_call_datetime,status 1110,Mobile Advertisement,+18661234567,8661234567,7,0,12,00:01:09,Not Available,Not Available,Not Available,Not Available,Active

Note:

  • First row in the result set is field name
  • Each row is separated by “\n”
  • Each column is separated by comma (,)

Correct Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<result>
<data>
<affiliate_id>1110</affiliate_id>
<title>Mobile Advertisement</title>
<tracking_number>+18664232323</tracking_number>
<forward_number>8661234567</forward_number>
<calls>7</calls>
<nnumber_of_comments>0</nnumber_of_comments>
<summed_duration>12</summed_duration>
<average_call_length>00:01:09</average_call_length>
<first_customer_number>Not Available</first_customer_number>
<first_call_datetime>Not Available</first_call_datetime>
<last_customer_number>Not Available</last_customer_number>
<last_call_datetime>Not Available</last_call_datetime>
<status>Active</status>
</data>

</result>

Error Response in Comma Delimited:

startdate,orderby,message Start date is not a valid date time,Order by is not valid,Error

Error Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<detail>

<startdate>Start date is not a valid date time</startdate>
<orderby>Order by is not valid</orderby>
<message>Error</message>

</detail>

Lite Campaign Call Detail

Method name: lite_campaign_call_detail

Parameters to pass:

Parameter name Details
pin code Numeric pin code provided by AvidTrak
This parameter must contain valid PIN Code
affiliate_id Affiliate ID retrieved from lite_campaign method
startdate Start date in “YYYY-mm-dd hh:mm:ss” format
This parameter must contain valid date in the mentioned format
enddate End date in “YYYY-mm-dd hh:mm:ss” format
orderby Provide fieldname from field list below to sort data. By default it will sort by “calls” if you leave blank string in the parameter
ordertype “asc” for ascending and “desc” for descending
By default its asc
perpage Numeric value to get specific number of records
By default its 20
page Numeric value to get records of specific page number if you use “perpage”
By default its 1
xml Pass TRUE to get response in xml format
Pass FALSE to get response in comma delimited format
By default its comma delimited
use_paging If you do not want use paging set this parameter to FALSE, else set it TRUE to get specific number or records as mentioned in per page and page parameters.

By default its FALSE

Fields:

Field name Detail
caller Caller number
call_date Call date
call_time Call time
call_duration Call duration
tracking_number Tracking number
caller_location Caller location
caller_city Caller city
caller_state State
recording Recording URL if applicable

Correct Response in Comma delimited format:

caller,call_date,call_time,call_duration,tracking_number,caller_location,caller_city,caller_state,recording 6038015417,2013-02-13,11:08:43,00:00:31,8661234567,Not Available,MILFORD,NH,http://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/REf9ebece7a08421bcab92c9c667bb3d3a.mp3 6038015417,2013-02-13,11:09:37,00:00:17,8661234567,Not Available,MILFORD,NH,http://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/RE0fb9398cac14237617bc598b9506dad7.mp3

Note:

  • First row in the result set is field name
  • Each row is separated by “\n”
  • Each column is separated by comma (,)

Correct Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<result>

<data>
<caller>6038015417</caller>
<call_date>2013-02-13</call_date>
<call_time>11:08:43</call_time>
<duration>00:00:31</duration>
<tracking_number>8661234567</tracking_number>
<caller_location>Not Available</caller_location>
<caller_city>MILFORD</caller_city>
<caller_state>NH</caller_state>
<recording>http://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/REf9ebece7a08421bcab92c9c667bb3d3a.mp3</recording>
</data>
<data>
<caller>6038015417</caller>
<call_date>2013-02-13</call_date>
<call_time>11:09:37</call_time>
<duration>00:00:17</duration>
<tracking_number>8661234567</tracking_number>
<caller_location>Not Available</caller_location>
<caller_city>MILFORD</caller_city>
<caller_state>NH</caller_state>
<recording>http://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/RE0fb9398cac14237617bc598b9506dad7.mp3</recording>
</data>

</result>

Error Response in Comma Delimited:

startdate,orderby,message
Start date is not a valid date time,Order by is not valid,Error

Error Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>

<detail>

<startdate>Start date is not a valid date time</startdate>
<orderby>Order by is not valid</orderby>
<message>Error</message>

</detail>

All Lite Calls

Method name: all_lite_calls

Parameters to pass:

Parameter name Details
pin code Numeric pin code provided by AvidTrak
This parameter must contain valid PIN Code
startdate Start date in “YYYY-mm-dd hh:mm:ss” format
This parameter must contain valid date in the mentioned format
enddate End date in “YYYY-mm-dd hh:mm:ss” format
orderby Provide fieldname from field list below to sort data. By default it will sort by “calls” if you leave blank string in the parameter
ordertype “asc” for ascending and “desc” for descending
By default its asc
perpage Numeric value to get specific number of records
By default its 20
page Numeric value to get records of specific page number if you use “perpage”
By default its 1
xml Pass TRUE to get response in xml format
Pass FALSE to get response in comma delimited format
By default its comma delimited
use_paging If you do not want use paging set this parameter to FALSE, else set it TRUE to get specific number or records as mentioned in per page and page parameters.

By default its FALSE

Fields:

Field name Detail
campaign_name Lite campaign name
tracking_number Tracking number / avid number
call_date Call date
call_time Call time
caller Caller number
duration Duration
recording Recording URL if applicable

Correct Response in Comma delimited format:

campaign_name,tracking_number,call_date,call_time,caller,duration,recording Campign Name,8661234567,2013-02-14,11:10:41,2091234567,00:00:35,http://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/REab6d10e4d1774ab110b8c34633d6cf27.mp3

Note:

  • First row in the result set is field name
  • Each row is separated by “\n”
  • Each column is separated by comma (,)

Correct Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<result>

<data>
<campaign_name>my test campaign</campaign_name>
<tracking_number>8661234567</tracking_number>
<call_date>2013-02-14</call_date>
<call_time>11:10:41</call_time>
<caller>2091234567</caller>
<duration>00:00:35</duration>
<difference></difference>
<recording>http://api.twilio.com/2008-08-01/Accounts/ACb50a117afb6c82ee5320a0f9a55309d7/Recordings/REab6d10e4d1774ab110b8c34633d6cf27.mp3</recording>
</data>

</result>

Error Response in Comma Delimited:

startdate,orderby,message
Start date is not a valid date time,Order by is not valid,Error

Error Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>

<detail>

<startdate>Start date is not a valid date time</startdate>
<orderby>Order by is not valid</orderby>
<message>Error</message>

</detail>

Agent Client List

Method name: show_client_summary

Parameters to pass:

Parameter name Details
pin code Numeric pin code provided by AvidTrak
This parameter must contain valid PIN Code
startdate Start date in “YYYY-mm-dd hh:mm:ss” format
This parameter must contain valid date in mentioned format
enddate End date in “YYYY-mm-dd hh:mm:ss” format
orderby Provide fieldname from field list below to sort data. By default it will sort by “calls” if you leave blank string in the parameter
ordertype “asc” for ascending and “desc” for descending
By default its asc
perpage Numeric value to get specific number of records
By default its 20
page Numeric value to get records of specific page number if you use “perpage”
By default its 1
xml Pass TRUE to get response in xml format
Pass FALSE to get response in comma delimited format
By default its comma delimited
use_paging If you do not want use paging set this parameter to FALSE, else set it TRUE to get specific number or records as mentioned in perpage and page parameters.

By default its FALSE

Fields:

Field name Detail
client_id Client ID
client_user_id Client user id
client_email Client email
pro_recording Pro recording status
lite_recording Lite recording status
pro_preamble Preamble on PRO numbers
lite_preamble Preamble on LITE numbers
pro_numbers Total PRO numbers
lite_numbers Total LITE numbers
unassigned_numbers Un-assigned numbers
avid_numbers_status PRO number status
total_visits Total visits (PRO)
pro_calls Total calls (PRO)
lite_calls Total Lite calls
remaining_balance Remaining balance
pro_call_duration Total call duration on PRO numbers
lite_call_duration Total call duration on LITE numbers
date_created Client created date

Correct Response in Comma delimited format:

client_id,client_user_id,client_email,pro_recording,lite_recording,pro_preamble,lite_preamble,pro_numbers,lite_numbers,unassigned_numbers,avid_numbers_status,total_visits,pro_calls,lite_calls,remaining_balance,pro_call_duration,lite_call_duration,date_created 1764,testdemo,testdemo,abc@localhost.com,0,0,0,0,0,0,0,0,1,0,0,0,00:00:00,00:00:00,2012-07-23 03:50:40 1838,kams,kams,abc@gmail.com,0,0,0,0,0,0,0,0,1,0,0,0,00:00:00,00:00:00,2012-09-18 04:58:07

Note:

  • First row in the result set is field name
  • Each row is separated by “\n”
  • Each column is separated by comma (,)

Correct Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<result>

<data>
<client_id>1764</client_id>
<client_user_id>testdemo</client_user_id>
<client_email>abc@localhost.com</client_email>
<pro_recording>0</pro_recording>
<lite_recording>0</lite_recording>
<pro_preamble>0</pro_preamble>
<lite_preamble>0</lite_preamble>
<pro_numbers>0</pro_numbers>
<lite_numbers>0</lite_numbers>
<un_assigned_numbers>0</un_assigned_numbers>
<avid_number_status>1</avid_number_status>
<total_visits>0</total_visits>
<pro_calls>0</pro_calls>
<lite_calls>0</lite_calls>
<remaining_balance>0</remaining_balance>
<pro_call_duration>00:00:00</pro_call_duration>
<lite_call_duration>00:00:00</lite_call_duration>
<date_created>2012-07-23 03:50:40</date_created>
</data>
<data>
<message>success</message>
<client_id>1838</client_id>
<client_user_id>kams</client_user_id>
<client_email>abc@gmail.com</client_email>
<pro_recording>0</pro_recording>
<lite_recording>0</lite_recording>
<pro_preamble>0</pro_preamble>
<lite_preamble>0</lite_preamble>
<pro_numbers>0</pro_numbers>
<lite_numbers>0</lite_numbers>
<un_assigned_numbers>0</un_assigned_numbers>
<avid_number_status>1</avid_number_status>
<total_visits>0</total_visits>
<pro_calls>0</pro_calls>
<lite_calls>0</lite_calls>
<remaining_balance>0</remaining_balance>
<pro_call_duration>00:00:00</pro_call_duration>
<lite_call_duration>00:00:00</lite_call_duration>
<date_created>2012-09-18 04:58:07</date_created>
</data>

</result>

Error Response in Comma Delimited:

startdate,orderby,message
Start date is not a valid date time,Order by is not valid,Error

Error Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>

<detail>

<startdate>Start date is not a valid date time</startdate>
<orderby>Order by is not valid</orderby>
<message>Error</message>

</detail>

Agent Client Group List

Method name: show_group_client

Parameters to pass:

Parameter name Details
pin code Numeric pin code provided by AvidTrak
This parameter must contain valid PIN Code
startdate Start date in “YYYY-mm-dd hh:mm:ss” format
This parameter must contain valid date in mentioned format
enddate End date in “YYYY-mm-dd hh:mm:ss” format
orderby Provide fieldname from field list below to sort data. By default it will sort by “calls” if you leave blank string in the parameter
ordertype “asc” for ascending and “desc” for descending
By default its asc
perpage Numeric value to get specific number of records
By default its 20
page Numeric value to get records of specific page number if you use “perpage”
By default its 1
xml Pass TRUE to get response in xml format
Pass FALSE to get response in comma delimited format
By default its comma delimited
use_paging If you do not want use paging set this parameter to FALSE, else set it TRUE to get specific number or records as mentioned in perpage and page parameters.

By default its FALSE

Fields:

Field name Detail
group_title Group Title
client_count Total client count in group
rec_pro PRO recording status
rec_lite LITErecording status
preamble_pro Preamble on PRO numbers
preamble_lite Preamble on LITE numbers
pro_numbers Total PRO numbers
lite_numbers Total LITE numbers
pro_calls Total calls on PRO numbers
lite_calls Total calls on LITE numbers
pro_call_time PRO numbers call duration
lite_call_time LITE numbers call duration

Correct Response in Comma delimited format:

group_title,client_count,rec_pro,rec_lite,preamble_pro,preamble_lite,pro_numbers,lite_numbers,pro_calls,lite_calls,pro_call_time,lite_call_time test,5,2,0,test,Not Available,5,1,13,2,25,10

Note:

  • First row in the result set is field name
  • Each row is separated by “\n”
  • Each column is separated by comma (,)

Correct Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>
<result>

<data>
< group_title >1764</ group_title >
< client_count >testdemo</ client_count >
< rec_pro>abc@localhost.com</rec_pro>
< rec_lite>0</rec_lite>
< preamble_pro>0</ preamble_pro>
< preamble_lite>0</ preamble_lite>
< pro_numbers>0</ pro_numbers>
< lite_numbers>0</ lite_numbers>
< pro_calls>0</pro_calls>
< lite_calls>0</lite_calls>
< pro_call_time>1</ pro_call_time>
< lite_call_time>0</lite_call_time>
</data>
</result>

Error Response in Comma Delimited:

startdate,orderby,message
Start date is not a valid date time,Order by is not valid,Error

Error Response in XML format:


<?xml version=”1.0″ standalone=”yes”?>

<detail>

<startdate>Start date is not a valid date time</startdate>
<orderby>Order by is not valid</orderby>
<message>Error</message>

</detail>

Clarifications on Pricing for Call Tracking Numbers & Minutes

AvidTrak Numbers come packaged with Call Tracking Software which comprises of a hosted software solution. The call tracking service is a prepaid service which is offered on a month-to-month basis.

Our service fee structure is broken up into:

  • Monthly recurring charges for phone number rental
  • Talk time minutes for inbound phone calls

Monthly Recurring Charges for Phone Number Rental

The phone number rental is collected in advance every month on the 1st of the month. We do not refund monthly rental fee after it has been deducted from your account.

Talk time Minutes for Inbound Phone Calls

Charges for talk time on the phone use accrue daily. Your account will be charged for the amount of talk time incurred by you.

AvidTrak Solves Call Tracking Problems!

Problems  Solutions

How many call tracking numbers do I need for keyword call tracking?

Use the Estimator tool to determine how many phone numbers you will need to perform keyword level call tracking.

What happens if my account balance drops below $0?

If your account balance drops below $0 services to your account may be suspended. It is therefore essential that your account always maintain a positive balance. In the event that your credit card is declined AvidTrak’s billing system will issue a warning email advising you of the issues evidenced with your card. It is therefore important that you keep your billing email updated. Your billing email on file may be verified and/or updated by logging into your account and clicking  My Account > My Account Setting.

How to make a one-time payment in lieu of automatic recharge?

Understand the customer’s digital journey on your website. Learn which pages are working for you in generatinggenerate the highest phone leads calls and sales.

Why Our Customers

AvidTrak!

See the results marketers get by using AvidTrak

- Jhon brad
Aura BrooksGraphic Designer, Owl Eyes

By far the best team I've ever worked with. They truly understood the look I was going for and completely nailed it! I would highly recommend them as a company, you simply just won't find any better team!

Eve CrawfordProduct Designer, That Biz

It was really fun getting to know the team during the project. They were all helpful in answering my questions and made me feel completely at ease. The design ended up being twice as good as I could have ever envisioned!

Jack GrahamCo founder, Coffee Inc

I'm wondering why I never contacted these guys sooner! Seriously, they all have commendable talent in their respective fields and knocked my concept out of the ballpark. Thanks for an amazing experience!

Zak ReidInstructor, Skate Nao

Salient is by far the most astonishing WP theme out there! I literally could not be happier that I chose to buy your theme! Your regular updates and superb attention to detail blows me away every time I visit my new site!

Jake SmithInstructor, Skate Nao

Salient is by far the most astonishing WP theme out there! I literally could not be happier that I chose to buy your theme! Your regular updates and superb attention to detail blows me away every time I visit my new site!

We Pair With Your Marketing Tools

AvidTrak connects to the tools you use to save you time and automate mundane work.

The power to engage billions of customers on a global scale

With our platform and your ideas, you can focus on the marketing that matters.

795+ billion interactions across channels with 99.999% uptime

3+ billion phone numbers in 100+ countries

172,000+ businesses trust AvidTrak for communications with enterprise-grade security

READY TO GET MARKETING CLARITY?

Lets Start with Free Trial

Sign up

Free 14-day trial No credit card required