Skip to main content

List sync filters

GET https://api.rollstack.com/public/v1/reports/{id}/syncs/{syncId}/filters

The filters of the dashboard an older report's sync reads, which a burst of the report can vary by: pass their ids in filters to createBurst. Read from the dashboard with your access to its connection, so it can take a few seconds. Find the report's syncs with listReportSyncs. A Rollstack report bursts by report parameters instead: see getReportParameters.

Requires the slide_decks:read scope.

Operation ID: listReportSyncFilters.

Path parameters

  • id (string, required): The report to act on, of any type, by its id from listReports or createReport. You can also copy it from the report's link in Rollstack (appUrl): it's the part right after /slides/ or /destinations/.
  • syncId (string, required): The sync whose dashboard filters to list, by its id from listReportSyncs.

Response 200

Success

application/json

  • filters (array of object, required): The filters of the sync's dashboard a burst can vary by, by name.
    • id (string, required): The filter's id. Pass it in filters to createBurst to make a burst whose variants differ by it.
    • name (string, required): The filter's name on the sync's dashboard.
    • valueType (string or null, required): The kind of value Rollstack can set in the filter: the type of each variant's value of it. null when Rollstack doesn't know the filter's editor. One of categorical, date, number, text.
  • unsupported (array of object, required): The dashboard's filters Rollstack can't set, so a burst can't vary by them.
    • name (string, required): The filter's name on the dashboard.