| Method | Endpoint | Description |
|---|
| GET | /bi/report/api:list | List reports available to the currently signed user. | | GET | /bi/report/api:list/QUERY | List reports available to the currently signed user filtered by the provided search query. | | GET | /bi/report/api:detail/REPORT_ID | Shows the detail including views list for selected report specified by REPORT_ID. | | GET | /bi/report/api:viewDetail/REPORT_VIEW_ID | Loads the view detail with data. Not available for images and maps. | | GET | /bi/report/api:comments/REPORT_ID | List comments for the report specified by REPORT_ID. | | POST | /bi/report/api:addComment/REPORT_ID?text=comments text | Add comment to the report specified by REPORT_ID. | | POST | /bi/report/api:removeComments/REPORT_ID?id=COMMENT_ID | Remove comment COMMENT_ID from the report specified by REPORT_ID. | | POST | /bi/report/api:editComment/REPORT_ID?id=COMMENT_ID&text=NEWTEXT | Edit comment COMMENT_ID from the report specified by REPORT_ID. | | GET/POST | /bi/report/api:forceDataTableName/REPORT_ID/DATA_TABLE_NAME | Sets custom table name to load data from different database table. | | GET/POST | /bi/report/api:clearcache/REPORT_ID | Deletes report cache | | POST | /report/api:tableDrilldown/:viewReportId?identifierQuery=:idQuery | Applies a drill-down to the table | | POST | /report/api:tableRollup/:viewReportId?identifierQuery=:idQuery | Collapses a drill-down of the table | | GET | /bi/report/api:getFilterDrilldownAttributeValues/:reportId?filter=:valuesFilter&code=:attributeCode&selectedValues=:alreadySelectedValues | Loads report filters | | POST | /bi/report/api:setFilter/:reportId?filter=:filterToSet | Applies changes to report filter |
| Info |
|---|
Special characters in "QUERY" in Endpoint "/bi/report/api:list/QUERY" should be encoded as following: "word1 word2" -> "word1$0020word2". |
Listing reports exampleFollowing code will list all reports as JavaScript objects for currently signed user. | Code Block |
|---|
| title | Listing reports as objects |
|---|
| $.ajax({
url: "https://service.belladati.com/bi/report/api:list",
success: function(reply) {
console.log(reply);
}
}); |
Following code will list all report object parameters (description,id,link,name,tags) for all reports of currently signed user. | Code Block |
|---|
| title | Listing reports parameters |
|---|
| $.ajax({
url: "https://service.belladati.com/bi/report/api:list",
success: function(reply) {
for (i = 0; reply.length; i = i + 1) {
console.log(reply[i].name);
}
}
}); |
|