Skip to main content

Method allows you to return an excel report, filtered by data you have specified. You can obtain reports' IDs using this webservice.

Filtering options

Parameter NameRequired?Notes
fromYesYYYY-MM-DD date of begining of the gathered data, i.e. 2015-05-01
toYesYYYY-MM-DD date of begining of the gathered data, i.e. 2015-05-31.
officesNoNumeric IDs of the offices to be included in the report. If no offices, teams or profiles specified, report will be generated for all users with sorted under their respective offices and teams
teamsNoNumeric IDs of the teams to be included in the report. If no offices, teams or profiles specified, report will be generated for all users with sorted under their respective offices and teams
profilesNoNumeric IDs of the users to be included in the report. If no offices, teams or profiles specified, report will be generated for all users with sorted under their respective offices and teams
include-inactiveNoYes or No with No as default. If set to yes, will include data from users that did not make any posting in the specified reporting period.
boardsNoNumeric IDs of the portals to be included in the report. If no portal ids specified, report will be generated for all portals subscribed on the specified account
emailYesEmail where the requested report should be emailed to.
watchdogNoWhen generating a report, you may wish to set it, so the very same report will be sent to the same person periodically. You need to name your watchdog, choose how often will it be sent and the period it will include (the original from to dates will be ignored once the watchdog report will be ready). The original report (that is triggering the watchdog) will respect the provided period.

Example

Request

POST https://ws.idibu.com/ws/rest/v1/reports/(REPORT_ID)?hash=

BASIC:

<idibu>
<date-range>
<from>2015-05-01</from>
<to>2015-05-28</to>
</date-range>
<profiles>
<offices />
<teams />
<profiles />
<include-inactive>no</include-inactive>
</profiles>
<boards />
<email>yourclient@hisserver.com</email>
</idibu>

WITH MORE PARAMETERS:

<idibu>
<date-range>
<from>2015-05-01</from>
<to>2015-05-28</to>
</date-range>
<profiles>
<offices>
<office>1000</office>
</offices>
<teams>
<team>1001</team>
<team>1002</team>
<team>1003</team>
</teams>
<profiles>
<profile>1004</profile>
<profile>1005</profile>
<profile>1006</profile>
</profiles>
<include-inactive>no</include-inactive>
</profiles>
<boards>
<board>1599</board>
</boards>
<email>yourclient@hisserver.com</email>
<watchdog>
<name>new_watchdog</name>
<frequency>monthly</frequency>
<range>month</range>
</watchdog>
</idibu>

Response

<?xml version="1.0" encoding="UTF-8"?>
<idibu generator="idibu" version="1.0">
<response>
<message>Report queued for processing</message>
</response>
<status>success</status>
</idibu>