logo

The API url to access the repoting API is: http(s)://api.dxi.eu/reporting.php?token=... To access all DXI API interfaces, all requests need to have an access token which will authorize requests for a particular account for a fixed period of time. These requests are also restricted to the internet address that requested the token. The token API documentation can be read here. The Reporting API has a number of available functions. The request arguments can all be passed as HTTP POST or GET variables: RESULT The response from the API can be formatted in either JSON or XML format. The default is JSON but this can be modified by the format argument. The API will output a number of optional values depending on the request made. However every request will return a success value, essentially denoting if the request failed or not. success: Did the request succeed. value: true or false (JSON) | 1 or 0 (XML) error: If the request failed, this field will contain a description of the fault. total: The total number of possible values returned. This is irrespective of the limit or start arguments, see below, so the total can be different to the actual size of the returned list. Example JSON return: {"success":true} {"success":false,"error":"Bad argument: xyz"} Example XML return: <result><success>1</success></result> <result><success>1</success><error>Bad argument: xyz</error></result> REQUIRED ARGUMENTS method: the particular set of reporting data to return. fields: a comma seperated list of the statistics that should be returned from the requested method. EXPORT FILTERS isset: a comma seperated list of the fields that must contain non-empty values to return the data row. agent: a comma seperated list of agent id's to filter by. queue: a comma seperated list of queue id's to filter by. qtype: a comma seperated list of queue types to filter by. dataset: a comma seperated list of dataset id's to filter by. outcome: a comma seperated list of outcome id's to filter by. campaign: the campaign id to filter by. groupby: a comma seperated list of fields to group the result by. range: the time range to run the request over. the format is <ts_from>:<ts_to> where the ts_from and ts_to are timestamps are in unix / epoch format: the number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time. if the ts_to argument is omitted then it is assumed to the be current time. OPTIONAL ARGUMENTS The following are arguments available on all applicable requests. format: xml or json - specify the output format. Defaults to json.
API METHODS
method: agents
Return various agent based statistics. method: agents reporting.php?method=agents&... Required Arguments range Fields aid: the agent id. anm: the agent name. tm_login: the earlier time the agent logged into the system during the requested period. tm_logout: the lastest time the agent logged out of the system during the requested period. tm_first: the time of the first call the agent handled during the requested the period. tm_last: the time of the last call the agent handled during the requested the period. All times are in epoch timestamp format. Examples Return agents statistics for a given time range, only for agents that logged in during that period: reporting.php?token=<token>&method=agents&campaign=3869&fields=aid,anm,tm_login,tm_logout,tm_first,tm_last&isset=tm_login&range=1341183600:1341270000 <entry> <aid>1234</aid> <anm>My Test Agent</anm> <tm_login>1341211994</tm_login> <tm_logout>1341243041</tm_logout> <tm_first>1341218163</tm_first> <tm_last>1341236093</tm_last> </entry>
method: records
Return various dialer record based statistics. method: records reporting.php?method=records&... Required Arguments none Fields aid: the agent id. anm: the agent name. qid: the queue id. qnm: the queue name. cid: the campaign id. cnm: the campaign name. dsid: the dataset id. rec_all: number of live records, not on hold. rec_hold: number of records on hold. rec_now: number of records available to dial now. rec_later: number of records with callback times in the future. rec_new: number of records never dialed. rec_cbck_all: number of agent callbacks set. rec_cbck_now: number of agent callbacks available to dial now. rec_cbck_later: number of agent callbacks with callback times in the future. Examples Return records statistics for all queues with loaded data: reporting.php?token=<token>&method=records&fields=qid,qnm,rec_all,rec_hold,rec_now,rec_new&isset=rec_all <entry> <qid>1234</qid> <qnm>My Test Queue</qnm> <rec_all>1000</rec_all> <rec_hold>0</rec_hold> <rec_now>600</rec_now> <rec_later>400</rec_later> <rec_new>500</rec_new> </entry>
method: calls
Return various call based statistics. method: calls reporting.php?method=calls&... Required Arguments range groupby Fields aid: the agent id. anm: the agent name. qid: the queue id. qnm: the queue name. cid: the campaign id. cnm: the campaign name. dsid: the dataset id. date: the date of the call. hour: the hour of the call. nc_all: total number of calls. nc_in: number of inbound calls. nc_out: number of outbound calls. nc_man: number of manual calls. nc_tpt: number of third-party calls. nc_ans: number of calls placed in queuing system and answered by an agent. nc_que: number of calls placed in queuing system but not answered. sec_talk: sum of agent talk time sec_tpt: sum of agent third party talk time sec_wait: sum of agent wait time sec_wrap: sum of agent wrap time sec_talk_all: sum of both sec_talk and sec_tpt ocid: the call outcome id. ocnm: the call outcome name. ocis_sale: boolean flag if the outcome is a sale. ocis_compl: boolean flag if the outcome is a complete (excluding sales). ocis_dmc: boolean flag if the outcome is a complete. cres: the result type of the call. oc_abdn: number of outcomes - abandoned calls oc_cbck: number of outcomes - callbacks set oc_ama: number of outcomes - answer machine (agent) oc_amd: number of outcomes - answer machine (dialer) oc_dead: number of outcomes - dead lines oc_sale: number of outcomes - sales oc_cmpl: number of outcomes - completes (excluding sales) oc_ncmpl: number of outcomes - not completes oc_dmc: number of outcomes - DMC's Examples Return daily statistics per agent reporting.php?token=<token>&method=calls&campaign=3869&fields=date,aid,anm,nc_all,nc_in,nc_out,nc_man,sec_talk,sec_wait,sec_wrap&groupby=date,aid&range=1341183600:1341270000 <entry> <date>2012-07-02</date> <aid>1234</aid> <anm>Agent #1</anm> <nc_all>7</nc_all> <nc_in>3</nc_in> <nc_out>0</nc_out> <nc_man>4</nc_man> <sec_talk>774.56</sec_talk> <sec_wait>9474.71</sec_wait> <sec_wrap>1477.78</sec_wrap> </entry> <entry> <date>2012-07-02</date> <aid>1235</aid> <anm>Agent #2</anm> <nc_all>7</nc_all> <nc_in>7</nc_in> <nc_out>0</nc_out> <nc_man>0</nc_man> <sec_talk>1841.30</sec_talk> <sec_wait>16403.86</sec_wait> <sec_wrap>66.60</sec_wrap> </entry> Return hourly statistics per queue reporting.php?token=<token>&method=calls&fields=date,hour,qid,qnm,nc_all,nc_in,nc_out,nc_man,oc_abdn&groupby=date,hour,qid&range=1341183600:1341270000 <entry> <date>2012-07-02</date> <hour>9</hour> <qid>1234</qid> <qnm>Sales</qnm> <nc_all>24</nc_all> <nc_in>1</nc_in> <nc_out>0</nc_out> <nc_man>0</nc_man> <oc_abdn>0</oc_abdn> </entry> <entry> <date>2012-07-02</date> <hour>9</hour> <qid>2345</qid> <qnm>Support</qnm> <nc_all>1</nc_all> <nc_in>1</nc_in> <nc_out>0</nc_out> <nc_man>0</nc_man> <oc_abdn>0</oc_abdn> </entry> <entry> <date>2012-07-02</date> <hour>10</hour> <qid>2345</qid> <qnm>Support</qnm> <nc_all>1</nc_all> <nc_in>1</nc_in> <nc_out>0</nc_out> <nc_man>0</nc_man> <oc_abdn>0</oc_abdn> </entry> <entry> <date>2012-07-02</date> <hour>10</hour> <qid>1234</qid> <qnm>Sales</qnm> <nc_all>15</nc_all> <nc_in>1</nc_in> <nc_out>0</nc_out> <nc_man>0</nc_man> <oc_abdn>0</oc_abdn> </entry> <entry> <date>2012-07-02</date> <hour>11</hour> <qid>1234</qid> <qnm>Sales</qnm> <nc_all>33</nc_all> <nc_in>1</nc_in> <nc_out>0</nc_out> <nc_man>0</nc_man> <oc_abdn>0</oc_abdn> </entry>