Create Report Request

post

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id/{tenantId}/reports

Path Params

tenantId

string

required

Tenant identifier.

Body Params

brandCode

string

required

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

region

string

required

Region.

reportTypeId

string

Report type identifier.

reportTypeName

string

Report type name.

locale

string

enum

Locale in [ISO 639-1]-[ISO 3166-1] format.

Allowed:

destinationSidedrawerId

string

required

Destination Drawer (sidedrawer) identifier.

destinationRecordId

string

required

Destination Folder (record) identifier.

params

object

required

Report parameters.

attachCommentsAsAnnotations

object

Attach comments as annotations.

Response

200

The given Report.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!