Check a report's Atoti loading progress.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/AtotiReport/Status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "report_id": "synthetic-report-run",
  "$type": "Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core",
  "restore_cube_only": true,
  "dashboard_template_only": true
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/AtotiReport/Status"

payload = {
    "report_id": "synthetic-report-run",
    "$type": "Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core",
    "restore_cube_only": True,
    "dashboard_template_only": 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({
    report_id: 'synthetic-report-run',
    $type: 'Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core',
    restore_cube_only: true,
    dashboard_template_only: true
  })
};

fetch('https://api.riskportal.activeviam.com/api/AtotiReport/Status', 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/AtotiReport/Status",
  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([
    'report_id' => 'synthetic-report-run',
    '$type' => 'Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core',
    'restore_cube_only' => true,
    'dashboard_template_only' => 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/AtotiReport/Status"

	payload := strings.NewReader("{\n  \"report_id\": \"synthetic-report-run\",\n  \"$type\": \"Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core\",\n  \"restore_cube_only\": true,\n  \"dashboard_template_only\": 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/AtotiReport/Status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"report_id\": \"synthetic-report-run\",\n  \"$type\": \"Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core\",\n  \"restore_cube_only\": true,\n  \"dashboard_template_only\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/AtotiReport/Status")

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  \"report_id\": \"synthetic-report-run\",\n  \"$type\": \"Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core\",\n  \"restore_cube_only\": true,\n  \"dashboard_template_only\": true\n}"

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

{
  "$type": "Derivitec.Web.Core.Atoti.AtotiReportResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "state": "loading",
  "message": "<string>",
  "dashboard_ready": true,
  "dashboard_url": "<string>",
  "dashboard_template": "<string>"
}

Check a report's Atoti loading progress.

Rechecks current report, organisation, portfolio and market-data access before returning progress or a dashboard URL. A loading response can include dashboard_ready and a trusted URL after schema, layout and deny-all access controls are published; report rows remain unavailable until data and permissions commit. Continue polling until ready. Dashboard URLs select the authenticated user’s saved dashboard for this organisation and report definition, binding the layout to the requested saved run; the loaded cube remains shared. The organisation adapter is consulted after preparation completes so a restarted or expired session is not reported as ready. This operation does not queue a new import; call Open again when the current session has lost the report. Set restore_cube_only to true to prepare or check the report cubes without creating or rebinding a personal dashboard; responses then have a null dashboard URL. The default is false. Use the same flag on Open and Status, or VarOpen and VarStatus, when restoring data for an existing dashboard. All report access checks still apply. Set dashboard_template_only to true on both open and status requests to obtain an unsaved dashboard_template JSON layout once report data is ready, without creating or rebinding a personal dashboard. This flag defaults to false, takes precedence over restore_cube_only, and keeps the dashboard URL null; loading responses do not contain a template.

POST

api

AtotiReport

Status

Check a report's Atoti loading progress.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/AtotiReport/Status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "report_id": "synthetic-report-run",
  "$type": "Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core",
  "restore_cube_only": true,
  "dashboard_template_only": true
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/AtotiReport/Status"

payload = {
    "report_id": "synthetic-report-run",
    "$type": "Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core",
    "restore_cube_only": True,
    "dashboard_template_only": 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({
    report_id: 'synthetic-report-run',
    $type: 'Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core',
    restore_cube_only: true,
    dashboard_template_only: true
  })
};

fetch('https://api.riskportal.activeviam.com/api/AtotiReport/Status', 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/AtotiReport/Status",
  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([
    'report_id' => 'synthetic-report-run',
    '$type' => 'Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core',
    'restore_cube_only' => true,
    'dashboard_template_only' => 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/AtotiReport/Status"

	payload := strings.NewReader("{\n  \"report_id\": \"synthetic-report-run\",\n  \"$type\": \"Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core\",\n  \"restore_cube_only\": true,\n  \"dashboard_template_only\": 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/AtotiReport/Status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"report_id\": \"synthetic-report-run\",\n  \"$type\": \"Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core\",\n  \"restore_cube_only\": true,\n  \"dashboard_template_only\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/AtotiReport/Status")

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  \"report_id\": \"synthetic-report-run\",\n  \"$type\": \"Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core\",\n  \"restore_cube_only\": true,\n  \"dashboard_template_only\": true\n}"

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

{
  "$type": "Derivitec.Web.Core.Atoti.AtotiReportResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ],
  "state": "loading",
  "message": "<string>",
  "dashboard_ready": true,
  "dashboard_url": "<string>",
  "dashboard_template": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

Required saved report-run identifier used for the original Open request. Caller context is server-managed.

Checks the current Atoti session after rechecking the caller's report access.

report_id

string

required

Opaque saved report-run identifier, including its observation-date suffix for a historical PnL output. Required; this is not a report-definition or view identifier.

Minimum string length: 1

Example:

"synthetic-report-run"

$type

enum<string>

required

Available options:

Derivitec.Web.Core.Atoti.AtotiReportStatusRequest, Derivitec.Web.Core

restore_cube_only

boolean

When true, prepares or checks only the saved report cubes without creating, rebinding or opening a personal dashboard. Defaults to false. Access checks still apply, and responses have a null dashboard URL. Use the same value when polling status to preserve an existing dashboard layout.

Example:

true

dashboard_template_only

boolean

When true, returns an unsaved dashboard layout as JSON once report data is ready, without creating, rebinding or opening a personal dashboard. Defaults to false and takes precedence over restore_cube_only. All report access checks apply. Send the same value on open and status requests; the dashboard URL remains null.

Example:

true

Response

Returns current loading or ready state, or a failure envelope when the report or session is unavailable or access is denied.

Progress and navigation information for loading a saved report into Atoti.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.Atoti.AtotiReportResponse, 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.

state

string | null

Current state: loading while queued or importing, ready when the current session has committed report data and access permissions, or failed when unavailable, unauthorized or incompatible. Defaults to failed.

Example:

"loading"

message

string | null

Human-readable progress or failure explanation. Null when no additional explanation is supplied.

dashboard_ready

boolean

True when the current session has published the report cube schema and dashboard layout with access controls that deny report rows until data and permissions commit. May be true while state is loading; this does not indicate that report data is ready. Defaults to false and remains available for cube-only restoration.

Example:

true

dashboard_url

string | null

Trusted dashboard URL (portal-relative in Release, loopback in local development), present when ready or when loading with dashboard_ready true. Loading dashboards may be empty; continue polling until state is ready for report data. Null before dashboard readiness, after failure, or when restore_cube_only or dashboard_template_only is true; expires when the session restarts.

dashboard_template

string | null

JSON-encoded unsaved dashboard layout object for the requested saved run. Present only when dashboard_template_only is true and report data is ready; null while loading, after failure, and for other request modes. The caller can display this layout without saving a personal dashboard.

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Check a report's Atoti loading progress.

Authorizations

Body

Response