curl --request GET \
--url https://api.example.com/dashboards/{dashboard_id}/ \
--header 'Authorization: Bearer <token>'{
"name": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"datasets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"detailed_description": "<string>",
"organisation_id": "<string>",
"status": "<string>",
"starred": true,
"is_primary": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"columns": [
"<string>"
],
"is_embedding_searchable": true,
"dictionary": {},
"dataset_schema": {
"column_schemas": {}
},
"annotations": {},
"warehousing_error": "<string>",
"cron_schedule": "<string>",
"schedule_enabled": true,
"last_schedule_run_at": "2023-11-07T05:31:56Z",
"import_config": {},
"is_importing": true
}
],
"spec": {
"visualisations": [
{
"uid": "<string>",
"title": "<string>",
"grid_layout": {
"x": 123,
"y": 123,
"w": 123,
"h": 123
},
"data_source_uid": "<string>",
"config": {
"columns": [
"<string>"
],
"type": "STANDARD_TABLE"
}
}
],
"data_sources": [
{
"uid": "<string>",
"query": "<string>",
"filters": [
{
"uid": "<string>",
"column": "<string>",
"column_type": "BOOLEAN",
"filter_condition": {
"operator": "EQUALS",
"value": "<string>",
"is_negated": false
}
}
],
"columns_schemas": {},
"is_embedding_searchable": true
}
]
}
}curl --request GET \
--url https://api.example.com/dashboards/{dashboard_id}/ \
--header 'Authorization: Bearer <token>'{
"name": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"datasets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"detailed_description": "<string>",
"organisation_id": "<string>",
"status": "<string>",
"starred": true,
"is_primary": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"columns": [
"<string>"
],
"is_embedding_searchable": true,
"dictionary": {},
"dataset_schema": {
"column_schemas": {}
},
"annotations": {},
"warehousing_error": "<string>",
"cron_schedule": "<string>",
"schedule_enabled": true,
"last_schedule_run_at": "2023-11-07T05:31:56Z",
"import_config": {},
"is_importing": true
}
],
"spec": {
"visualisations": [
{
"uid": "<string>",
"title": "<string>",
"grid_layout": {
"x": 123,
"y": 123,
"w": 123,
"h": 123
},
"data_source_uid": "<string>",
"config": {
"columns": [
"<string>"
],
"type": "STANDARD_TABLE"
}
}
],
"data_sources": [
{
"uid": "<string>",
"query": "<string>",
"filters": [
{
"uid": "<string>",
"column": "<string>",
"column_type": "BOOLEAN",
"filter_condition": {
"operator": "EQUALS",
"value": "<string>",
"is_negated": false
}
}
],
"columns_schemas": {},
"is_embedding_searchable": true
}
]
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The grid layout of the dashboard. x: The x-coordinate of the top-left corner of the visualisation. y: The y-coordinate of the top-left corner of the visualisation. w: The width of the visualisation. h: The height of the visualisation.
The page is divided into a grid of cells 12 wide, like a Bootstrap grid system. A layout with (x=0, y=0, w=12, h=10) will take up the entire width of the page and span 10 rows. A layout with (x=0, y=0, w=6, h=10) and (x=6, y=0, w=6, h=10) will take up the width of the page with 2 equal height columns.
Show child attributes
Show child attributes
BOOLEAN, STRING, NUMBER, DATETIME