Workspace
Workspace’s resources
Workspace Dashboard resource
Field |
Format |
|
---|---|---|
|
string |
Dashboard ID. |
|
string |
Dashboard name |
|
array[string] |
List of reports ID. |
Workspace workspace resource
Field |
Format |
|
---|---|---|
|
string |
Dashboard ID. |
|
string |
Dashboard name |
|
array[string] |
Array of settings in key => value format |
Workspace Get Dashboards
Get all dashboards available for given OAuth token.
Pagination can be controlled with GET
parameters:
size
(integer): Indicates the number of dashboards that should be returned, defaults to 20. Maximum is 100.from
(integer): Indicates the offset. Defaults to 0.
Filters:
filter by ID is implemented. To get information on specific dashboards, you can give a comma separated list of report IDs. Example:
?filter[id]=1,15
Example Workspace API Get Dashboard request
GET https://rest.synthesio.com/workspace/v1/dashboards?from=0&size=2 HTTP/1.1
Host: rest.synthesio.com
Authorization: Bearer YOUR_API_TOKEN
Workspace Get Dashboard response
{
"meta": [],
"data": [
{
"id": "1",
"name": "Some dashboard name",
"report_list_id": [
"1000"
]
},
{
"id": "15",
"name": "Some other dashboard",
"report_list_id": [
"1000",
"1001"
]
}
]
}
Workspace Get Workspaces
Get all workspaces available for given OAuth token.
Example Workspace API Get Workspaces request
GET https://rest.synthesio.com/workspace/v1/workspaces HTTP/1.1
Host: rest.synthesio.com
Authorization: Bearer YOUR_API_TOKEN
Workspace Get Dashboard response
{
"meta": [],
"data": [
{
"id": "75848",
"name": "Some workspace name",
"settings": {
"dance_with_wolves": "1"
}
}
]
}
Workspace Get Workspace
Get workspace information.
Example Workspace API Get Workspace request
GET https://rest.synthesio.com/workspace/v1/workspace/75848 HTTP/1.1
Host: rest.synthesio.com
Authorization: Bearer YOUR_API_TOKEN
Workspace Get Workspace response
{
"data": [
{
"id": "75848",
"name": "Some workspace name",
"settings": {
"dance_with_wolves": "1"
}
}
]
}