Saba Analytics APIs

• Report

  • List Methods
  • Expand Methods

  • GETGet report list/analytics/report/list
    Gets the list of report as a service enabled report definition
    
    

    Parameter	Value	Type	Location	Description
    category		string	query	Report category
    audienceType		string	query	Audience Type

  • GETGet report definition/analytics/report/definition/:reportId
    Gets the detailed report definition
    
    

    Parameter	Value	Type	Location	Description
    reportId		string	query	Report id
    audienceType		string	query	Audience Type

  • POSTExecute report/analytics/report/execute/:reportId/:chartId
    This API will execute the report in the synchronous / asynchronous (depending upon the configuration)
    
    

    Parameter	Value	Type	Location	Description
    reportId		string	query	Report id
    chartId		string	query	Chart id
    audienceType		string	query	Audience Type
    @type		string	query	Execution parameters
    pageSize		string	query	Page size
    pageNumber		string	query	Page number
    filter		string	query	Filter object

  • GETReport async execution status/analytics/report/execution/status/:reportRunId
    This API will return the execution status of the async report
    
    

    Parameter	Value	Type	Location	Description
    reportRunId		string	query	Report run id

  • POSTExecute async report/analytics/report/execute/:reportId/:chartId
    This API will fetch the data of the report which was executed in the async mode
    
    

    Parameter	Value	Type	Location	Description
    reportId		string	query	Report id
    chartId		string	query	Chart id
    reportRunId		string	query	Report run id (Required to execute an async report)