Dashboard Filter Options Analysis | Reference | Salesforce Reports and Dashboards REST API Developer Guide

Verifies that dashboard filter options are compatible with source report fields. Use this resource to testAvailable in API version 40.0 and later.

URI: /services/data/vXX.X/analytics/dashboards/dashboardID/filteroptionsanalysis

Formats: JSON

HTTP methods: POST

Authentication: Authorization: Bearer token

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.

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.

If successful, returns an empty response.