SitesUI Settings
getSiteUiSetting
Site UI settings
Authorization<token>
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
site_id*string
Format
uuiduisetting_id*string
Format
uuidResponse Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/uisettings/000000ab-00ab-00ab-00ab-0000000000ab"{ "created_time": 1508823803, "defaultScopeId": "67970e46-4e12-11e6-9188-0242ad112847", "defaultScopeType": "site", "defaultTimeRange": { "end": 1508828400, "endDate": "10/23/2017", "interval": "1d", "name": "This Week", "shortName": "thisWeek", "start": 1508655600, "usePreset": true }, "description": "Description of the databoard", "for_site": true, "id": "3bdcc7e8-c04d-4512-b4fc-093da9057eb0", "isCustomDataboard": true, "isScopeLinked": true, "isTimeRangeLinked": true, "modified_time": 0, "name": "New Databoard", "org_id": "cc079380-5029-4d4a-9125-858de85731ff", "purpose": "databoard", "site_id": "67970e46-4e12-11e6-9188-0242ad112847", "tiles": [ { "chartBand": "2.4 ghz", "chartColor": "#00B4AD", "chartDirection": "tx + rx", "chartRankBy": "string", "chartType": "timeSeries", "colspan": 5, "column": 1, "hideEmptyRows": true, "id": "7a9ab38c-cfc3-483d-b51a-0aec571fadc0", "metric": { "apiName": "client_dhcp_latency" }, "name": "New Analysis", "row": 1, "rowspan": 2, "scopeId": "e0c767834b4c", "scopeType": "client", "timeRange": { "end": 1508823743, "endDate": "10/23/2017", "interval": "1d", "name": "Past 7 Days", "shortName": "7d", "start": 1508223600, "usePreset": true }, "trendType": "line", "vizType": "averageTimeSeriesChart" } ]}