List Dashboards
Query
GET /api/1.0/dashboards
Parameter Comments byCategory Optional parameter. Comma separated list of categories IDs to filter by. Multiple categories applied as OR operator.
Response
HTTP Status | Response |
---|---|
200 OK | Output example:
{ "list":[ { "createdDate":1484118380000, "id":110634, "name":"Dashboard1", "userId":10077, "url":"eD8yPisWdcQhdOeip2IJii6Tip1dLNOlFJiiDHhW3iiqSHqtQie", "selected":true, "displayOrder":0, "screenAdjust":true, "screenWidth":1447, "screenHeight":908, "lastModDt":1492849740000, "lastAccessDt":1492849740000, "locked":false, "accessLevel":1, "showWidgetList":true }, { "createdDate":1481572146000, "id":110617, "name":"Dashboard2", "userId":10077, "url":"m2a68Ahq9l9cNWKNQoqXipiirjzwiiUGPUis0QurjbHE5bIie", "selected":true, "displayOrder":0, "screenAdjust":false, "screenWidth":1680, "screenHeight":1050, "lastModDt":1492550129000, "lastAccessDt":1492550093000, "locked":false, "accessLevel":1, "showWidgetList":true, } ] } |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER"
https://www.knowi.com/api/1.0/dashboards?byCategory=124,5235
Get Dashboard Details by Id
Query
GET /api/1.0/dashboards/<objectId>
Parameter | Comments |
---|---|
objectId | Dashboard id to view Dashboard |
Response
HTTP Status | Response |
---|---|
200 OK | Output example:
{ "createdDate":1481572146000, "id":110617, "name":"Dashboard2", "userId":10077, "url":"m2a68Ahq9l9cNWKNQoqXipiirjzwiiUGPUis0QurjbHE5bIie", "selected":true, "displayOrder":0, "screenAdjust":false, "screenWidth":1680, "screenHeight":1050, "lastModDt":1492550129000, "lastAccessDt":1492550093000, "locked":false, "accessLevel":1, "showWidgetList":true, } |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER"
https://www.knowi.com/api/1.0/dashboards/10001
Generate Dashboard Share Url
Query
POST /api/1.0/dashboards/<objectId>/share/url
Parameter | Comments |
---|---|
objectId | Dashboard id to update share url |
contentFilters |
Optional form parameter content filters |
refresh |
true (Default) If false and the current dashboard already has share URLs, the endpoint will NOT update the existing hash. Instead, it will just generate the content filter hash. The response is the same as before (i.e. unchanged). Note- when the refresh flag is set to false and the dashboard does NOT have a share or secure share (respectively) enabled, the endpoint will try to enable it. |
Response
HTTP Status | Response |
---|---|
200 OK | Output example:
{ "shareUrl": "4PdpqevhrfPYzXcAbmxWJhtip38VmrQie?contentFilters=%5B%7B%22fieldName%22%3A%22Customer%22%2C%22values%22%3A%5B%22Facebook%22%5D%2C%22operator%22%3A%22%3D%22%7D%5D" } Note: To construct the full url, prepend /d/ and the “shareUrl” to the host name and port. For example: http://localhost:9090/d/4PdpqevhrfPYxmof638VmrQie?contentFilters=%7B%22fieldName%222Customer%22%2C%22values%22%3A%5B%22Facebook%2 |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -X POST -i http://localhost:9090/api/1.0/dashboards/110865/share/url -H
'Authorization: Bearer HERE_IS_YOUR_BEARER' -H 'Content-Type: application/x-www-form-urlencoded'
-d 'contentFilters=[{"fieldName":"Customer","values":["Facebook"],"operator":"="}]'
Generate Dashboard Secure Share Url
Query
POST/api/1.0/dashboards/<objectId>/share/url/secure
Parameter | Comments |
---|---|
objectId | Dashboard id to generate share url |
contentFilters | Optional form parameter content filters |
refresh |
true (Default) If false and the current dashboard already has share URLs, the endpoint will NOT update the existing hash. Instead, it will just generate the content filter hash. The response is the same as before (i.e. unchanged). Note- when the refresh flag is set to false and the dashboard does NOT have a share or secure share (respectively) enabled, the endpoint will try to enable it. |
Response
HTTP Status | Response |
---|---|
200 OK | Output example:
{ "secureShareUrl": "kN3Gj9jipB458gipMJ8EoaeC8rWfn8V9PQie/dnqPwU7UB1V4FWGoIGITmZGl___n3P859PnDoJlcSiov6CIWd___8Dpvl5JH74SIhJxww==" } Note: To construct the full url, prepend /share/secure/ and the secureShareUrl to the host name and port. For example: http://localhost:9090/share/secure/kN3Gj9j8rWfny3kp2XIPamz8V9PQie/dnqPwU7UF61jmT+rgIft4aE9PnDoJlcSiov6CIWd___8Dpvl5JH74SIhJxww== |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -X POST -i http://localhost:9090/api/1.0/dashboards/110865/share/url/secure -H
'Authorization: Bearer HERE_IS_YOUR_BEARER' -H 'Content-Type: application/x-www-form-urlencoded'
-d 'contentFilters=[{"fieldName":"Customer","values":["Facebook"],"operator":"="}]'
Create Dashboard Secure Share Hash
Creates a hash for embedding a secure url for a given set of filters. Whereas the API call above will regenerate the full secure URL, this call will only generate the hash while leaving the share url id the same.
Query
POST/api/1.0/dashboards/<objectId>/share/url/secure/hash
Parameter | Comments |
---|---|
objectId | Dashboard id to generate share url |
contentFilters | content filters in JSON form |
Response
HTTP Status | Response |
---|---|
200 OK | Output example:
{ "secureHash": "kN3Gj9jipB458gipMJ8EoaeC8rWfn8V9PQie/dnqPwU7UB1V4FWGoIGITmZGl___n3P859PnDoJlcSiov6CIWd___8Dpvl5JH74SIhJxww==" } Note: To construct the full url, prepend /share/secure/ and the secureHash to the host name and port. For example: http://localhost:9090/share/secure/kN3Gj9j8rWfny3kp2XIPamz8V9PQie/dnqPwU7UF61jmT+rgIft4aE9PnDoJlcSiov6CIWd___8Dpvl5JH74SIhJxww== |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -X POST -i http://localhost:9090/api/1.0/dashboards/110865/share/url/secure/hash -H
'Authorization: Bearer HERE_IS_YOUR_BEARER' -H 'Content-Type: application/x-www-form-urlencoded'
-d 'contentFilters=[{"fieldName":"Customer","values":["Facebook"],"operator":"="}]'
Share Dashboard to Users/Groups
Query
PUT /api/1.0/dashboards/<objectId>/share
Parameter | Comments |
---|---|
objectId | Dashboard id of Dashboard to share |
sso_user | Optional bool. Set to `true` if sharing to sso user |
PUT JSON payload
Parameter | Comments |
---|---|
shareProperties | Share properties json array. Available fields:
|
Response
HTTP Status | Response |
---|---|
200 OK | No response body |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
415 UNSUPPORTED_MEDIA_TYPE | Cannot consume content type - The server refused this request because the request entity is in a format not supported by the requested resource for the requested method. |
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X PUT -d "{\"shareProperties\" : [ { \"type\" : \"Users\", \"access_level\" : 1, \"name\" : \"someUser@host.com\" } ] }"
https://www.knowi.com/api/1.0/dashboards/110643/share
Create Dashboard
Query
POST /api/1.0/dashboards/
POST JSON payload:
Parameter | Comments |
---|---|
dashName | Dashboard name |
screenWidth | Dashboard screen width in pixels |
screenHeight | Dashboard screen height in pixels |
Response
HTTP Status | Response |
---|---|
200 OK | Return created Dashboard json info (same as "Get Dashboard" command). Output example:
{ "createdDate":1481572146000, "id":110617, "name":"Dashboard2", "userId":10077, "url":"m2a68Ahq9l9cNWKNQoqXipiirjzwiiUGPUis0QurjbHE5bIie", "selected":true, "displayOrder":0, "screenAdjust":false, "screenWidth":1680, "screenHeight":1050, "lastModDt":1492550129000, "lastAccessDt":1492550093000, "locked":false, "accessLevel":1, "showWidgetList":true, } |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
415 UNSUPPORTED_MEDIA_TYPE | Cannot consume content type - The server refused this request because the request entity is in a format not supported by the requested resource for the requested method. |
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X POST -d "{\"dashName\":\"dashboardName1\",\"screenWidth\":1000,\"screenHeight\":800}"
https://www.knowi.com/api/1.0/dashboards
Delete Dashboard
Query
DELETE /api/1.0/dashboards/<objectId>
Parameter | Comments |
---|---|
objectId | Id of Dashboard to delete |
Response
HTTP Status | Response |
---|---|
200 OK | No response body |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -X DELETE
https://www.knowi.com/api/1.0/dashboards/10084
Edit Dashboard
Query
PUT /api/1.0/dashboards/<objectId>
Parameter | Comments |
---|---|
objectId | Dashboard id of Dashboard to edit |
PUT JSON payload:
Parameter | Comments |
---|---|
dashName | New name of Dashboard |
categories |
Name of categories. for example: "categories: [".."] |
Response
HTTP Status | Response |
---|---|
200 OK | Return edited Dashboard json info (same as "Get Dashboard" command). Output example:
{ "createdDate":1481572146000, "id":110617, "name":"Dashboard2", "userId":10077, "url":"m2a68Ahq9l9cNWKNQoqXipiirjzwiiUGPUis0QurjbHE5bIie", "selected":true, "displayOrder":0, "screenAdjust":false, "screenWidth":1680, "screenHeight":1050, "lastModDt":1492550129000, "lastAccessDt":1492550093000, "locked":false, "accessLevel":1, "showWidgetList":true, } |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
415 UNSUPPORTED_MEDIA_TYPE | Cannot consume content type - The server refused this request because the request entity is in a format not supported by the requested resource for the requested method. |
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X PUT -d "{\"dashName\":\"updatedDashboardName1\", \"categories\": [\category_name\"]}" https://www.knowi.com/api/1.0/dashboards/10001
Clone Dashboard
Query
POST /api/1.0/dashboards/<objectIdToClone>
Parameter | Comments |
---|---|
objectIdToClone | Dashboard id of Dashboard to clone |
POST JSON payload:
Parameter | Comments |
---|---|
dashName | New (cloned) Name of Dashboard |
screenWidth | Cloned dashboard screen width in pixels |
screenHeight | Cloned dashboard screen height in pixels |
Response
HTTP Status | Response |
---|---|
200 OK | Return cloned Dashboard json info (same as "Get Dashboard" command). Output example:
{ "createdDate":1481572146000, "id":110617, "name":"Dashboard2", "userId":10077, "url":"m2a68Ahq9l9cNWKNQoqXipiirjzwiiUGPUis0QurjbHE5bIie", "selected":true, "displayOrder":0, "screenAdjust":false, "screenWidth":1680, "screenHeight":1050, "lastModDt":1492550129000, "lastAccessDt":1492550093000, "locked":false, "accessLevel":1, "showWidgetList":true, } |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
415 UNSUPPORTED_MEDIA_TYPE | Cannot consume content type - The server refused this request because the request entity is in a format not supported by the requested resource for the requested method. |
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X POST -d "{\"dashName\":\"clonedDashboardName1\",\"screenWidth\":1000,\"screenHeight\":800}"
https://www.knowi.com/api/1.0/dashboards/110643
List Widgets in Dashboard
Query
GET /api/1.0/dashboards/<objectId>/widgets?byCategory=<byCategory>
Parameter | Comments |
---|---|
objectId | Dashboard id in which to get widgets list |
byCategory | Query parameter, optional. If set, then widgets filtered by specified category |
Response
HTTP Status | Response |
---|---|
200 OK | Output example:
|
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER"
https://www.knowi.com/api/1.0/dashboards/10001/widgets?byCategory=124,923
Export dashboard to PDF
Query
GET /api/1.0/dashboards/<objectId>/export/pdf
Parameter | Comments |
---|---|
objectId | Dashboard id to export to PDF |
Response
HTTP Status | Response |
---|---|
200 OK | Output example:
Pdf binary content. |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" http://localhost:9090/api/1.0/dashboards/10001/export/pdf > file1.pdf
List user Filter sets
Query
GET /api/1.0/dashboards/filterset
Response
HTTP Status | Response |
---|---|
200 OK | Output example:
[ { "createdDate": null, "lastModDate": 1565638416000, "id": 102092, "userId": 1214, "name": "filterset", "accessLevel": 1, "filters": [ { "fieldName": "Customer", "values": [ "Costco", "Facebook", "Macy's" ], "operator": "Equals", "type": "java.lang.String", "enabled": true, "visible": true, "transientFilter": false, "fieldType": "java.lang.String" } ] } ] |
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" http://localhost:9090/api/1.0/dashboards/filterset
Update Filters and Filtersets
Query
PUT /api/1.0/dashboards/<objectId>/filter/update
Parameter | Comments |
---|---|
objectId | Dashboard id into which to update filters and filtersets |
PUT JSON payload:
Sample input, the "properties" contains list of filters, the "filterSets" contains list of filterset to set to dashboard:
{ "properties": [ { "fieldName": "Bounced", "values": [ "5566" ], "operator": "Not Equals", "type": "java.lang.Integer", "enabled": true, "visible": true, "transientFilter": false, "dashboardDisplayValues": [ "5566" ], "fieldType": "java.lang.Integer", "sortIndex": 0 } ], "readOnly": false, "filterSets": [ { "accessLevel": 1, "name": "fs2", "id": 102106, "filters": [ { "fieldName": "Conversions", "values": [ "800" ], "operator": "Not Equals", "type": "java.lang.Integer", "enabled": true, "visible": true, "fieldType": "java.lang.Integer", "fromFilterSet": true } ], "enabled": true, "defaultFilters": false, "locked": false, "visible": true } ] } |
Response
HTTP Status | Response |
---|---|
200 OK | No content returned. |
400 BAD REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X PUT -d '{"properties":[{"fieldName":"Bounced","values":["5566"],"operator":"Not Equals","type":"java.lang.Integer","enabled":true,"visible":true,"transientFilter":false,"dashboardDisplayValues":["5566"],"fieldType":"java.lang.Integer","sortIndex":0}],"readOnly":false,"filterSets":[{"accessLevel":1,"name":"fs2","id":102106,"filters":[{"fieldName":"Conversions","values":["800"],"operator":"Not Equals","type":"java.lang.Integer","enabled":true,"visible":true,"fieldType":"java.lang.Integer","fromFilterSet":true}],"enabled":true,"defaultFilters":false,"locked":false,"visible":true}]}' http://localhost:9090/api/1.0/dashboards/111064/filter/update
Update Default Filters for Dashboard
This will cleanup user filters and Filter Sets on dashboard and set default filters and FilterSets. The filters will be set from input JSON, the FilterSet will be set from current user filtersets from a dashboard.
Query
PUT /api/1.0/dashboards/<objectId>/filter/default
Parameter | Comments |
---|---|
objectId | Dashboard id in which set default filters |
PUT JSON payload:
The "properties" contains list of filters. Sample: { "properties": [ { "fieldName": "Bounced", "values": [ "5566" ], "operator": "Not Equals", "type": "java.lang.Integer", "enabled": true, "visible": true, "transientFilter": false, "dashboardDisplayValues": [ "5566" ], "fieldType": "java.lang.Integer", "sortIndex": 0 } ] } |
Response
HTTP Status | Response |
---|---|
200 OK | No content returned. |
400 BAD REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X PUT -d '{"properties":[{"fieldName":"Bounced","values":["5566"],"operator":"Not Equals","type":"java.lang.Integer","enabled":true,"visible":true,"transientFilter":false,"dashboardDisplayValues":["5566"],"fieldType":"java.lang.Integer"}]}' http://localhost:9090/api/1.0/dashboards/111097/filter/default
Reset User Filters to Default for Dashboard
Query
GET /api/1.0/dashboards/<objectId>/filter/reset
Parameter | Comments |
---|---|
objectId | Dashboard id in which reset user filters to default filters |
Response
HTTP Status | Response |
---|---|
200 OK | No content returned |
400 BAD REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" http://localhost:9090/api/1.0/dashboards/111064/filter/reset
Create Filter Set
Query
POST /api/1.0/dashboards/filterset
No parameters |
---|
POST JSON payload:
Example:
{"properties":[],"color":"#8ec8dc","name":"fs83","enabled":true} |
Response
HTTP Status | Response |
---|---|
200 OK | No content returned |
400 BAD REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X POST -d '{"properties":[],"color":"#8ec8dc","name":"fs83","enabled":true}' http://localhost:9090/api/1.0/dashboards/filterset
Update Filter Set
This update Filterset on chosen dashboard including Filters in Filter Set.
Query
PUT /api/1.0/dashboards/<dashboardId>/filterset/<objectId>
Parameter | Comments |
---|---|
dashboardId | Dashboard id in which to update Filter Set |
objectId | Filter Set id to update |
PUT JSON payload:
To get all varity of input parameters, please create filter in UI first, and then get/list it with another endpoint to investigate possible inputs. It may be changed in future versions. Example: {"properties":[{"visible":true,"enabled":true,"fieldName":"Bounced","fieldType":"java.lang.Integer","operator":"Not Equals","values":["1234567"],"dashboardDisplayValues":["1234"]}]} |
Response
HTTP Status | Response |
---|---|
200 OK | No content returned |
400 BAD REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X PUT -d '{"properties":[{"visible":true,"enabled":true,"fieldName":"Bounced","fieldType":"java.lang.Integer","operator":"Not Equals","values":["1234567"],"dashboardDisplayValues":["1234"]}]}' http://localhost:9090/api/1.0/dashboards/111064/filterset/102110
Make Filter Set Default
Query
PUT /api/1.0/dashboards/<dashboardId>/filterset/<objectId>/default
Parameter | Comments |
---|---|
dashboardId | Dashboard id in which make Filter Set as default |
objectId | Filter Set id to make default |
Response
HTTP Status | Response |
---|---|
200 OK | No content returned |
400 BAD REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X PUT -d '{"properties":[{"fieldName":"Bounced","values":["1234567"],"operator":"Not Equals","type":"java.lang.Integer","enabled":true,"visible":true,"fieldType":"java.lang.Integer","fromFilterSet":true}]}' http://localhost:9090/api/1.0/dashboards/111064/filterset/102110/default
Reset Filter Set to Default
Query
GET /api/1.0/dashboards/<dashboardId>/filterset/<objectId>/default
Parameter | Comments |
---|---|
dashboardId | Dashboard id in which reset Filter Set to default. |
objectId | Filter Set id to reset to default |
Response
HTTP Status | Response |
---|---|
200 OK | No content returned |
400 BAD REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" http://localhost:9090/api/1.0/dashboards/111064/filterset/102110/default
Share Filter set to Users/Groups
Query
PUT /api/1.0/dashboards/filterset/<objectId>/share
Parameter | Comments |
---|---|
objectId | Filter set id to share |
POST JSON payload:
Parameter | Comments |
---|---|
shareProperties | Share properties json array. Available fields:
|
Response
HTTP Status | Response |
---|---|
200 OK | No response body |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } |
415 UNSUPPORTED_MEDIA_TYPE | Cannot consume content type - The server refused this request because the request entity is in a format not supported by the requested resource for the requested method. |
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X PUT -d "{\"shareProperties\" : [ { \"type\" : \"Users\", \"access_level\" : 1, \"name\" : \"someUser@host.com\", \"sso_user\" : true } ] }" http://localhost:9090/api/1.0/dashboards/filterset/102093/share
Delete Filter set
Query
DELETE /api/1.0/dashboards/filterset/<objectId>
Parameter | Comments |
---|---|
objectId | Filter set id to delete |
Response
HTTP Status | Response |
---|---|
200 OK | No response body |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -X DELETE http://localhost:9090/api/1.0/dashboards/filterset/102093
Add Widget to Dashboard
Query
PUT /api/1.0/dashboards/<objectId>/<widgetId>
Parameter | Comments |
---|---|
objectId | Dashboard Id where contained widget to add |
widgetId | Widget Id to add |
PUT JSON payload:
Parameters | Comments |
---|---|
row, col, size_x, size_y | The location and size of the widget on dashboard. The dashboard's width is 24, and all widgets is within this bound. Example: { "row" : 1, "col" : 12, "size_x" : 12, "size_y": 12 } |
Response
HTTP Status | Response |
---|---|
200 OK | No response body |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
415 UNSUPPORTED_MEDIA_TYPE | Cannot consume content type - The server refused this request because the request entity is in a format not supported by the requested resource for the requested method. |
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -H "Content-Type: application/json" -X PUT -d "{\"row\":1, \"col\":12, \"size_x\":12, \"size_y\":12}" http://localhost:9090/api/1.0/dashboards/102093/26811
Remove Widget from Dashboard
Query
DELETE /api/1.0/dashboards/<objectId>/<widgetId>
Parameter | Comments |
---|---|
objectId | Dashboard Id where contained widget is to be remove |
widgetId | Widget Id to remove |
Response
HTTP Status | Response |
---|---|
200 OK | No response body |
400 BAD_REQUEST |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
Error details:
|
401 UNAUTHORIZED |
{ "message": <Error details>, "documentation_url": <Documentation link> } Common error details:
|
403 FORBIDDEN |
{ "message": <Error details>, "documentation_url": <Documentation link> } Error details:
|
Example
curl -i -H "Authorization: Bearer HERE_IS_YOUR_BEARER" -X DELETE http://localhost:9090/api/1.0/dashboards/102093/26811