ReportSettingsObject

The current settings for the report. This includes the report's name, description, and the settings for the report's display columns.

options object[]

The set of report options.

Array [

keystring

The internal ID of the report setting.

Example: anchordom

valuestring

The value of the report setting.

hiddenboolean

If this key is present and true, then this report option will be hidden in the UI.

Example: false

items object[]

The list of options or choices for the report setting, if applicable.

Array [

valuestring

The internal ID of the option.

textstring

The display name of the option.

]

]

filters object[]

The list of all filters that the report users.

Array [

keystring

The internal ID of the filter.

Example: userfilter

labelstring

The display name of the filter.

Example: Users

reptypeinteger

The internal code for the type of report.

Example: 10

includestring

The scope of the filter.

Example: ALL

selectedstring[]

The list of currently selected choices for the filter.

selectItems object[]

Array [

valuestring

The internal ID of the filter choice.

Example: 1

textstring

The display name of the filter choice.

Example: Sales

]

matchstring

The match type for the filter. Either and or or.

Example: and

customFiltersarray

The list of Custom Field filters that the report users.

canFilterCustomFieldsboolean

Whether the report can filter by Custom Fields. In other words, are there any ENUM custom fields that are relevant to this report type?

Example: true

tableNamestring

The table name of the base object that this filter applies to. Example: users, projects.

Example: users

searchParamsobject

An optional dictionary of search parameters for the filter's internal UI search component.

]

ReportSettingsObject

{
  "options": [
    {
      "key": "anchordom",
      "value": "string",
      "hidden": false,
      "items": [
        {
          "value": "string",
          "text": "string"
        }
      ]
    }
  ],
  "filters": [
    {
      "key": "userfilter",
      "label": "Users",
      "reptype": 10,
      "include": "ALL",
      "selected": [
        "string"
      ],
      "selectItems": [
        {
          "value": 1,
          "text": "Sales"
        }
      ],
      "match": "and",
      "customFilters": [
        null
      ],
      "canFilterCustomFields": true,
      "tableName": "users",
      "searchParams": {}
    }
  ]
}