API docs by Redocly

DHIS2 Superset Gateway REST API (1.0.0)

Download OpenAPI specification:

REST API for DHIS 2 Superset Gateway service

Dashboards

Get dashboard

path Parameters
id
required
string
cookie Parameters
JSESSIONID
string

Responses

Update dashboard

path Parameters
id
required
string
cookie Parameters
JSESSIONID
string
Request Body schema: application/json
required
id
string
name
string
supersetEmbedId
string
object (SupersetDashboardOptions)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "supersetEmbedId": "string",
  • "options": {
    }
}

Remove dashboard

path Parameters
id
required
string
cookie Parameters
JSESSIONID
string

Responses

Get dashboards

cookie Parameters
JSESSIONID
string

Responses

Create dashboard

cookie Parameters
JSESSIONID
string
Request Body schema: application/json
required
id
string
name
string
supersetEmbedId
string
object (SupersetDashboardOptions)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "supersetEmbedId": "string",
  • "options": {
    }
}

Get dashboard metadata

path Parameters
id
required
string
cookie Parameters
JSESSIONID
string

Responses

Access

Login

cookie Parameters
JSESSIONID
string

Responses

Get Superset dashboard guest token

path Parameters
id
required
string
cookie Parameters
JSESSIONID
required
string

Responses

Get Superset dashboard guest token

path Parameters
id
required
string
cookie Parameters
JSESSIONID
required
string

Responses

Get dashboard guest token

path Parameters
id
required
string
cookie Parameters
JSESSIONID
string

Responses

Get DHIS 2 dashboard guest token

path Parameters
id
required
string
cookie Parameters
JSESSIONID
required
string

Responses

Get info

Responses

Response samples

Content type
application/json
{
  • "supersetBaseUrl": "string",
  • "apiDocsPath": "string"
}