Skip to main content
POST
Generate report for brokerage firm

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

brokerageFirmId
string
required

the brokerageFirm id

Pattern: ^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

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

201 - application/json

Report generation started or completed successfully.

The response is of type object.