Retrieve a page from the latest eligible named report.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core",
  "report_name": "Daily risk overview",
  "reporting_currency": "USD",
  "market_data_environment_names": [
    "<string>"
  ],
  "portfolio_name": "Example portfolio",
  "live_scheduled_report": true
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows"

payload = {
    "$type": "Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core",
    "report_name": "Daily risk overview",
    "reporting_currency": "USD",
    "market_data_environment_names": ["<string>"],
    "portfolio_name": "Example portfolio",
    "live_scheduled_report": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    $type: 'Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core',
    report_name: 'Daily risk overview',
    reporting_currency: 'USD',
    market_data_environment_names: ['<string>'],
    portfolio_name: 'Example portfolio',
    live_scheduled_report: true
  })
};

fetch('https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '$type' => 'Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core',
    'report_name' => 'Daily risk overview',
    'reporting_currency' => 'USD',
    'market_data_environment_names' => [
        '<string>'
    ],
    'portfolio_name' => 'Example portfolio',
    'live_scheduled_report' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core\",\n  \"report_name\": \"Daily risk overview\",\n  \"reporting_currency\": \"USD\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"portfolio_name\": \"Example portfolio\",\n  \"live_scheduled_report\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core\",\n  \"report_name\": \"Daily risk overview\",\n  \"reporting_currency\": \"USD\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"portfolio_name\": \"Example portfolio\",\n  \"live_scheduled_report\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"$type\": \"Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core\",\n  \"report_name\": \"Daily risk overview\",\n  \"reporting_currency\": \"USD\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"portfolio_name\": \"Example portfolio\",\n  \"live_scheduled_report\": true\n}"

response = http.request(request)
puts response.read_body

{
  "$type": "Derivitec.Web.Core.ReportQuery.ApiGetAgGridRowsResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "last_row": 123,
  "data": [
    "<unknown>"
  ],
  "segment_loaded_time": "2023-11-07T05:31:56Z"
}

Retrieve a page from the latest eligible named report.

Selects the latest completed report available for the named report and portfolio within the authenticated caller’s access, then returns the requested grid page. This is a read, not a report launch, and it does not accept a report-run identifier. Caller, organisation, time zone, internal report and portfolio identifiers, market-data context, and effective row restrictions are server-managed.

POST

api

ReportQueryViewUser

GetRows

Retrieve a page from the latest eligible named report.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core",
  "report_name": "Daily risk overview",
  "reporting_currency": "USD",
  "market_data_environment_names": [
    "<string>"
  ],
  "portfolio_name": "Example portfolio",
  "live_scheduled_report": true
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows"

payload = {
    "$type": "Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core",
    "report_name": "Daily risk overview",
    "reporting_currency": "USD",
    "market_data_environment_names": ["<string>"],
    "portfolio_name": "Example portfolio",
    "live_scheduled_report": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    $type: 'Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core',
    report_name: 'Daily risk overview',
    reporting_currency: 'USD',
    market_data_environment_names: ['<string>'],
    portfolio_name: 'Example portfolio',
    live_scheduled_report: true
  })
};

fetch('https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '$type' => 'Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core',
    'report_name' => 'Daily risk overview',
    'reporting_currency' => 'USD',
    'market_data_environment_names' => [
        '<string>'
    ],
    'portfolio_name' => 'Example portfolio',
    'live_scheduled_report' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core\",\n  \"report_name\": \"Daily risk overview\",\n  \"reporting_currency\": \"USD\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"portfolio_name\": \"Example portfolio\",\n  \"live_scheduled_report\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core\",\n  \"report_name\": \"Daily risk overview\",\n  \"reporting_currency\": \"USD\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"portfolio_name\": \"Example portfolio\",\n  \"live_scheduled_report\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/ReportQueryViewUser/GetRows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"$type\": \"Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core\",\n  \"report_name\": \"Daily risk overview\",\n  \"reporting_currency\": \"USD\",\n  \"market_data_environment_names\": [\n    \"<string>\"\n  ],\n  \"portfolio_name\": \"Example portfolio\",\n  \"live_scheduled_report\": true\n}"

response = http.request(request)
puts response.read_body

{
  "$type": "Derivitec.Web.Core.ReportQuery.ApiGetAgGridRowsResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "last_row": 123,
  "data": [
    "<unknown>"
  ],
  "segment_loaded_time": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

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

Body

The body containing required accessible ReportName and PortfolioName; GridQuery with rows defaulting from StartRow=0 through EndRow=50 plus optional grouping, group keys, filters, sorting, and IsTimeSeriesRequest; optional PortfolioType, reporting currency, market-data environment names, and PnlLookback; and LiveScheduledReport, which defaults to false.

Selectors for retrieving the latest available report-grid rows by report name.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.ReportQuery.ApiGetLatestAgGridRowsRequest, Derivitec.Web.Core

report_name

string | null

Organisation-scoped name of the report definition to use. The value must not be null or empty.

Example:

"Daily risk overview"

reporting_currency

string | null

Currency in which report values are expressed. When null, the service uses the caller's configured reporting currency or USD.

Example:

"USD"

market_data_environment_names

string[] | null

Names of market-data environments to use for the report. The list is empty by default.

portfolio_name

string | null

Name of the portfolio to select. The value must not be null or empty.

Example:

"Example portfolio"

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

pnl_lookback

enum<string> | null

Optional predefined P&L lookback selection.

Available options:

daily,

month_to_date,

quarter_to_date,

year_to_date,

annual

grid_query

object

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

Show child attributes

live_scheduled_report

boolean

Whether the latest-row request addresses the exposed live scheduled-report mode.

Response

Returns the selected report rows, LastRow, and segment-loaded time, or an unsuccessful envelope when no eligible report or required row restriction is available.

Paged report-result rows, their result-version timestamp, and final-row indicator.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.ReportQuery.ApiGetAgGridRowsResponse, 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>

Total row count when established, or -1 when the final count is not yet known.

data

any[] | null

Report-grid rows returned for the requested page.

segment_loaded_time

string<date-time>

Timestamp identifying the returned result segment.

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Retrieve a page from the latest eligible named report.

Authorizations

Body

Response