Dashboard Filter Options Analysis
Verifies that dashboard filter options are compatible with source report fields. Use this resource to testAvailable in API version 40.0 and later.
Syntax
URI: /services/data/vXX.X/analytics/dashboards/dashboardID/filteroptionsanalysis
Formats: JSON
HTTP methods: POST
Authentication: Authorization: Bearer token
POST Request Body
| Property | Type | Description |
|---|---|---|
| filterColumns | filterColumns[] |
An array of fields from the source report which you check filter values against. Each object in the array has these properties:
reportId: The the source report’s unique ID. name: The report field’s API name. |
| options | options[] |
An array of objects describing a dashboard filter. Each object has these properties:
alias: The display name of the filter value. operation: The filter’s operator. value: The value applied by the filter. startValue: If the filter includes a range (such as a date range), the start of the range. Otherwise, null. endValue: If the filter includes a range (such as a date range), the end of the range. Otherwise, null. |
POST Response Body
If successful, returns an empty response.
Example POST Request
1{
2 "filterColumns" : [{
3 "reportId": "00OR0000000P76tMAC",
4 "name": "ACCOUNT_TYPE"
5 }],
6 "options": [{
7 "alias": "New",
8 "operation": "contains",
9 "value": "New",
10 "startValue": null,
11 "endValue": null
12 }]
13}
j