Dashboard API filter parameter ignored when fetching data for widgets

BA/BI IBM Cognos Analytics
, , , , , , , ,
1

I’m working with the Cognos Analytics REST API to programmatically fetch dashboard data with filters applied. The API request accepts filter parameters, but they seem to be completely ignored when the data is returned.

My API request formatting looks correct - I’m passing filters as JSON in the request body:

{"filters": [{"column": "sales_region", "operator": "eq", "value": "APAC"}]}

The dashboard widget configuration shows the filter column exists and is properly mapped to the data source. However, the API returns the full unfiltered dataset every time. I’ve verified the REST API filter syntax matches the documentation, but something isn’t working. Has anyone encountered this issue where filter parameters just don’t get applied through the API?

2

The filterExpressions suggestion is on the right track. I’d also add that you need to ensure the Content-Type header is set to application/json and that you’re including the authentication token properly. Sometimes if the auth token doesn’t have the right permissions, the API silently ignores filters as a security measure. Check your API logs - they might show a warning about filter permissions being denied even though the request returns 200 OK.

3

I’ve seen this before. The filter syntax in your JSON looks correct, but have you checked if the dashboard widget itself has any pre-existing filters that might be conflicting? Sometimes the widget-level filters take precedence over API-level filters. Also verify that the column name exactly matches what’s in the data model - case sensitivity matters here.

4

Perfect! The filterExpressions structure was exactly what I needed. Changed my request body to use that format and now the filters are being applied correctly. For anyone else hitting this, here’s what worked:

{
  "filterExpressions": [
    {"dataItemName": "sales_region", "operator": "=", "values": ["APAC"]}
  ]
}

The key differences from what I was doing:

  1. Use “filterExpressions” not “filters” as the root property
  2. Use “dataItemName” instead of “column” to reference the field
  3. Operator should be “=” for equality, not “eq”
  4. Values must be an array even for single values

I also verified my authentication token had the correct permissions by checking the API response headers. The documentation really should be clearer about the filterExpressions structure - it’s mentioned briefly but not emphasized as the correct approach.

Regarding dashboard widget configuration, make sure your widget is configured to accept dynamic parameters. In the widget properties, there’s a setting under “Data” → “Parameters” that needs to be enabled for API filters to work. Without this, the widget ignores external filter requests entirely.

For API request formatting best practices, always validate your JSON structure before sending. I used a JSON validator which helped catch some subtle syntax issues. Also important: when working with date filters, the format needs to match exactly what’s in your data model (ISO 8601 typically). The API won’t convert formats automatically.

One more tip on REST API filter syntax - you can combine multiple filters using AND/OR logic by adding a “filterLogic” property at the same level as filterExpressions. This is useful for complex filtering scenarios where you need multiple conditions.