4. API¶
- GET /auth/clear¶
Clear session
Use this endpoint when redirecting from authprov. When a user is logged in and logs in again, e.g. with other credentials, this endpoint ensures that the old user is logged out first.
- Status Codes:
200 OK – Success
- GET /dashboard¶
Get all categories, dashboards, filters, labels and widgets
- Status Codes:
200 OK – Success
- POST /dashboard/category¶
Create new category
- Status Codes:
200 OK – Success
400 Bad Request – Bad Request
409 Conflict – Conflict
- DELETE /dashboard/category/{slug}¶
Delete existing category
- Parameters:
slug (string)
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
404 Not Found – Not Found
- PUT /dashboard/category/{slug}¶
Change existing category
- Parameters:
slug (string)
- Status Codes:
200 OK – Success
400 Bad Request – Bad Request
403 Forbidden – Forbidden
404 Not Found – Not Found
- POST /dashboard/dashboard¶
Create new dashboard
- Status Codes:
200 OK – Success
400 Bad Request – Bad Request
403 Forbidden – Forbidden
409 Conflict – Conflict
- GET /dashboard/dashboard/{slug}¶
Get specified dashboard and referenced widgets plus filters
- Parameters:
slug (string)
- Status Codes:
200 OK – Success
404 Not Found – Not Found
- DELETE /dashboard/dashboard/{slug}¶
Delete specified dashboard
- Parameters:
slug (string)
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
404 Not Found – Not Found
- PUT /dashboard/dashboard/{slug}¶
Change specified dashboard
- Parameters:
slug (string)
- Status Codes:
200 OK – Success
400 Bad Request – Bad Request
403 Forbidden – Forbidden
404 Not Found – Not Found
409 Conflict – Conflict
- GET /dashboard/data/{widget_slug}¶
Get data for specified widget
- Parameters:
widget_slug (string)
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
404 Not Found – Not Found
- POST /dashboard/widget¶
Create new widget
- Status Codes:
200 OK – Success
400 Bad Request – Bad Request
409 Conflict – Conflict
- GET /dashboard/widget/{slug}¶
Get specified widget and referenced filters
- Parameters:
slug (string)
- Status Codes:
200 OK – Success
404 Not Found – Not Found
- DELETE /dashboard/widget/{slug}¶
Delete specified widget
- Parameters:
slug (string)
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
404 Not Found – Not Found
- PUT /dashboard/widget/{slug}¶
Change specified widget
- Parameters:
slug (string)
- Status Codes:
200 OK – Success
400 Bad Request – Bad Request
403 Forbidden – Forbidden
404 Not Found – Not Found
- GET /report¶
Get all reports from all apps
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
- GET /report/parameter/{parameter_id}¶
Get report parameter values
- Parameters:
parameter_id (string)
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
- POST /report/report/{report_id}¶
Request report
- Parameters:
report_id (string)
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
- GET /table¶
Get all tables from all apps
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
502 Bad Gateway – Bad Gateway
- GET /table/{app}¶
Get all tables from specified app
- Parameters:
app (string)
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
502 Bad Gateway – Bad Gateway
- POST /table/{app}¶
Create table in specified app
- Parameters:
app (string)
- Status Codes:
200 OK – Success
400 Bad Request – Bad Request
403 Forbidden – Forbidden
404 Not Found – Not Found
409 Conflict – Conflict
502 Bad Gateway – Bad Gateway
- PUT /table/{app}¶
Create temporary table in specified app
- Parameters:
app (string)
- Status Codes:
200 OK – Success
400 Bad Request – Bad Request
403 Forbidden – Forbidden
404 Not Found – Not Found
502 Bad Gateway – Bad Gateway
- PUT /table/{app}/action_ids¶
Get action_ids from specified table
- Parameters:
app (string)
- Status Codes:
200 OK – Success
400 Bad Request – Bad Request
403 Forbidden – Forbidden
404 Not Found – Not Found
502 Bad Gateway – Bad Gateway
- POST /table/{app}/category¶
Create new category
- Parameters:
app (string)
- Status Codes:
200 OK – Success
400 Bad Request – Bad Request
403 Forbidden – Forbidden
404 Not Found – Not Found
409 Conflict – Conflict
502 Bad Gateway – Bad Gateway
- DELETE /table/{app}/category/{slug}¶
Delete existing category
- Parameters:
app (string)
slug (string)
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
404 Not Found – Not Found
502 Bad Gateway – Bad Gateway
- PUT /table/{app}/category/{slug}¶
Change existing category
- Parameters:
app (string)
slug (string)
- Status Codes:
200 OK – Success
400 Bad Request – Bad Request
403 Forbidden – Forbidden
404 Not Found – Not Found
409 Conflict – Conflict
502 Bad Gateway – Bad Gateway
- GET /table/{app}/filter¶
Get all filters from specified app
- Parameters:
app (string)
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
404 Not Found – Not Found
502 Bad Gateway – Bad Gateway
- GET /table/{app}/filter/{slug}¶
Get specified filter from specified app
- Parameters:
app (string)
slug (string)
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
404 Not Found – Not Found
502 Bad Gateway – Bad Gateway
- GET /table/{app}/table/{slug}¶
Get specified table from specified app
- Parameters:
app (string)
slug (string)
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
404 Not Found – Not Found
502 Bad Gateway – Bad Gateway
- DELETE /table/{app}/table/{slug}¶
Delete specified table from specified app
- Parameters:
app (string)
slug (string)
- Status Codes:
200 OK – Success
403 Forbidden – Forbidden
404 Not Found – Not Found
502 Bad Gateway – Bad Gateway
- PUT /table/{app}/table/{slug}¶
Change specified table in specified app
- Parameters:
app (string)
slug (string)
- Status Codes:
200 OK – Success
400 Bad Request – Bad Request
403 Forbidden – Forbidden
404 Not Found – Not Found
409 Conflict – Conflict
502 Bad Gateway – Bad Gateway
Get items in menu for current user
- Status Codes:
200 OK – Success