Skip to main content

Home

Trigger Unity app reports

Use this API to trigger a new report run. Different runs can have different configurations for the same report. It starts the report generation and returns the status code 202 on the successful generation of the report.

POST http://<unity_one_url>/api/reports/<report_name>/runs

For example: POST http://xyz.unraveldata.com:8111/api/reports/app_catalog_comparison/runs

Request sample

{
   "enabled": false,
   "retention_days": 12,
   "profile_memory": false,
   "report_type": "topkapps",
   "params": {
       "kind": "hive",
       "start_date": null,
       "end_date": null,
       "days": 300,
       "reports": [
           "io"
       ],
       "topk": 10,
       "feature_filters": {
           "null": null
       }
   },
   "notifications": {}
}

Response sample

202 Accepted
   {
       "run_id": "20221115T095955"
   }

Status codes

Code

Messages

202

Accepted

404

Not found, if report_name does not exist

500

Internal server error.