GenerateReportParams
SIP Protocol API Reference v0.7.0
SIP Protocol API Reference / GenerateReportParams
Interface: GenerateReportParams
Section titled “Interface: GenerateReportParams”Defined in: @sip-protocol/types/dist/index.d.ts:2139
Parameters for generating a report
Properties
Section titled “Properties”type:
ReportType
Defined in: @sip-protocol/types/dist/index.d.ts:2141
Report type
title:
string
Defined in: @sip-protocol/types/dist/index.d.ts:2143
Report title
description?
Section titled “description?”
optionaldescription:string
Defined in: @sip-protocol/types/dist/index.d.ts:2145
Description
format
Section titled “format”format:
ReportFormat
Defined in: @sip-protocol/types/dist/index.d.ts:2147
Format
startDate
Section titled “startDate”startDate:
number
Defined in: @sip-protocol/types/dist/index.d.ts:2149
Start date
endDate
Section titled “endDate”endDate:
number
Defined in: @sip-protocol/types/dist/index.d.ts:2151
End date
chains?
Section titled “chains?”
optionalchains:ChainId[]
Defined in: @sip-protocol/types/dist/index.d.ts:2153
Chains to include
tokens?
Section titled “tokens?”
optionaltokens:string[]
Defined in: @sip-protocol/types/dist/index.d.ts:2155
Tokens to include
includeInbound?
Section titled “includeInbound?”
optionalincludeInbound:boolean
Defined in: @sip-protocol/types/dist/index.d.ts:2157
Include inbound
includeOutbound?
Section titled “includeOutbound?”
optionalincludeOutbound:boolean
Defined in: @sip-protocol/types/dist/index.d.ts:2159
Include outbound
includeTransactions?
Section titled “includeTransactions?”
optionalincludeTransactions:boolean
Defined in: @sip-protocol/types/dist/index.d.ts:2161
Include full transaction list