Skip to main content

/Info/Filters/:datasource

Returns information about the filters available for the given data source (which is either a cube or a KPI).

Request Method

GET or POST

URL Parameters

datasource

Required. Name of the data source. This is one of the following:

  • cubename — a logical cube name

  • cubename.cube — a logical cube name, followed by .cube

  • kpiname.kpi — a logical KPI name, followed by .kpi

This name can include slashes; see Use of Slashes in Cube and KPI Names.

Request Body Details

This endpoint ignores the request body.

Example Request

Example Response

{
    "Info": {
        "Error":"",
        "DataSource":"aviationevents.cube",
        "DataSourceType":"cube"
    },
    "Result": {
        "Filters": [
            {"caption":"Year","value":"[EventDateD].[H1].[Year]","type":"year"},
            {"caption":"Month","value":"[EventDateD].[H1].[Month]","type":""},
            {"caption":"Day","value":"[EventDateD].[H1].[Day]","type":""}
        ...]
    }
}

In the response object, the Result property contains a property called Filters, which contains an array of objects, one for each filter. Each object has the following properties:

  • caption contains the display value for the filter.

  • type contains the filter type, if it exists. This can be "calc" or can be the name of a time function. In other cases it is empty.

  • value contains the filter specification, which is the logical identifier for the filter. For information on the filter specification, see POST /Info/FilterMembers/:datasource/:filterSpec.

For information that applies to all response objects, see Notes on the Response Objects.

FeedbackOpens in a new tab