Skip to main content
POST
Search accessible PnL report-run history.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

The body containing optional PortfolioType; Period as All, Today, Yesterday, LatestWeek, LatestMonth, or LatestYear; and GridQuery. Grid rows default from StartRow=0 through EndRow=50 and may include grouping, group keys, filters, sorting, and IsTimeSeriesRequest, which defaults to false. Caller, organisation, time zone, accessible portfolio types, and market-data context are server-managed.

Grid and period selectors for retrieving P&L report-history rows.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.ReportHistory.ApiReportHistoryRowsGetPnlRequest, Derivitec.Web.Core
grid_query
object

Client grid query for selecting, grouping, filtering, and sorting report rows.

period
enum<string>

Predefined date period used to select report-history rows.

Available options:
all,
today,
yesterday,
latest_week,
latest_month,
latest_year
period_filter
object

Date filter in a client report-grid query.

portfolio_type
enum<string> | null

Portfolio category used to resolve the requested portfolio. It may be omitted when the portfolio name resolves unambiguously.

Available options:
derivitec,
enfusion,
orchestrade,
liquidity_book,
maia,
fund_studio,
not_set

Response

Returns PnL report-run history items and the page's LastRow continuation value.

Paged P&L report-history rows and their final-row indicator.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.ReportHistory.ApiReportHistoryRowsGetPnlResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

last_row
integer<int32>

Final row count, or -1 when another history page remains.

history_data
object[] | null

History rows returned for the requested page.