DashboardMetricsResponse

successbooleanrequired

data object

Upstream operational totals for today and the last seven days, computed by the server in the reporting time zone (timeZone). Amounts are in minor units. These projections do not establish a completed-sale cohort.

merchantCountinteger<int64>required

Possible values: >= 0

transactionCountTodayinteger<int64>required

Upstream operational transaction count, including refunds; not completed-sale count.

Possible values: >= 0

settlementPendinginteger<int64>nullablerequired

Null when today's window holds several currencies; use currencyTotals[].settlementPending.

Possible values: >= 0

totalVolumeTodayinteger<int64>nullablerequired

Upstream operational transaction volume in currency minor units, including refunds; not completed-sale gross. Null for mixed currencies; use currencyTotals.

currencyTotals object[]

Today's totals per currency, in each currency's minor units.

Array [

currencystringrequired

ISO 4217 currency code.

totalAmountinteger<int64>required

Upstream operational transaction volume in currency minor units, including refunds; not completed-sale gross.

totalSalesinteger<int64>required

totalRefundsinteger<int64>required

netAmountinteger<int64>required

Refund-adjusted net of upstream operational gross minus refunds, in currency minor units; not settlement proceeds.

transactionCountinteger<int64>required

Upstream operational transaction count, including refunds; not completed-sale count.

Possible values: >= 0

settlementPendinginteger<int64>required

Possible values: >= 0

]

currencystringnullable

The single ISO 4217 currency of today's totals, or null when several currencies are in play.

recentTransactions object[]required

Array [

idstringrequired

merchantIdstringrequired

amountinteger<int64>required

Amount in minor units of currency.

currencystringnullable

ISO 4217 currency code of the transaction.

statusstringrequired

createdAtstringrequired

]

timeZonestringrequired

IANA time zone of salesTrend dates and hourlyVolume hours.

salesTrend object[]required

Seven calendar days, oldest first; the last entry is today.

Array [

datestring<date>required

transactionCountinteger<int64>required

Upstream operational transaction count for this reporting day, including refunds; not completed-sale count.

Possible values: >= 0

salesByCurrency object[]required

Approved sales on this day per currency in minor units, sorted by currency code; refunds are not included. Empty when the day had no sales. Amounts of different currencies are never summed.

Array [

currencystringrequired

ISO 4217 currency code.

salesAmountinteger<int64>required

Approved sales in this currency in that currency's minor units; refunds are not included.

]

hourlyVolume object[]required

Twenty-four entries, one per hour (0-23) of today.

Array [

hourintegerrequired

Possible values: >= 0 and <= 23

transactionCountinteger<int64>required

Upstream operational transaction count for this reporting hour, including refunds; not completed-sale count.

Possible values: >= 0

]

errorstring

Machine-readable error code.

messagestring

Human-readable response message.

DashboardMetricsResponse
{
  "success": true,
  "data": {
    "merchantCount": 0,
    "transactionCountToday": 0,
    "settlementPending": 0,
    "totalVolumeToday": 0,
    "currencyTotals": [
      {
        "currency": "string",
        "totalAmount": 0,
        "totalSales": 0,
        "totalRefunds": 0,
        "netAmount": 0,
        "transactionCount": 0,
        "settlementPending": 0
      }
    ],
    "currency": "string",
    "recentTransactions": [
      {
        "id": "string",
        "merchantId": "string",
        "amount": 0,
        "currency": "string",
        "status": "string",
        "createdAt": "string"
      }
    ],
    "timeZone": "string",
    "salesTrend": [
      {
        "date": "2024-07-29",
        "transactionCount": 0,
        "salesByCurrency": [
          {
            "currency": "string",
            "salesAmount": 0
          }
        ]
      }
    ],
    "hourlyVolume": [
      {
        "hour": 0,
        "transactionCount": 0
      }
    ]
  },
  "error": "string",
  "message": "string"
}