Skip to main content
GET
/
brokerage-firms
/
{brokerageFirmId}
/
reports
/
{type}
/
config
{
  "availableProductIds": [
    "<string>"
  ],
  "params": [
    {
      "key": "<string>",
      "type": "BOOLEAN",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "defaultValue": "<string>",
      "required": true
    }
  ]
}

Path Parameters

brokerageFirmId
string
required

the brokerageFirm id

type
string
required

The type of report

Response

200 - application/json

Report configuration retrieved successfully.

availableProductIds
string[]
required
params
object[]
required