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: |
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:
| Code Block |
|---|
{
"success": true,
"signed_download_url": "https://fusion-universal-assets-production.s3-eu-west-1.amazonaws.com/report-engine/xxxxxxx"
}
|