API docs by Redocly

redash (0.0.1)

Download OpenAPI specification:Download

/ping

Responses

/status.json

Responses

Response samples

Content type
application/json
{
  • "dashboards_count": 0,
  • "database_metrics": {
    },
  • "manager": {
    },
  • "queries_count": 0,
  • "query_results_count": 0,
  • "redis_used_memory": 0,
  • "redis_used_memory_human": "string",
  • "unused_query_results_count": 0,
  • "version": "string",
  • "widgets_count": 0,
  • "workers": [
    ]
}

Alert

/api/alerts

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/alerts

Request Body schema: application/json
required
object
name
required
string
query_id
required
integer
destination_id
integer
rearm
integer

Responses

Request samples

Content type
application/json
{
  • "options": { },
  • "name": "string",
  • "query_id": 0,
  • "destination_id": 0,
  • "rearm": 0
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "state": "string",
  • "name": "string",
  • "rearm": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "query": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_triggered_at": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "options": { }
}

Dashboard

/api/dashbaords

query Parameters
page_size
integer
page
integer
order
string
q
string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "page": 0,
  • "page_size": 0,
  • "results": [
    ]
}

/api/dashbaords

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "tags": [
    ],
  • "is_archived": true,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_favorite": true,
  • "user": {
    },
  • "layout": [
    ],
  • "is_draft": true,
  • "id": 0,
  • "user_id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "version": 0,
  • "widgets": null,
  • "dashboard_filters_enabled": true
}

DataSource

/api/data_sources

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/data_sources

Request Body schema: application/json
required
object
name
required
string
type
required
string
Enum: "mysql" "pg" "prometheus"

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "scheduled_queue_name": "string",
  • "name": "string",
  • "pause_reason": "string",
  • "queue_name": "string",
  • "syntax": "string",
  • "paused": 0,
  • "options": {
    },
  • "groups": { },
  • "type": "string",
  • "id": 0
}

/api/data_sources/types

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/data_sources/{data_source_id}

path Parameters
data_source_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "scheduled_queue_name": "string",
  • "name": "string",
  • "pause_reason": null,
  • "queue_name": "string",
  • "syntax": "string",
  • "paused": 0,
  • "options": {
    },
  • "groups": {
    },
  • "type": "string",
  • "id": 0
}

/api/data_sources/{data_source_id}

path Parameters
data_source_id
required
integer
Request Body schema: application/json
required
object
name
required
string
type
required
string
Enum: "mysql" "pg" "prometheus"

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "scheduled_queue_name": "string",
  • "name": "string",
  • "pause_reason": null,
  • "queue_name": "string",
  • "syntax": "string",
  • "paused": 0,
  • "options": {
    },
  • "groups": {
    },
  • "type": "string",
  • "id": 0
}

/api/data_sources/{data_source_id}

path Parameters
data_source_id
required
integer

Responses

/api/data_sources/{data_source_id}/schema

path Parameters
data_source_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "schema": [
    ]
}

/api/data_sources/{data_source_id}/pause

path Parameters
data_source_id
required
integer
Request Body schema: application/json
reason
string

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "pause_reason": "string",
  • "syntax": "string",
  • "paused": 0,
  • "type": "string",
  • "id": 0
}

/api/data_sources/{data_source_id}/pause

path Parameters
data_source_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "pause_reason": "string",
  • "syntax": "string",
  • "paused": 0,
  • "type": "string",
  • "id": 0
}

/api/data_sources/{data_source_id}/test

path Parameters
data_source_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "ok": true
}

Group

/api/groups

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Query

/api/queries

query Parameters
page_size
integer
page
integer
order
string
q
string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "page": 0,
  • "page_size": 0,
  • "results": [
    ]
}

/api/queries

Request Body schema: application/json
data_source_id
required
number
query
required
string
name
required
string
description
string
schedule
string
object

Responses

Request samples

Content type
application/json
{
  • "data_source_id": 0,
  • "query": "string",
  • "name": "string",
  • "description": "string",
  • "schedule": "string",
  • "options": { }
}

Response samples

Content type
application/json
{
  • "user": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "latest_query_data_id": 0,
  • "schedule": "string",
  • "description": "string",
  • "tags": [
    ],
  • "updated_at": "2019-08-24T14:15:22Z",
  • "last_modified_by": {
    },
  • "options": { },
  • "version": 0,
  • "is_favorite": true,
  • "query_hash": "string",
  • "is_archived": true,
  • "query": "string",
  • "api_key": "string",
  • "is_draft": true,
  • "id": 0,
  • "data_source_id": 0,
  • "name": "string"
}

QueryResult

/api/query_results

Request Body schema: application/json
query
required
string
query_id
number
max_age
number
data_source_id
required
number
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "query_id": 0,
  • "max_age": 0,
  • "data_source_id": 0,
  • "parameters": { }
}

Response samples

Content type
application/json
{
  • "job": {
    }
}

User

/api/users

query Parameters
page
integer
page_size
integer
q
string
disabled
boolean
pending
boolean

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "page": 0,
  • "page_size": 0,
  • "results": [
    ]
}

/api/users

Request Body schema: application/json
name
required
string
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "auth_type": "string",
  • "is_disabled": true,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "profile_image_url": "http://example.com",
  • "is_invitation_pending": true,
  • "groups": [
    ],
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "disabled_at": "2019-08-24T14:15:22Z",
  • "is_email_verified": true,
  • "api_key": "string",
  • "active_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com"
}

/api/users/{userId}

path Parameters
userId
required
integer

Responses

Response samples

Content type
application/json
{
  • "auth_type": "string",
  • "is_disabled": true,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "profile_image_url": "http://example.com",
  • "is_invitation_pending": true,
  • "groups": [
    ],
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "disabled_at": "2019-08-24T14:15:22Z",
  • "is_email_verified": true,
  • "api_key": "string",
  • "active_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com"
}

/api/users/{userId}

path Parameters
userId
required
integer
Request Body schema: application/json
email
string <email>
name
string
password
string
old_password
string
groups
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "name": "string",
  • "password": "string",
  • "old_password": "string",
  • "groups": "string"
}

Response samples

Content type
application/json
{
  • "auth_type": "string",
  • "is_disabled": true,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "profile_image_url": "http://example.com",
  • "is_invitation_pending": true,
  • "groups": [
    ],
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "disabled_at": "2019-08-24T14:15:22Z",
  • "is_email_verified": true,
  • "api_key": "string",
  • "active_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com"
}

/api/users/{userId}

path Parameters
userId
required
integer

Responses

Response samples

Content type
application/json
{
  • "auth_type": "string",
  • "is_disabled": true,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "profile_image_url": "http://example.com",
  • "is_invitation_pending": true,
  • "groups": [
    ],
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "disabled_at": "2019-08-24T14:15:22Z",
  • "is_email_verified": true,
  • "api_key": "string",
  • "active_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com"
}

/api/users/{userId}/invite

path Parameters
userId
required
integer

Responses

Response samples

Content type
application/json
{
  • "auth_type": "string",
  • "is_disabled": true,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "profile_image_url": "http://example.com",
  • "is_invitation_pending": true,
  • "groups": [
    ],
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "disabled_at": "2019-08-24T14:15:22Z",
  • "is_email_verified": true,
  • "api_key": "string",
  • "active_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com"
}

/api/users/{userId}/reset_password

path Parameters
userId
required
integer

Responses

Response samples

Content type
application/json
{}

/api/users/{userId}/regenerate_api_key

path Parameters
userId
required
integer

Responses

Response samples

Content type
application/json
{
  • "auth_type": "string",
  • "is_disabled": true,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "profile_image_url": "http://example.com",
  • "is_invitation_pending": true,
  • "groups": [
    ],
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "disabled_at": "2019-08-24T14:15:22Z",
  • "is_email_verified": true,
  • "api_key": "string",
  • "active_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com"
}

/api/users/{userId}/disable

path Parameters
userId
required
integer

Responses

Response samples

Content type
application/json
{
  • "auth_type": "string",
  • "is_disabled": true,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "profile_image_url": "http://example.com",
  • "is_invitation_pending": true,
  • "groups": [
    ],
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "disabled_at": "2019-08-24T14:15:22Z",
  • "is_email_verified": true,
  • "api_key": "string",
  • "active_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com"
}

/api/users/{userId}/disable

path Parameters
userId
required
integer

Responses

Response samples

Content type
application/json
{
  • "auth_type": "string",
  • "is_disabled": true,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "profile_image_url": "http://example.com",
  • "is_invitation_pending": true,
  • "groups": [
    ],
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "disabled_at": "2019-08-24T14:15:22Z",
  • "is_email_verified": true,
  • "api_key": "string",
  • "active_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com"
}

Visualization

/api/visualizations

Request Body schema: application/json
query_id
integer
name
string
description
string
object
type
string

Responses

Request samples

Content type
application/json
{
  • "query_id": 0,
  • "name": "string",
  • "description": "string",
  • "options": { },
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "description": null,
  • "created_at": "string",
  • "updated_at": "string",
  • "id": 0,
  • "type": "string",
  • "options": { },
  • "name": "string"
}

Widget

/api/widgets

Request Body schema: application/json
dashboard_id
integer
visualizationid
integer
object
text
string
width
number

Responses

Request samples

Content type
application/json
{
  • "dashboard_id": 0,
  • "visualizationid": 0,
  • "options": { },
  • "text": "string",
  • "width": 0
}

Response samples

Content type
application/json
{
  • "widget": { }
}

Destination

/api/destinations

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/destinations

Request Body schema: application/json
required
object
name
required
string
type
required
string
Value: "email"

Responses

Request samples

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

Response samples

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

/api/destinations/types

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/destinations/{destination_id}

path Parameters
destination_id
required
integer

Responses

Response samples

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

/api/destinations/{destination_id}

path Parameters
destination_id
required
integer
Request Body schema: application/json
required
object
name
required
string
type
required
string
Value: "email"

Responses

Request samples

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

Response samples

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

/api/destinations/{destination_id}

path Parameters
destination_id
required
integer

Responses

QuerySnippet

/api/query_snippets

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/query_snippets

Request Body schema: application/json
trigger
required
object
description
required
string
snippet
required
string

Responses

Request samples

Content type
application/json
{
  • "trigger": { },
  • "description": "string",
  • "snippet": "string"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "snippet": "string",
  • "trigger": "string",
  • "user": {
    },
  • "id": 0
}

Setting

/api/settings/organization

Responses

Response samples

Content type
application/json
{
  • "settings": {
    }
}

/api/settings/organization

Request Body schema: application/json
auth_password_login_enabled
boolean
auth_google_apps_domains
string

Responses

Request samples

Content type
application/json
{
  • "auth_password_login_enabled": true,
  • "auth_google_apps_domains": "string"
}

Response samples

Content type
application/json
{
  • "settings": {
    }
}