Get statistics for transactions

GET 
/workspaces/:workspaceId/transactions/stats

Get statistics for transactions on a given workspace.

Request

Path Parameters

workspaceId stringrequired

Query Parameters

type string
currencyCode any
timeframe any

Responses

200

Successful response

application/json

Schema

Schema

volumeData objectrequired
inbound numberrequired
outbound numberrequired
unit stringrequired
evolutionInPercentage numberrequired
transactionsData objectrequired
inbound numberrequired
outbound numberrequired
unit stringrequired
evolutionInPercentage numberrequired
volumeEvolutionData object[]required
Array [
day date-timerequired
inbound numberrequired
outbound numberrequired
unit stringrequired
]
transactionsEvolutionData object[]required
Array [
day date-timerequired
inbound numberrequired
outbound numberrequired
unit stringrequired
]
volumeByAssetData object[]required
Array [
asset stringrequired
inbound numberrequired
outbound numberrequired
unit stringrequired
]
transactionsByAssetData object[]required
Array [
asset stringrequired
inbound numberrequired
outbound numberrequired
unit stringrequired
]
volumeByStatusData objectrequired
data objectrequired
blocked numberrequired
pending numberrequired
approved numberrequired
under_investigation numberrequired
failed numberrequired
unit stringrequired
transactionsByStatusData objectrequired
data objectrequired
blocked numberrequired
pending numberrequired
approved numberrequired
under_investigation numberrequired
failed numberrequired
unit stringrequired
volumeRiskData objectrequired
low numberrequired
medium numberrequired
high numberrequired
no_risk numberrequired
unit stringrequired
transactionRiskData objectrequired
low numberrequired
medium numberrequired
high numberrequired
no_risk numberrequired
unit stringrequired

Example (from schema)

{
  "volumeData": {
    "inbound": 0,
    "outbound": 0,
    "unit": "string",
    "evolutionInPercentage": 0
  },
  "transactionsData": {
    "inbound": 0,
    "outbound": 0,
    "unit": "string",
    "evolutionInPercentage": 0
  },
  "volumeEvolutionData": [
    {
      "day": "2024-07-29T15:51:28.071Z",
      "inbound": 0,
      "outbound": 0,
      "unit": "string"
    }
  ],
  "transactionsEvolutionData": [
    {
      "day": "2024-07-29T15:51:28.071Z",
      "inbound": 0,
      "outbound": 0,
      "unit": "string"
    }
  ],
  "volumeByAssetData": [
    {
      "asset": "string",
      "inbound": 0,
      "outbound": 0,
      "unit": "string"
    }
  ],
  "transactionsByAssetData": [
    {
      "asset": "string",
      "inbound": 0,
      "outbound": 0,
      "unit": "string"
    }
  ],
  "volumeByStatusData": {
    "data": {
      "blocked": 0,
      "pending": 0,
      "approved": 0,
      "under_investigation": 0,
      "failed": 0
    },
    "unit": "string"
  },
  "transactionsByStatusData": {
    "data": {
      "blocked": 0,
      "pending": 0,
      "approved": 0,
      "under_investigation": 0,
      "failed": 0
    },
    "unit": "string"
  },
  "volumeRiskData": {
    "low": 0,
    "medium": 0,
    "high": 0,
    "no_risk": 0,
    "unit": "string"
  },
  "transactionRiskData": {
    "low": 0,
    "medium": 0,
    "high": 0,
    "no_risk": 0,
    "unit": "string"
  }
}

default

Error response

application/json

Schema

Schema

message stringrequired
code stringrequired
issues object[]
Array [
message stringrequired
]

Example (from schema)

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Loading...