Dashboard Section

With dashboards you can display information with the help of beautiful visualizations. You can organize them in sections. Sections are divisions of a dashboard list. You can create multiple sections in one list.

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
dashboardList	object <DocumentInfo>	read-only
dashboards	array <DocumentInfo>	read-only

Example:

{
    "id": "{123456}_f",
    "modified": "2023-02-06T14:52:33.0000000",
    "created": "2023-02-06T14:52:33.0000000",
    "name": "Q4",
    "user": {
        "id": "{123456}_u",
        "name": "Vyara Todorova"
    },
    "dashboardList": {
        "id": "{123456}_repo",
        "name": "Q2"
    },
    "dashboards": [
        {
            "id": "{123456}",
            "name": "Marketing"
        }
    ]
}

Create a dashboard section

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

Required parameters: None

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

Property	Type	Attributes
name	string	required, min = 1, max = 100
dashboardList	object <DocumentInfo>	required

Possible responses:

Code	Description
201 (Created)	You successfully created a dashboards section. The newly created dashboard section 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": "Q4",
    "dashboardList": {
        "id": "{123456}_repo",
        "name": "Marketing"
    }
}

Example of a successful response body:


{
    "id": "{123456}_f",
    "modified": "2023-02-06T14:52:33.0000000",
    "created": "2023-02-06T14:52:33.0000000",
    "name": "Q4",
    "user": {
        "id": "{123456}_u",
        "name": "Vyara Todorova"
    },
    "dashboardList": {
        "id": "{123456}_repo",
        "name": "Marketing"
    },
    "dashboards": [
        {
            "id": "{123456}",
            "name": "Marketing"
        }
    ]
}

Get a dashboard section

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

Required parameters: the id of the dashboard section

Possible responses:

Code	Description
200 (Success)	You can view the dashboards section. The requested DashboardSection 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 sections for a parent dashboard list

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

Required parameters: the id of the dashboard list

Possible responses:

Code	Description
200 (Success)	You can view all the dashboard sections in the parent dashboard list. The requested DashboardSection 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 section

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

Required parameters: the id of the dashboard section

When you request to update a dashboard section, 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 section is updated. The updated dashboard section 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": "Q2"
}

Example of a successful response body:


{
    "id": "{123456}_f",
    "modified": "2023-02-06T15:08:45.0000000",
    "created": "2023-02-06T14:51:44.0000000",
    "name": "Q2",
    "user": {
        "id": "{123456}_u",
        "name": "Vyara Todorova"
    },
    "dashboardList": {
        "id": "{123456}_repo",
        "name": "Marketing"
    },
    "dashboards": [
        {
            "id": "{123456}",
            "name": "HR"
        }
    ]
}

Delete a dashboard section

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

Required parameters: the id of the dashboard section

Possible responses:

Code	Description
204 (No Content)	The dashboard section 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.