Reference
Data Definitions
Field-by-field definitions for filters, chart metrics, table columns, and method values.
This page defines the data fields used across the dashboard so you can interpret results correctly and configure comparisons with confidence.
Use the field key when you need exact naming, and use the plain-language description when deciding what to change in the UI.
Filter field definitions
| Field key | Type | What it controls | Accepted values / notes |
|---|---|---|---|
countryFrom | string[] | Sender country selection. | ISO country codes (for example GB, US). |
countryTo | string[] | Receiver country selection. | ISO country codes. |
provider | string[] | Providers included in comparison. | Provider names shown in filter options. |
depositMethod | string[] | How sender funds transfer. | Method slugs (for example bankTransfer, card). |
receivingMethod | string[] | How receiver gets funds. | Method slugs (for example bankTransfer, cash, mobileWallet). |
amountPreset | number[] | Transfer amount(s) used in calculations. | Numeric amounts, constrained by corridor/date/tier. |
dateFrom | string | Start date for historical window. | YYYY-MM-DD. |
dateTo | string | End date for historical window. | YYYY-MM-DD. |
dateRangePreset | string | Quick date selection preset. | last_7d, last_30d, last_90d, this_week, this_month, custom. |
currencyMode | string | Display mode for currency-sensitive values. | usd or local (profile default may use auto behavior). |
Chart configuration fields
| Field key | Type | Meaning | Accepted values |
|---|---|---|---|
xAxis | string | Dimension used on horizontal axis. | time, provider, corridor, countryFrom, countryTo, depositMethod, receivingMethod, amount (tier-dependent). |
yAxes | string[] | Metrics plotted on vertical axis. | Up to 2 selected metrics. |
timeAggregation | string | Time bucket when xAxis = time. | day, week, month, year (tier-dependent). |
yAggregation | string | Summary function for Y metrics. | avg, sum, count, min, max (tier-dependent). |
mode | string[] | Breakdown behavior for time charts. | avg, perProvider, perCorridor, perDepositMethod, perReceivingMethod, perAmount (tier-dependent). |
Chart metric definitions (yAxes)
| Metric key | Meaning | Unit / format notes |
|---|---|---|
fee | Transfer fee metric. | Uses USD values in USD mode, local-currency values in Local mode. |
markup | Difference from mid-market rate. | Percentage (%). |
mid_market_rate | Mid-market FX reference rate. | Numeric exchange rate. |
total_transfer_cost | Combined transfer cost metric. | Uses USD or Local variant based on currency mode. |
total_transfer_cost_percent | Transfer cost as percent metric. | Percentage (%), USD/local variant based on currency mode. |
receiveAmountUSD | Receiver amount in USD. | Numeric amount in USD. |
sendAmountUSD | Sender amount in USD. | Numeric amount in USD. |
receiveAmount | Receiver amount in local corridor currency. | Numeric local-currency amount. |
sendAmount | Sender amount in local source currency. | Numeric local-currency amount. |
fxRate | Applied foreign exchange rate. | Numeric exchange rate. |
count | Count of grouped rows in chart aggregation. | Integer count. |
Table column definitions
| Column key | UI label | Meaning | Format notes |
|---|---|---|---|
createdAt | Time | Timestamp for row data point. | Displayed in UI-friendly date/time format. |
corridor | Corridor | Send/receive country pair with currencies. | Example: US (USD) → GB (GBP). |
provider | Provider | Provider name for the row. | Text value. |
depositMethod | Deposit | Sender funding method. | Human-readable label from method slug. |
receivingMethod | Payout | Receiver payout method. | Human-readable label from method slug. |
sendUSD | Send (USD) | Sender amount in USD. | Currency formatted. |
send | Send (Local) | Sender amount in source currency. | Currency + source currency code. |
markup | Markup | Difference vs mid-market rate. | Percentage string. |
midMarketRate | MMR | Mid-market FX rate for row context. | Numeric rate string. |
fxRate | FX Rate | Applied FX rate for transfer method. | Numeric rate string. |
feeUSD | Fee (USD) | Fee value in USD. | Currency formatted. |
fee | Fee (Local) | Fee value in local/source currency. | Value + currency code. |
receiveUSD | Receive (USD) | Receiver amount in USD. | Currency formatted. |
receive | Receive (Local) | Receiver amount in destination currency. | Value + destination currency code. |
totalTransferCostUSD | Total Transfer Cost (USD) | Total transfer cost in USD. | Currency formatted. |
totalTransferCost | Total Transfer Cost (Local) | Total transfer cost in local currency. | Value + currency code. |
totalTransferCostPercentUSD | Total Transfer Cost % (USD) | Cost percent metric in USD context. | Percentage string. |
totalTransferCostPercent | Total Transfer Cost % (Local) | Cost percent metric in local context. | Percentage string. |
Method value definitions
Deposit method slugs
| Slug | Label shown in UI |
|---|---|
bankTransfer | Bank Transfer |
card | Card |
debitCard | Debit Card |
creditCard | Credit Card |
cash | Cash |
bank_card | Bank Card |
bank_account | Bank Account |
ach | ACH |
sepa | SEPA |
sofort | Sofort |
pix | PIX |
upi | UPI |
Payout method slugs
| Slug | Label shown in UI |
|---|---|
bankTransfer | Bank Transfer |
cash | Cash |
mobileWallet | Mobile Wallet |
card | Card |
homeDelivery | Home Delivery |
pickup | Pickup |
Interpretation notes
- Apply gate: filter changes do not update data until you click Apply (or apply a preset).
- Tier constraints: available fields/options can differ by plan tier.
- Currency mode switching: USD/Local mode swaps some chart and table values.
- Estimated totals: a
+next to total means the count is still estimated. - Credits: Apply, preset apply, CSV export, and each AI request may consume credits; chart/table view changes do not.
- Account-specific exclusions: some providers can be hidden by account configuration.
