Reporting API

See the Reporting topic for information about the contents of each report.

Fetch report status

GET /report/{reportLocator}/status

ReportStatusResponse

{
  // Required
  "createdTimestamp" : integer
  "locator" : string
  "status" : string started | complete | failed
  "updatedTimestamp" : integer

  // Optional
  "error" : string
  "resultUrl" : string
}

Note

If no records are found for a report then the resultUrl field on ReportStatusResponse will be null even after the status is complete.

PolicyReportRequest

{
  // Optional
  "exposureFields" : [string]
  "perilFields" : [string]
  "policyFields" : [string]
  "productNames" : [string]
  "reportEndTimestamp" : integer
  "reportStartTimestamp" : integer
  "reportTimestamp" : integer
}

Note: If “productNames” is empty, then the corresponding report will also be empty.

Run the On-Risk report

POST /report/onRisk

Note: The optional “reportTimestamp” is required for the On Risk report.

Run the All Policies report

POST /report/allPolicies

Note: The optional “reportStartTimestamp” and “reportEndTimestamp” are required for the All Policies report.

Run the Financial Transactions report

POST /report/financialTransaction

Run the Paid Financial Transactions report

POST /report/paidFinancialTransaction

FinancialTransactionReportRequest

{
  // Required
  "endTimestamp" : integer
  "startTimestamp" : integer
}

Run the Unearned Premium Accounts Receivable report

POST /report/unearnedPremium/accountsReceivable

UnearnedPremiumReportRequest

{
  // Required
  "reportTimestamp" : integer
}

Run the Payable Commissions report

POST /report/payableCommissions

PayableCommissionsReportRequest

{
  // Required
  "endTimestamp" : integer
  "startTimestamp" : integer
}

Run the Reserves report

POST /report/claim/reserves

ReservesReportRequest

{
  // Required
  "reportTimestamp" : integer
}

Run the Claims report

POST /report/claim

ClaimsReportRequest

{
  // Required
  "reportTimestamp" : integer
}

Run the Claims Payables report

POST /report/claim/payables

ClaimsPayablesReportRequest

{
  // Required
  "endTimestamp" : integer
  "startTimestamp" : integer
}

RunReportResponse

{
  // Required
  "locator" : string
}