Navigate...
Get Stats
sdk.distributions.getStats(id)
Get aggregate transaction batch statistics for a distribution. Returns counts of batches by status — use this to build progress bars or determine when a distribution is complete. A distribution is finished when confirmed + failed === total.
Poll getStats() periodically to show a progress bar. The distribution is done when confirmed + failed === total. Check failed > 0 to detect partial failures.
API key required to run methods
API Key *
Base URL
id
string
required
Distribution ID
Distribution ID
Returns
DistributionStats
Batch status counts
total
number
Total number of transaction batches
pending
number
Batches not yet submitted to the blockchain
submitted
number
Batches submitted, awaiting on-chain confirmation
confirmed
number
Successfully confirmed batches
failed
number
Failed batches
cancelled
number
Cancelled batches
Errors
Invalid distribution id
The request is not authorized
You do not have permission to access this resource
Distribution not found
See Also
get()
Get the overall distribution status and details
getTransactions()
Inspect individual batches — get txHash for block explorer verification
Generated Code