Skip to main content
POST
Request factsheet generation

Authorizations

Authorization
string
header
required

Enter 'Bearer' followed by a space and then your JWT or API Key. Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... or Bearer YOUR_API_KEY_HERE

Path Parameters

strategyId
string<uuid>
required

UUID of the strategy.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Body

application/json

Parameters for requesting factsheet generation.

as_of_date
string<date>

The as-of date in YYYY-MM-DD format that selects the run. When omitted, the latest completed run for the version is used.

Pattern: ^\d{4}-\d{2}-\d{2}$
version_id
string<uuid>

The version to use. When omitted, the strategy's active version is used.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
force
boolean
default:false

Generate again even when a factsheet exists or is already being generated for the run.

Response

Factsheet generation was requested.

status
string
required
Example:

"generating"