GetReportFilterPreferences

GetReportFilterPreferences returns preferences for filters in reports and

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request for the GetFilterPreferences RPC.

field_mask

string

field_mask

optional

Field mask for filtering each field.

Example

{
  "field_mask": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response for the GetFilterPreferences RPC.

filter_preferences

object (FilterPreferences)

filter_preferences

optional

Filter preferences entity.

default_auto_report_filter

optional

Default filtering for automated reports.

default_broadcast_resend_filter

optional

Determines which contact records will be included in the new broadcast.

org_id

string

org_id

optional

Org ID.

send_empty_auto_reports

boolean

send_empty_auto_reports

optional

Whether to send auto-reports even if they are empty.

display_broadcast_resend_filter

boolean

display_broadcast_resend_filter

optional

Whether or not to display the setting in the 'Resend' window.

Example

{
  "filter_preferences": {
    "default_auto_report_filter": {},
    "default_broadcast_resend_filter": {},
    "org_id": "string",
    "send_empty_auto_reports": true,
    "display_broadcast_resend_filter": true
  }
}

🔴500Server Error