4. API

GET /auth/callback

Receive callback from OAuth provider

Status Codes:
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:
GET /auth/login

Request authorization with OAuth provider

Status Codes:
GET /auth/logout

Logout the current user

Status Codes:
GET /dashboard

Get all categories, dashboards, filters, labels and widgets

Status Codes:
POST /dashboard/category

Create new category

Status Codes:
PUT /dashboard/category/{slug}

Change existing category

Parameters:

  • slug (string)

Status Codes:
DELETE /dashboard/category/{slug}

Delete existing category

Parameters:

  • slug (string)

Status Codes:
POST /dashboard/dashboard

Create new dashboard

Status Codes:
PUT /dashboard/dashboard/{slug}

Change specified dashboard

Parameters:

  • slug (string)

Status Codes:
GET /dashboard/dashboard/{slug}

Get specified dashboard and referenced widgets plus filters

Parameters:

  • slug (string)

Status Codes:
DELETE /dashboard/dashboard/{slug}

Delete specified dashboard

Parameters:

  • slug (string)

Status Codes:
GET /dashboard/data/{widget_slug}

Get data for specified widget

Parameters:

  • widget_slug (string)

Status Codes:
POST /dashboard/widget

Create new widget

Status Codes:
PUT /dashboard/widget/{slug}

Change specified widget

Parameters:

  • slug (string)

Status Codes:
GET /dashboard/widget/{slug}

Get specified widget and referenced filters

Parameters:

  • slug (string)

Status Codes:
DELETE /dashboard/widget/{slug}

Delete specified widget

Parameters:

  • slug (string)

Status Codes:
GET /info

Get info about application

Status Codes:
GET /report

Get all reports from all apps

Status Codes:
GET /report/parameter/{parameter_id}

Get report parameter values

Parameters:

  • parameter_id (string)

Status Codes:
POST /report/report/{report_id}

Request report

Parameters:

  • report_id (string)

Status Codes:
GET /table

Get all tables from all apps

Status Codes:
PUT /table/{app}

Create temporary table in specified app

Parameters:

  • app (string)

Status Codes:
GET /table/{app}

Get all tables from specified app

Parameters:

  • app (string)

Status Codes:
POST /table/{app}

Create table in specified app

Parameters:

  • app (string)

Status Codes:
PUT /table/{app}/action_ids

Get action_ids from specified table

Parameters:

  • app (string)

Status Codes:
POST /table/{app}/category

Create new category

Parameters:

  • app (string)

Status Codes:
PUT /table/{app}/category/{slug}

Change existing category

Parameters:

  • app (string)

  • slug (string)

Status Codes:
DELETE /table/{app}/category/{slug}

Delete existing category

Parameters:

  • app (string)

  • slug (string)

Status Codes:
GET /table/{app}/filter

Get all filters from specified app

Parameters:

  • app (string)

Status Codes:
GET /table/{app}/filter/{slug}

Get specified filter from specified app

Parameters:

  • app (string)

  • slug (string)

Status Codes:
PUT /table/{app}/table/{slug}

Change specified table in specified app

Parameters:

  • app (string)

  • slug (string)

Status Codes:
GET /table/{app}/table/{slug}

Get specified table from specified app

Parameters:

  • app (string)

  • slug (string)

Status Codes:
DELETE /table/{app}/table/{slug}

Delete specified table from specified app

Parameters:

  • app (string)

  • slug (string)

Status Codes:
GET /ui/menu

Get items in menu for current user

Status Codes: