MethodEndpointDescription
GET/bi/report/api:listList reports available to the currently signed user.
GET/bi/report/api:list/QUERYList reports available to the currently signed user filtered by the provided search query.
GET/bi/report/api:detail/REPORT_IDShows the detail including views list for selected report specified by REPORT_ID.
GET/bi/report/api:viewDetail/REPORT_VIEW_IDLoads the view detail with data. Not available for images and maps.
GET/bi/report/api:comments/REPORT_IDList comments for the report specified by REPORT_ID.
POST/bi/report/api:addComment/REPORT_ID?text=comments textAdd comment to the report specified by REPORT_ID.
POST/bi/report/api:removeComments/REPORT_ID?id=COMMENT_IDRemove comment COMMENT_ID from the report specified by REPORT_ID.
POST/bi/report/api:editComment/REPORT_ID?id=COMMENT_ID&text=:newtextEdit 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=:idQueryApplies a drill-down to the table
POST/report/api:tableRollup/:viewReportId?identifierQuery=:idQueryCollapses a drill-down of the table
GET/bi/report/api:getFilterDrilldownAttributeValues/:reportId?filter=:valuesFilter&code=:attributeCode&selectedValues=:alreadySelectedValuesLoads report filters
POST/bi/report/api:setFilter/:reportId?filter=:filterToSetApplies changes to report filter
POST/bi/report/api:setVariables/REPORT_ID?code=valueSets value to report variable
GET/bi/report/api:filterUrl/REPORT_IDGet set report filters
GET/bi/report/api:viewFilterUrl/REPORT_VIEW_IDGet set view filters
GET/bi/report/api:addIndicator/REPORT_VIEW_ID?code=M_INDICATORCODE&color=ff0000&axisRight=true&unit=USD&format=%23.00Sets new indicator to view. Color and axis are optional. If not saved, then it will be only for current session. Color, unit and format are optional
GET/bi/report/api:removeIndicator/REPORT_VIEW_ID?code=M_INDICATORRemoves indicator from view. If not saved, then it will be only for current session
GET/POST/bi/report/api:replaceIndicators/REPORT_VIEW_ID?code=M_INDICATORCODE&color=ff0000&unit=USD&format=%23.00Removes all set indicators and adds selected indicators. Color, unit and format are optional

Special characters in "QUERY" in Endpoint "/bi/report/api:list/QUERY" should be encoded as following: "word1 word2" -> "word1$0020word2".

Listing reports example

Following code will list all reports as JavaScript objects for currently signed user.

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.

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);
		}
	}
});



  • No labels