Insights

Read address-check totals and the daily series for your business.

GET /business/ava/insights

cURL

curl "$RUN_BASE_URL/business/ava/insights?start=2026-10-01&end=2026-10-25" \
  -H "Authorization: Bearer $RUN_API_KEY"

200

{
  "calls": 12,
  "confirmed": 7,
  "confirmed_rate": 58.3,
  "spend_ngn": 14000,
  "balance_ngn": 50000,
  "reserved_balance_ngn": 2000,
  "available_ngn": 48000,
  "currency": "NGN",
  "series": [
    {
      "date": "2026-10-25",
      "calls": 4,
      "confirmed": 2,
      "not_confirmed": 1,
      "unreachable": 0
    }
  ]
}

Read how many address checks your business has run, how many were confirmed, what you have spent, and your wallet. The daily series covers the dates you pass.

Requires scope: ava:read

The totals are all-time. The series is grouped by the day the check was created, in Africa/Lagos. When you pass start and end, the series includes only checks created in that range. The totals stay all-time.

Headers

Authorization · string · required

Bearer API key (Bearer <api_key>).

Query parameters

start · string

First day of the series, as YYYY-MM-DD. Pass this together with end.

end · string

Last day of the series, as YYYY-MM-DD. Pass this together with start.

Response

calls · number

All-time number of address checks.

confirmed · number

All-time number of checks whose status is confirmed.

confirmed_rate · number

Confirmed checks as a percentage of calls, to one decimal place. 0 when calls is 0.

spend_ngn · number

All-time naira charged for address checks.

balance_ngn · number

Current Business wallet balance, in naira.

reserved_balance_ngn · number

Naira currently held, including address-check holds.

available_ngn · number

balance_ngn minus reserved_balance_ngn.

currency · string

Always NGN.

series · object[]

One object per day that has at least one check in the range.

series.date · string

The day, as YYYY-MM-DD, in Africa/Lagos.

series.calls · number

Checks created that day.

series.confirmed · number

Those checks whose status is confirmed.

series.not_confirmed · number

Those checks whose status is not_confirmed.

series.unreachable · number

Those checks whose status is unreachable.

cURL

curl "$RUN_BASE_URL/business/ava/insights?start=2026-10-01&end=2026-10-25" \
  -H "Authorization: Bearer $RUN_API_KEY"

200

{
  "calls": 12,
  "confirmed": 7,
  "confirmed_rate": 58.3,
  "spend_ngn": 14000,
  "balance_ngn": 50000,
  "reserved_balance_ngn": 2000,
  "available_ngn": 48000,
  "currency": "NGN",
  "series": [
    {
      "date": "2026-10-25",
      "calls": 4,
      "confirmed": 2,
      "not_confirmed": 1,
      "unreachable": 0
    }
  ]
}