Filters

Description

Parameters are used to filter data and group it by time. Data is filtered during report generation. Operations are applied to the parameters and the report is created according to the input conditions. Available parameters are listed in the filters section of the GET /constructor_filters/api/ operation.

In the interface, these parameters are shown here:

Acceptable parameters

Of the entire set of parameters, period is required and only two are acceptable:

• period — Required parameter. The value type is a string, and you can specify it as one day ("2022.04.21") or a time interval ("2022.01.01-2022.04.21").
• detalization — Optional parameter that specifies grouping by time intervals (day, week, month, and so on). By default, the parameter performs grouping by days. To select a specific grouping, use its id as the parameter value. For example, to group by month:

{
"id": "detalization",
"value": "3"
}

Example of filters

{
  "id": "filters",
  "fields": [
    {
      "id": "detalization",
      "value": "1",
      "choices": [
        {
          "id": "1",
          "label": "By days",
          "slug": "by_days"
        },
        {
          "id": "2",
          "label": "By weeks",
          "slug": "by_weeks"
        },
        {
          "id": "3",
          "label": "By months",
          "slug": "by_months"
        },
        {
          "id": "4",
          "label": "By quarters",
          "slug": "by_quarters"
        },
        {
          "id": "5",
          "label": "By years",
          "slug": "by_years"
        },
        {
          "id": "6",
          "label": "Without groupings",
          "slug": "without_detalization"
        }
      ]
    },
    {
      "id": "period",
      "value": null
    }
  ]
}