Dashboard

Retrieve Dashboard User Settings

GET
Returns user dashboard settings

Path parameters

typeenumRequired
The dashboard type that is not custom
Allowed values: MySummaryPortfolioSummary

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
objectOptional
The Dashboards API is intended for use by ProjectManager
GET
$curl /api/data/dashboards/settings/MySummary \
>     -H "Authorization: Bearer <token>"
Response
1{
2  "error": {
3    "technicalError": "technicalError",
4    "additionalErrors": [
5      "additionalErrors"
6    ],
7    "message": "message"
8  },
9  "success": true,
10  "hasError": true,
11  "statusCode": "Continue",
12  "data": {
13    "id": "id",
14    "userId": "userId",
15    "type": "type",
16    "reactGridLayout": {
17      "lg": [
18        {}
19      ],
20      "md": [
21        {}
22      ],
23      "sm": [
24        {}
25      ],
26      "xs": [
27        {}
28      ],
29      "xxs": [
30        {}
31      ]
32    }
33  }
34}
Built with