ReportData
SIP Protocol API Reference v0.7.0
SIP Protocol API Reference / ReportData
Interface: ReportData
Section titled “Interface: ReportData”Defined in: @sip-protocol/types/dist/index.d.ts:2040
Report data structure
Properties
Section titled “Properties”summary
Section titled “summary”summary:
object
Defined in: @sip-protocol/types/dist/index.d.ts:2042
Summary statistics
totalTransactions
Section titled “totalTransactions”totalTransactions:
number
totalInbound
Section titled “totalInbound”totalInbound:
number
totalOutbound
Section titled “totalOutbound”totalOutbound:
number
totalVolume
Section titled “totalVolume”totalVolume:
Record<string,bigint>
uniqueCounterparties
Section titled “uniqueCounterparties”uniqueCounterparties:
number
averageTransactionSize
Section titled “averageTransactionSize”averageTransactionSize:
Record<string,bigint>
dateRange
Section titled “dateRange”dateRange:
object
dateRange.start
Section titled “dateRange.start”start:
number
dateRange.end
Section titled “dateRange.end”end:
number
byType
Section titled “byType”byType:
object
Defined in: @sip-protocol/types/dist/index.d.ts:2055
Transaction breakdown by type
payments
Section titled “payments”payments:
number
swaps:
number
deposits
Section titled “deposits”deposits:
number
withdrawals
Section titled “withdrawals”withdrawals:
number
byChain
Section titled “byChain”byChain:
Record<ChainId,number>
Defined in: @sip-protocol/types/dist/index.d.ts:2062
Transaction breakdown by chain
byPrivacyLevel
Section titled “byPrivacyLevel”byPrivacyLevel:
Record<PrivacyLevel,number>
Defined in: @sip-protocol/types/dist/index.d.ts:2064
Transaction breakdown by privacy level
highValueTransactions
Section titled “highValueTransactions”highValueTransactions:
DisclosedTransaction[]
Defined in: @sip-protocol/types/dist/index.d.ts:2066
High-value transactions
riskSummary?
Section titled “riskSummary?”
optionalriskSummary:object
Defined in: @sip-protocol/types/dist/index.d.ts:2068
Risk summary
lowRisk
Section titled “lowRisk”lowRisk:
number
mediumRisk
Section titled “mediumRisk”mediumRisk:
number
highRisk
Section titled “highRisk”highRisk:
number
flaggedTransactions
Section titled “flaggedTransactions”flaggedTransactions:
number
transactions?
Section titled “transactions?”
optionaltransactions:DisclosedTransaction[]
Defined in: @sip-protocol/types/dist/index.d.ts:2075
Full transaction list (optional)