GetReportSettingsResponse

The response body for the POST /api/v1/reports/get_report_settings endpoint.

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

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200

Example: 200

successboolean

Indicates whether the request was successful (normally true if it's not an error response).

Default value: true

uristring

URL of the current request / resource, for reference purposes.

Example: https://example.apps.journyx.com/api/v1/users

statusstring[]

An array of status (confirmation) messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a green icon.

errorsstring[]

An array of error messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a red error icon.

warningsstring[]

An array of warning messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a yellow warning icon.

infostring[]

An array of informational messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a blue info icon.

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.

]

GetReportSettingsResponse

{
  "response_code": 200,
  "success": true,
  "uri": "https://example.apps.journyx.com/api/v1/users",
  "status": [
    "string"
  ],
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "info": [
    "string"
  ],
  "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": {}
    }
  ]
}