Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This section details how to get the download URL for a specific report using API.

Please read this /wiki/spaces/Fuse/pages/2847670275before using this resource.

A prerequisite to obtaining a report via API is having an Admin of your Fuse Environment create a Report using the “Reporting (Beta)” tool via the Fuse Admin page. The Admin person is required to share the “Title of the Report” with the Tech person building the integrations Via API.

Admin Panel Icon:

...

The Custom Reports currently available are:

  • Learning Plan Report

  • SCORM Report

  • User Report

Recourse URL:

  • https://<instance_name>.fuseuniversal.com/site-admin/reporting

To get the download URL for a report generated using the “Reporting (Beta)” tool via the Fuse Admin page, run the below API Request URL to get the signed S3 download link:

Info

Please use the request examples as reference.

Note

The request example doesn’t include all the possible parameters.

Note

The download URL that is provided in the "report_download_url" and "signed_download_url" sections of the Response Body is what is to be used for the CSV download, and is valid for 1 hour (60 min) after the report URL has been generated by the API. Here is an example:
"signed_download_url": "https://fusion-universal-assets-production.s3-eu-west-1.amazonaws.com/report-engine/<rest_of_URL>"

Get Report details with the Title of the Report:

GET /compliance_reporting/reports/all

GET https://<instance>.fuseuniversal.com/api/v4.4/compliance_reporting/reports/all?query=<title_of_required_report>&auth_token==xxxxx

The Above request will return

Code Block
{
  "total_count": 1,
  "last_page": true,
  "reports": [
    {
      "title": "Title of Report",             <-- Title of Report
      "id": 987654321,                         <-- ID of Report
      "report_created_by": "Report Owner",
      "created_at": "2024-02-22T12:05:58.000Z",
      "report_type_code": "learning_plan_status_custom",
      "tag": "Learning plan report",
      "executions": [
        {
          "execution_id": 12345678,             <-- Execution ID of Report
          "started_at": "2024-02-26 23:01:48",
          "report_executed_by": 12040315,
          "report_status": "success",
          "report_download_url": "https://fusion-universal-assets-production.s3-eu-west-1.amazonaws.com/report-engine/xxxxxx"
        },
     ]
    }
  ]
}
Info

The execution_id returned in the above response can be used in the API shown below

Obtain Signed AWS download link to download latest Execution ID:

GET /compliance_reporting/download_report/{execution_id}

GET https://<instance_name>.fuseuniversal.com/api/v4.4/compliance_reporting/download_report/<execution_id>?auth_token=<valid_auth_token>

The above will return the following:

...

With Fuse’s compliance reporting integration, you can use Fuse’s RESTful APIs to pull data directly from custom reports you’ve generated in the Reporting screen, and publish them as interactive data visualisations, such as charts or graphs in an analytics platform of your choice. For example, if you use Power BI, you might want to pull data from custom reports you have generated and publish it as an interactive chart, graph or other data visualisations in Power BI.

Key features

Build and manage the data you wish to integrate by creating filtered reports in our easy-to-use reporting UI, and then deliver that data to your desired data visualisation platform using our RESTful APIs.

AWS signed download link

We use secure AWS-signed download links to ensure the confidentiality and integrity of your data during transfer. This feature guarantees that only authorised users can access the reports, mitigating the risk of unauthorised access.

Flexible report retrieval

Our module enables users to retrieve reports based on their specific requirements. Whether you need complete reports or delta changes from the previous report, our system offers flexibility to accommodate your needs effectively.

Integration with data warehouses

Seamlessly integrate our reports into your data warehouses to streamline data management processes. This integration enables you to consolidate and analyse data efficiently, facilitating informed decision-making and compliance monitoring.

Compatibility with data visualisation software

Our reports are compatible with various data visualisation software, empowering you to transform raw data in a CSV into meaningful insights. Visualise trends, patterns, and anomalies effortlessly to gain valuable insights into your compliance learning in Fuse.

Benefits

Simplify data management processes by leveraging our module's API capabilities to retrieve and integrate reports seamlessly. Reduce manual effort and enhance operational efficiency.

Insightful data visualisation

Unlock the power of data visualisation by leveraging our reports with compatible data visualisation software. Gain deeper insights into compliance trends and performance metrics, empowering you to make informed decisions and drive strategic initiatives.

Customised reporting options

A Fuse admin can tailor reports according to your unique requirements, whether you need comprehensive snapshots or delta changes. Our module offers customizable options to accommodate diverse compliance needs effectively.

This section also includes:

Child pages (Children Display)
allChildrentrue