Settings | Analytics Dashboard
Service to manage entities of type 'AnalyticsDashboard'.
Overview
| URL | api/{tenantKey}/{orgKey}/settings/analyticsDashboards |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET AnalyticsDashboards (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
| opts | (ODataQueryOptions) OData query option. |
Response:
| When successful, the response body contains the list of records available. See AnalyticsDashboardResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET AnalyticsDashboard by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See AnalyticsDashboardResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET AnalyticsDashboard by key
Returns the entity record that matches the specified key.
The following elements are required:
| dashboardKey | (string) Dashboard. |
Response:
| When successful, the response body contains the entity record. See AnalyticsDashboardResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
GET Get Dashboards
Custom operation 'GetDashboards'.
Response:
| When successful, the response body contains a list of resources of type 'AnalyticsDashboardResource'. See AnalyticsDashboardResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST AnalyticsDashboards
Creates a new entity record.
The following elements are required:
| analyticsDashboardResource | (ApiAnalyticsDashboardResource) The request body should contain the entity record that should be created. See ApiAnalyticsDashboardResource. |
Response:
| When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiAnalyticsDashboardResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set DashboardKey AnalyticsDashboard
Updates the value of attribute 'DashboardKey' in the specified entity record.
The following elements are required:
| dashboardKey | (string) Dashboard. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description AnalyticsDashboard
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| dashboardKey | (string) Dashboard. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive AnalyticsDashboard
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| dashboardKey | (string) Dashboard. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set Order AnalyticsDashboard
Updates the value of attribute 'Order' in the specified entity record.
The following elements are required:
| dashboardKey | (string) Dashboard. |
| value | (int) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Title AnalyticsDashboard
Updates the value of attribute 'Title' in the specified entity record.
The following elements are required:
| dashboardKey | (string) Dashboard. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Url AnalyticsDashboard
Updates the value of attribute 'Url' in the specified entity record.
The following elements are required:
| dashboardKey | (string) Dashboard. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set VersionNumber AnalyticsDashboard
Updates the value of attribute 'VersionNumber' in the specified entity record.
The following elements are required:
| dashboardKey | (string) Dashboard. |
| value | (int) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE AnalyticsDashboard by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE AnalyticsDashboard by key
Deletes the entity record that matches the specified key.
The following elements are required:
| dashboardKey | (string) Dashboard. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
AnalyticsDashboardResource
The following elements are required:
| dashboardKey | (string) Dashboard. |
| description | (string) Description. |
| url | (string) Url. |
| versionNumber | (int) Version Number. |
The following elements are optional:
| title | (string) Title. |
| order | (int) Order. |
ApiAnalyticsDashboardResource
The following elements are required:
| dashboardKey | (string) Dashboard. |
| description | (string) Description. |
| url | (string) Url. |
| versionNumber | (int) Version Number. |
The following elements are optional:
| title | (string) Title. |
| order | (int) Order. |