Analytics API

Overview

With the Agendize Analytics API, you can access all of your Agendize reporting data.

Request

Authentication

To use the Data API you must authenticate yourself using your Agendize email and password. See the authentication documentation for details on the authentication mechanisms available and how to use them.

API Methods

Get Call Details

URL Format:
[GET] https://www.agendize.com/api/1.0/data?key=XXXXXXX&scope=callDetails
Parameters:
Name Description Required Values
key API Key Y  
scope Data Scope Y callDetails
start-date Start of Date Range Y Format: yyyy-MM-dd
end-date End of Date Range Y Format: yyyy-MM-dd
Response :

Example:

<?xml version="1.0" encoding="UTF-8"?>
<agendize>
	<entry scope="callDetails">
		<entry:value name="button-id" type="string" value="XXXXXXX"/>
		<entry:value name="caller-number" type="string" value="+155578974"/>
		<entry:value name="called-number" type="string" value="+155545129"/>
		<entry:value name="duration" type="number" value="56"/>
		<entry:value name="date" type="date" value="20110311T09:23:15"/>		
	</entry>
	<entry scope="callDetails">
		<entry:value name="button-id" type="string" value="XXXXXXX"/>
		<entry:value name="caller-number" type="string" value="+1555415263"/>
		<entry:value name="called-number" type="string" value="+1555964596"/v
		<entry:value name="duration" type="number" value="126"/>
		<entry:value name="date" type="date" value="20110311T09:23:15"/>	
	</entry>
</agendize>

Get Call Tracking Details

URL Format:
[GET] https://www.agendize.com/api/1.0/data?key=XXXXXXX&scope=callTrackingDetails
Parameters:
Name Description Required Values
key API Key Y  
scope Data Scope Y callTrackingDetails
start-date Start of Date Range Y Format: yyyy-MM-dd
end-date End of Date Range Y Format: yyyy-MM-dd
phone Call tracking phone number, caller phone number or called phone number N +xxxxxxxxxx
Response :

Example:

<?xml version="1.0" encoding="UTF-8"?>
<agendize>
	<entry scope="callTrackingDetails">
		<entry:value name="button-id" type="string" value="XXXXXXX"/>
		<entry:value name="caller-number" type="string" value="+184564378"/>
		<entry:value name="called-number" type="string" value="+185467753"/>
		<entry:value name="duration" type="number" value="56"/>
		<entry:value name="date" type="date" value="20130211T11:24:45"/>
		<entry:value name="voice-file" type="string" value="https://www.agendize.com/rpc/reporting/voicefile?author=xxxxxxxxxxx&u=fa5787543efc67854ca456"/>	
		<entry:value name="type" type="string" value="Print directory"/> 
		<entry:value name="support" type="string" value="support"/>
		<entry:value name="misc1" type="string" value="misc 1"/>
		<entry:value name="misc2" type="string" value="misc 2"/>
		<entry:value name="misc3" type="string" value="misc 3"/>
		<entry:value name="misc4" type="string" value="misc 4"/>
		<entry:value name="misc5" type="string" value="misc 5"/>
		<entry:value name="misc6" type="string" value="misc 6"/>
		<entry:value name="misc7" type="string" value="misc 7"/>
		<entry:value name="misc8" type="string" value="misc 8"/>
		<entry:value name="misc9" type="string" value="misc 9"/>
		<entry:value name="misc10" type="string" value="misc 10"/>
		<entry:value name="notes" type="string" value=""/>
		<entry:value name="cost-amount" type="string" value="20"/>
		<entry:value name="cost-period" type="string" value="Monthly"/> 
		<entry:value name="publication-start-date" type="string" value="2013-11-11"/> <!--  yyyy-MM-dd -->
		<entry:value name="publication-end-date" type="string" value="2013-11-12"/> <!--  yyyy-MM-dd -->	
		<entry:value name="voice-file" type="string" value="https://www.agendize.com/rpc/reporting/voicefile?author=xxxxxxxxxxx&u=6543ab5432e68a564c4567f"/>	
	</entry>
	<entry scope="callTrackingDetails">
		<entry:value name="button-id" type="string" value="XXXXXXX"/>
		<entry:value name="caller-number" type="string" value="+1845676538"/>
		<entry:value name="called-number" type="string" value="+1865456778"/>
		<entry:value name="duration" type="number" value="543"/>
		<entry:value name="date" type="date" value="20130211T10:65:46"/>
		<entry:value name="voice-file" type="string" value="https://www.agendize.com/rpc/reporting/voicefile?author=xxxxxxxxxxx&u=fa5787543efc67854ca456"/>	
		<entry:value name="type" type="string" value="Print directory"/> 
		<entry:value name="support" type="string" value="support"/>
		<entry:value name="misc1" type="string" value="misc 1"/>
		<entry:value name="misc2" type="string" value="misc 2"/>
		<entry:value name="misc3" type="string" value="misc 3"/>
		<entry:value name="misc4" type="string" value="misc 4"/>
		<entry:value name="misc5" type="string" value="misc 5"/>
		<entry:value name="misc6" type="string" value="misc 6"/>
		<entry:value name="misc7" type="string" value="misc 7"/>
		<entry:value name="misc8" type="string" value="misc 8"/>
		<entry:value name="misc9" type="string" value="misc 9"/>
		<entry:value name="misc10" type="string" value="misc 10"/>
		<entry:value name="notes" type="string" value=""/>
		<entry:value name="cost-amount" type="string" value="20"/>
		<entry:value name="cost-period" type="string" value="Monthly"/> 
		<entry:value name="publication-start-date" type="string" value="2013-11-11"/> <!--  yyyy-MM-dd-->
		<entry:value name="publication-end-date" type="string" value="2013-11-12"/> <!--  yyyy-MM-dd -->
	</entry>
</agendize>

Get Comment & Rating Details

URL Format:
[GET] https://www.agendize.com/api/1.0/data?key=XXXXXXX&scope=reviewDetails
Parameters:
Name Description Required Values
key API Key Y  
scope Data Scope Y reviewDetails
start-date Start of Date Range Y Format: yyyy-MM-dd
end-date End of Date Range Y Format: yyyy-MM-dd
Response :

Example:

<?xml version="1.0" encoding="UTF-8"?>
<agendize>
	<entry scope="reviewDetails">
		<entry:value name="button-id" type="string" value="XXXXXXX"/>
		<entry:value name="review-id" type="string" value="XXXXXXX"/>
		<entry:value name="nickname" type="string" value="john"/>
		<entry:value name="email" type="string" value="john@acme.com"/>
		<entry:value name="published" type="boolean" value="true"/>
		<entry:value name="title" type="string" value=""/>
		<entry:value name="rating" type="number" value="3"/>
		<entry:value name="date" type="date" value="20110310T08:52:26"/>
		<review-content>This restaurant is amazing</review-content>
	</entry>	
</agendize>

Get Engagement by Feature

URL Format:
[GET] https://www.agendize.com/api/1.0/data?key=XXXXXXX&scope=medias
Parameters:
Name Description Required Values
key API Key Y  
scope Data Scope Y medias
start-date Start of Date Range Y Format: yyyy-MM-dd
end-date End of Date Range Y Format: yyyy-MM-dd
Response :

Example:

<?xml version="1.0" encoding="UTF-8"?>
<agendize>
	<entry scope="medias">
		<entry:value name="media" type="string" value="sms"/>
		<entry:value name="count" type="number" value="50"/>
	</entry>
	<entry scope="medias">
		<entry:value name="media" type="string" value="call"/>
		<entry:value name="count" type="number" value="12"/>
	</entry>
	<entry scope="medias">
		<entry:value name="media" type="string" value="scheduling"/>
		<entry:value name="count" type="number" value="4"/>
	</entry>
</agendize>

Get Form Results

URL Format:
[GET] https://www.agendize.com/api/1.0/data?key=XXXXXXX&scope=formResults
Parameters:
Name Description Required Values
key API Key Y  
scope Data Scope Y formResults
start-date Start of Date Range Y Format: yyyy-MM-dd
end-date End of Date Range Y Format: yyyy-MM-dd
id Specific Form ID N  
Response :

Example:

<?xml version="1.0" encoding="UTF-8"?> 
<agendize xmlns:entry="http://www.agendize.com/XML/namespace" xmlns:form="http://www.agendize.com/XML/namespace" xmlns:chat="http://www.agendize.com/XML/namespace"> 
<entry scope="formResult"> 
	<entry:value name="form-id" type="string" value="XXXXXXX"/>
	<entry:value name="result-id" type="string" value="XXXXXXX"/> 
	<entry:value name="date" type="string" value="20101210T05:06:16"/> 
	<form:field id="XXXXXXX" order="0" label="Message" type="textarea" mandatory="false"><form:result>Hello, I want to contact you!</form:result></form:field> 
	<form:field id="XXXXXXX" order="0" label="Phone Number" type="phone" mandatory="true"><form:result>555-666-7890</form:result></form:field> 
	<form:field id="XXXXXXX" order="0" label="Email Address:" type="email" mandatory="true"><form:result>none@acme.com</form:result></form:field> 
</entry>
<entry scope="formResult"> 
	<entry:value name="form-id" type="string" value="XXXXXXX"/> 
	<entry:value name="result-id" type="string" value="XXXXXXX"/> 
	<entry:value name="date" type="string" value="20110124T04:23:21"/> 
	<form:field id="XXXXXXX" order="0" label="Message" type="textarea" mandatory="false"><form:result>My Message</form:result></form:field> 
	<form:field id="XXXXXXX" order="0" label="Phone Number" type="phone" mandatory="true"><form:result>555-666-1234</form:result></form:field> 
	<form:field id="XXXXXXX" order="0" label="Email Address:" type="email" mandatory="true"><form:result>contact@acme.com</form:result></form:field> 
</entry> 
</agendize> 

Get Chat History

URL Format:
[GET] https://www.agendize.com/api/1.0/data?key=XXXXXXX&scope=chatHistory
Parameters:
Name Description Required Values
key API Key Y  
scope Data Scope Y chatHistory
start-date Start of Date Range Y Format: yyyy-MM-dd
end-date End of Date Range Y Format: yyyy-MM-dd
id Specific Chat Button ID N  
Response :

Example:

<?xml version="1.0" encoding="UTF-8"?> 
<agendize xmlns:entry="http://www.agendize.com/XML/namespace" xmlns:form="http://www.agendize.com/XML/namespace" xmlns:chat="http://www.agendize.com/XML/namespace">
<entry scope="chatHistory"> 
	<entry:value name="chat-id" type="string" value="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"/> 
	<entry:value name="nickname" type="string" value="smith@acme.com"/> 
	<entry:value name="start-page" type="string" value="http://www.acme.com/mypage"/> 
	<entry:value name="user-agent-browser" type="string" value="Firefox 6.0.2"/> 
	<entry:value name="user-agent-operating-system" type="string" value="Windows Vista"/> 
	<entry:value name="location-country" type="string" value="US"/> 
	<entry:value name="location-city" type="string" value="CHICAGO"/> 
	<entry:value name="date" type="string" value="20120511T14:00:28"/> 
	<entry:value name="button-id" type="string" value="xxxxx"/> 
	<chat:message message-id="8c07615b5d20d6c2bb82c118907e44141316188828582" mode="1" date="20120511T14:00:28">Can you help me?</chat:message> 
	<chat:message message-id="8c07615b5d20d6c2bb82c118907e44141316188837398" mode="0" date="20120511T14:00:32">Yes, of course</chat:message> 
	<chat:message message-id="8c07615b5d20d6c2bb82c118907e44141316188838757" mode="1" date="20120511T14:00:54">What time is it?</chat:message> 
	<chat:message message-id="8c07615b5d20d6c2bb82c118907e44141316188839477" mode="0" date="20120511T14:01:05">5 o'clock</chat:message> 
	<chat:message message-id="8c07615b5d20d6c2bb82c118907e44141316188839477" mode="0" date="20120511T14:01:12">Thank!</chat:message> 
</entry>
</agendize>  

Send Report by Email

URL Format:
[GET] https://www.agendize.com/api/1.0/data?key=XXXXXXX&scope=analyticsEmail
Parameters:
Name Description Required Values
key API Key Y  
scope Data Scope Y analyticsEmail
start-date Start of Date Range Y Format: yyyy-MM-dd
end-date End of Date Range Y Format: yyyy-MM-dd
id Report ID Y  
destination Destination Email Addresses Y separated comma email addresses
format Export File Format Y pdf, csv or xml
Response :

Example:

<?xml version="1.0" encoding="UTF-8"?>

	200	

Export Report

URL Format:
[GET] https://www.agendize.com/api/1.0/data?key=XXXXXXX&scope=analyticsExport
Parameters:
Name Description Required Values
key API Key Y  
scope Data Scope Y analyticsExport
start-date Start of Date Range Y Format: yyyy-MM-dd
end-date End of Date Range Y Format: yyyy-MM-dd
id Report ID Y  
format Export File Format Y pdf, csv or xml
Response :

The HTTP response is the anaytics file exported in the requested format.

List Custom Analytics Reports

URL Format:
[GET] https://www.agendize.com/api/1.0/data?key=XXXXXXX&scope=reportList
Parameters:
Name Description Required Values
key API Key Y No API Key? Get one here
scope Data Scope Y reportList
Response :

Example:

<?xml version="1.0" encoding="UTF-8"?>

	
		<entry:value name="report-id" type="string" value="XXXXXXX"/>
		<entry:value name="name" type="string" value="My Report Name"/>				
	</entry>