Workspace

Workspace’s resources

Favorite filter resource

Field	Format	More information
`id`	string	Filter ID.
`title`	string	Name of the filter.
`filter`	object	Filter object
`sharing_status`	string	“private” (filter only visible by the user) or “public” (filter visible by anybody who has access to the report)

Workspace Dashboard resource

Field	Format
`id`	string	Dashboard ID.
`name`	string	Dashboard name
`report_list_id`	array[string]	List of reports ID.

Workspace workspace resource

Field	Format
`id`	string	Dashboard ID.
`name`	string	Dashboard name
`settings`	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"
            }
        }
    ]
}

Workspace Get Favorite Filters

Get all filters of given workspace available for given OAuth token.

Example Workspace Get Favorite Filters request

GET https://rest.synthesio.com/workspace/v1/dashboards/88183/favorite_filters HTTP/1.1
Host: rest.synthesio.com
Authorization: Bearer YOUR_API_TOKEN

Response

{
    "data": [
        {
            "id": "1465574703157_4750354",
            "title": "Global vision",
            "filters": {
                "period": {
                    "begin": "2016-05-11T04:00:00.000Z",
                    "end": "2016-06-11T03:59:59.000Z",
                    "shortcut": "last-1m"
                },
                "human_review_statuses": [
                    "reviewed"
                ],
                "tags": [
                    {
                        "name": "wor"
                    },
                    {
                        "name": "wor",
                        "sentiment": "positive"
                    },
                    {
                        "name": "wor",
                        "sentiment": "neutral"
                    },
                    {
                        "name": "wor",
                        "sentiment": "negative"
                    }
                ]
            },
            "sharing_status": "private"
        },
        {
            "id": "1462891910514_5058165",
            "title": "Social media only",
            "filters": {
                "period": {
                    "begin": "2016-06-01T04:00:00.000Z",
                    "end": "2016-07-01T03:59:59.000Z",
                    "shortcut": "prev-1m"
                },
                "human_review_statuses": [
                    "reviewed"
                ],
                "medias": [
                    {
                        "site": 9938
                    },
                    {
                        "site": 1650630
                    },
                    {
                        "site": 21711
                    },
                    {
                        "site": 22249
                    }
                ]
            },
            "sharing_status": "public"
        }
    ]
}