Dashboard List

With dashboards you can display information with the help of beautiful visualizations. You can organize them in different lists for better visibility.

Schema:

Property	Type	Attributes
id	string	read-only
modified	string	read-only
created	string	read-only
name	string	min = 1, max = 100
user	object <DocumentInfo>	read-only
workspace	object <DocumentInfo>	read-only
project	object <DocumentInfo>	read-only
dashboardSections	array <DocumentInfo>	read-only

Example:

{
    "id": "{123456}_repo",
    "modified": "2023-02-03T14:07:34.0000000",
    "created": "2023-02-03T14:07:34.0000000",
    "name": "Marketing",
    "user": {
        "id": "{123456}_u ",
        "name": "Teddy Mitkova"
    },
    "dashboardSections": [
        {
            "id": "{123456}_f",
            "name": "June"
        }
    ]
}

Create a dashboard list

https://my.slingshotapp.io/v1/dashboardlists

Required parameters: None

When you request to create a dashboard list, the request body will have the following content:

Property	Type	Attributes
name	string	required, min = 1, max = 100
user	object <DocumentInfo>	required, one-of
workspace	object <DocumentInfo>	required, one-of
project	object <DocumentInfo>	required, one-of

Possible responses:

Code	Description
201 (Created)	You successfully created a dashboard list. The newly created dashboard list will be returned in the response body.
400 (Bad Request)	The request was not processed because of missing or malformed parameter(s). Check the error array in the response to get an idea of what went wrong.
403 (Forbidden)	The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication.
404 (Not Found)	The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist.

Example of a successful request body:

{
    "name": "Marketing",
    "user": {
        "id": "{123456}_u",
        "name": "Teddy Mitkova"
    }
}

Example of a successful response body:


{
    "id": "{123456}_repo",
    "modified": "2023-02-03T14:07:34.0000000",
    "created": "2023-02-03T14:07:34.0000000",
    "name": "Marketing",
    "user": {
        "id": "{123456}_u ",
        "name": "Teddy Mitkova"
    },
    "dashboardSections": [
        {
            "id": "{123456}_f",
            "name": "May"
        }
    ]
}

Get a dashboard list

https://my.slingshotapp.io/v1/dashboardlists/{id}

Required parameters: the id of the dashboard list

Possible responses:

Code	Description
200 (Success)	You can view the dashboard list with its dashboards. The requested DashboardList will be returned in the response body.
403 (Forbidden)	The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication.
404 (Not Found)	The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist.

Get all dashboard lists for a parent document

https://my.slingshotapp.io/v1/dashboardlists/parent/{id}

Required parameters: the id of the parent document

Possible responses:

Code	Description
200 (Success)	You can view all the dashboard lists in the parent document. The requested dashboard lists will be returned in the response body in an ItemsObject array.
403 (Forbidden)	The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication.
404 (Not Found)	The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist.

Update a dashboard list

https://my.slingshotapp.io/v1/dashboardlists/{id}

Required parameters: the id of the dashboard list

When you request to update a dashboards list, the request body will have the following content:

Property	Type	Attributes
name	string	min = 1, max = 100

Possible responses:

Code	Description
200 (Success)	The dashboards list is updated. The updated dashboard list will be returned in the response body.
400 (Bad Request)	The request was not processed because of missing or malformed parameter(s). Check the error array in the response to get an idea of what went wrong.
403 (Forbidden)	The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication.
404 (Not Found)	The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist.

Example of a successful request body:

{
    "name": "Marketing"
}

Example of a successful response body:


{
    "id": "{123456}_repo",
    "modified": "2023-02-06T12:34:39.0000000",
    "created": "2023-02-06T12:08:44.0000000",
    "name": "Marketing",
    "user": {
        "id": "{123456}_u",
        "name": "Vyara Todorova"
    },
    "dashboardSections": [
        {
            "id": "{123456}_f",
            "name": "Q1"
        }
    ]
}

Delete a dashboard list

https://my.slingshotapp.io/v1/dashboardlists/{id}

Required parameters: the id of the dashboard list

Possible responses:

Code	Description
204 (No Content)	The dashboard list is deleted.
403 (Forbidden)	The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication.
404 (Not Found)	The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist.