Skip to main content

Bust Filter Cache

Either filter ID or filter variable name can be used as parameter to bust cache. An acknowledged message as below would be returned if success or error if invalid parameter.

Request​

POST /shared_filters/bust_cache

With filter ID​

Parameter​

  • filter_id: Integer. Filter ID.

Without filter ID​

Parameter​

  • var_name: String. Variable name of target filter.
  • filterable_id: Integer. ID of Dashboard/Report containing target filter.
  • filterable_type: String. Type of Dashboard/Report containing target filter. Possible values: 'Dashboard', 'QueryReport'.

Response​

{ 
  "status": "OK"
}

Rate Limiting​

The default rate limiting is 20 requests per 60 seconds and will be blocked for 60 seconds when rate limit is exceeded.

Permission Control​

  • API is only accessible through user's valid API key
  • Only admin and analyst users can bust filter cache

Error Responses​

Filter not found​

This error indicates that your target filter cannot be found.

{
    "errors": [
        "Filter not found"
    ]
}

Not passing required parameters​

These errors indicate that the required parameter(s) are missing.

{
    "errors": [
        "Either (id) or (filterable_id, filterable_type, var_name) is required"
    ]
}
{
    "errors": [
        "param is missing or the value is empty: ..."
    ]
}