Skip to main content
POST
/
brokerage-firms
/
{brokerageFirmId}
/
reports
Generate report for brokerage firm
curl --request POST \
  --url https://api.example.com/brokerage-firms/{brokerageFirmId}/reports \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "params": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "uploadToConnectors": true,
  "productIds": [
    "<string>"
  ]
}
'
{}

Path Parameters

brokerageFirmId
string
required

the brokerageFirm id

Body

application/json

Report generation parameters

type
string
required

The type of report

params
object[]
required

Report specific parameters

uploadToConnectors
boolean

uploadToConnectors

productIds
string[]

The productIds

Response

200 - application/json

Report generation started or completed successfully.

The response is of type object.