Get report view

Returns the specified report view.

A report view is a collection of metrics, statistics, loss tables, and reports that is generated automatically whenever an UnderwriteIQ client creates exposures in batch using the Create Batch Job operation.

A batch job defines single end-to-end workflow that combines multiple operations into a job consisting of discreet tasks that are processed in sequence. For example, a single batch workflow could create , geocode and perform hazard lookups of location exposures, model those exposures, and then export analysis results.

Metric Types

The contents of the report view depend on the tasks defined in the batch job.

Batch Job TasksMetric Types Returned
Create Model JobELT, EP, LLR, LOCATION_AAL, PLT, POLICY_EP, POLICY_STATS, STATS
Create Model Job, Create Group JobGROUP_ELT, GROUP_EP, GROUP_PLT, GROUP_POLICY_EP, GROUP_POLICY_STATS, GROUP_STATS,
Create Model Job, Create Group Job, Calculate Marginal ImpactGROUP_MARGINAL_EP, GROUP_MARGINAL_STATS
LOCATION_RESULTS
Calculate Marginal ImpactMARGINAL_EP, MARGINAL_STATS
Create Risk Data Report (EXPOSURE_SUMMARY)EXPOSURE_SUMMARY
Create Risk Data Report (PORTFOLIO_ACCUMULATION_DETAILS)ACCUMULATIONS_BY_GEOGRAPHY_ADMIN1, ACCUMULATIONS_BY_GEOGRAPHY_ADMIN2, ACCUMULATIONS_BY_GEOGRAPHY_COUNTRY, ACCUMULATIONS_BY_GEOGRAPHY_POSTALCODE, ACCUMULATIONS_BY_LOCATION, ACCUMULATIONS_BY_POLICY, ACCUMULATIONS_BY_TREATY, ACCUMULATION_EVENTS

Responses

This operation returns summary information about the report view and about the analysis results and reports included in the report.

{
  "reportViewId": 694,
  "reportViewName": "New Business Demo",
  "exposureName": "TEST_IMPORT_EDM_RM",
  "createdAt": "2023-04-03T03:19:26.445Z",
  "exposureId": 10171,
  "exposureResourceId": 673,
  "exposureResourceType": "ACCOUNT",
  "createdBy": "[email protected]",
  "notes": "",
  "details": [ // metric-specific details]
}

The content of the details array varies depending on the metric type.

  • If the metricType is returned by an analysis result, the details array provides detailed information about the analysis result that returned the metric, statistic, or loss table.
  • If the metricType is returned by report, returns informaiton about the report including the URL of the downloadable report.

Metrics, Statistics, and Loss Tables

For metrics, statistics, and loss tables (e.g. EP, STATS, ELT) returned in an analysis result, the details array returns summary information about that analysis result result including theanalysisId, peril, region, and the URL of the analysis result itself.

{
  "details": [
    {
      "metricType": "ELT",
      "analysisId": 50556,
      "appAnalysisId": 11891,
      "metricUrl": "https://{host}/platform/riskdata/v1/analyses/50556/elt?perspectiveCode=GR&exposureResourceId=673&exposureResourceType=ACCOUNT",
      "additionalInfo": {
        "peril": "EQ",
        "region": "NA",
        "analysisName": "IMPORT_EDM_RM: ACCOUNT: NAEQ-JSON"
      }
    }
  ]
}

The details array returns detailed information about the analysis result that returned the metric, statistic, or loss table.

PropertyDescription
metricTypeType of the metric, statistic, or loss table.
analysisIdID of the analysis result that returned the metric.
appAnalysisIdID (in the applicaiton) of the analysis that returned the metric.
metricUrlURL of the analysis result that returned the metric.
additionalInfoInformation about the analysis including the name of the analysis, and the peril and region modeled .

Reports

For reports (e.g. EXPOSURE_SUMMARY, LOCATION_RESULTS), the response returns summary information about the report and URL of a downloadable report.

{
  "details": [
    {
      "metricType": "EXPOSURE_SUMMARY",
      "metricUrl": "https://xxx.cloudfront.net/xxxexportxxxreportsxxx.json?xxx2025-11-03T19:38:11.076Z",
      "additionalInfo": {
        "reportUuid": "65838911-e557-4cb5-8362-eaf3fbd09ab0"
      }
    }
  ]
}

The details array returns detailed information about the report.

PropertyDescription
metricTypeType of the report. One of EXPOSURE_SUMMARY or LOCATION_RESULTS.
metricUrlURL of the exported result.
additionalInfoInformation about the report including the reportUuid that uniquely identifies the report.

For detailed information about UnderwriteIQ reports, see UnderwriteIQ User Guide.

🪰

Entitlements

RI-UNDERWRITEIQ

Language
Credentials
URL