Versions Compared

Key

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

...

  1. As a Fuse site admin, go to the Admin Panel and click Reporting (Beta).

    Screenshot 2024-03-14 at 16.07.56.png
  2. In the Create a custom report section, select a custom report you wish to create, ensuring that you give it a easily recognisable title and that you have applied the desired filters so that it contains the data you need. For more information on how to create a custom report, see Creating a custom https://fuseuniversal.atlassian.net/wiki/spaces/customerwiki/pages/3603726343/Creating%2C+scheduling%2C+and+sharing+a+custom+report.

    Screenshot 2024-03-14 at 16.12.27.pngImage Removedimage-20240814-130153.pngImage Added

Step 2: Share the title or ID of the report

...

Code Block
{
  "total_count": 1,
  "last_page": true,
  "reports": [
    {
      "title": "Title of Report",             <---- Title of the report
      "id": 987654321,                         <---- ID of the 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 the 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

Notes:

  • The execution_idreturned in the above response can be used in the API shown below:

    Screenshot 2024-08-14 at 14.22.24.pngImage Added

  • Both the report_type_code and tag fields in the above response can be used to identify the report type. In this example, you can see that it is the Learning plan custom report:

    Screenshot 2024-08-14 at 14.08.23.pngImage Added
Note

The download URL provided in the report_download_url section of the response body is used for the CSV download, and is only valid for 1 hour (60 mins) after the report URL has been generated by the API.

Example:
"report_download_url": "https://fusion-universal-assets-production.s3-eu-west-1.amazonaws.com/report-engine/xxxxxx"

...

GET: Retrieve a signed AWS download link to download the latest execution ID

The following GET request can be used to retrieve the a signed AWS download link, containing the latest execution ID for a report.

...

POST: /compliance_reporting/reports/regenerate

POST: https://<instance_name>>.fuseuniversal.com/api/v4.4/compliance_reporting/reports/regenerate?auth_token=<valid_auth_token>

...

Note

Regenerating a report also generates a new execution_id, so please ensure that you run the GET: /compliance_reporting/reports/allendpointto get the latest execution_id.

...

GET: Retrieving a list of executions for a particular report

The following GET request allows you to retrieve a list of executions for a particular report.

...