Skip Navigation

The online Trailblazer Community becomes read-only Oct 30, 2026. Read More

Consumer Goods Cloud Developer Guide

Report Execution Filter Types and Limits

Here are the different types of filters you can specify to execute a report.

The specified report filters must match the filters defined in the RTR report metadata configuration (RTR Report Configuration sObject).

singleselect

Here’s the metadata filter.

1{
2    "type": "singleselect",
3    "name": "kpigroup",
4    "label": "KPI Set",
5    "source": "KPIGroup"
6}

Here’s the corresponding Apex filter.

1...
2    'kpigroup' => 'Plan',
3...

multiselect

Here’s the metadata filter.

1{
2    "type": "multiselect",
3    "name": "promo_phase",
4    "label": "Promotion Phase",
5    "source": "PromotionPhase",
6    "defaultValue": [
7        "Planning"
8    ]
9}

Here’s the corresponding Apex filter.

1...
2    'promo_phase' => new List<String> {
3        'Planning',
4        'Modeling',
5        'Committed',
6        'ForApproval'
7    },
8...

periodmonth

Here’s the metadata filter.

1{
2    "label": "Period",
3    "type": "periodmonth",
4    "name": "periodmonth"
5}

Here’s the corresponding Apex filter.

1...
2    'periodmonth' => new Map<String, Object> {
3        'start' => 0, // The starting month. A value between 0 (January) and 11 (December)
4        'total' => 12, // How many month data to retrieve. A value between 1 and 18
5        'year' => 2022 // The starting year
6    },
7...

periodweek

Here’s the metadata filter.

1{
2    "label": "Period",
3    "type": "periodweek",
4    "name": "periodweek"
5}

Here’s the corresponding Apex filter.

1...
2    'periodweek' => new Map<String, Object> {
3        'start' => 0, // The starting Week. A value between 0 (First week of the year) to 70 
4        'total' => 12, // How many weeks data to retrieve. A value between 1 and 100
5        'year' => 2022 // The starting year
6    },
7...

hidden

Here’s the metadata filter.

1{
2     "label": "Not Seen",
3     "type": "promo_s_textfield",
4     "name": "hidden",
5     "defaultValue" : "<<FIRST_VALUE>>",
6     "source" : [{
7        "label" : "example",
8        "value" : "value1"
9     }]
10}

Here’s the corresponding Apex filter.

1...
2    'promo_s_textfield' => 'value1',
3...

fixed

Here’s the metadata filter.

1{
2     "label": "Fixed Filter",
3     "type": "promo_s_textfield2",
4     "name": "fixed",
5     "defaultValue" : "<<FIRST_VALUE>>",
6     "source" : [{
7        "label" : "example",
8        "value" : "value1"
9     }]
10}

Here’s the corresponding Apex filter.

1...
2    'promo_s_textfield2' => 'value1',
3...

subaccount

Here’s the metadata filter.

1{
2    "type": "subaccount",
3    "name": "subaccountsfids",
4    "label": "Sub Accounts",
5    "accountfilter": "accountsfids",
6    "source": "SubAccounts"
7}

Here’s the corresponding Apex filter.

1...
2    'subaccountsfids' => new List<String> { '001SL0000004dfgYAA' },
3...

Filter Limits

Filter Name	Limit
`accountsfids`	50
`subaccountsfids`	50
`productsfids`	50