> ## Documentation Index
> Fetch the complete documentation index at: https://run-deliverys.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Insights

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

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`.

```bash cURL theme={null}
curl "$RUN_BASE_URL/business/ava/insights?start=2026-10-01&end=2026-10-25" \
  -H "Authorization: Bearer $RUN_API_KEY"
```

```javascript Node.js theme={null}
const res = await fetch(
  `${process.env.RUN_BASE_URL}/business/ava/insights?start=2026-10-01&end=2026-10-25`,
  { headers: { Authorization: `Bearer ${process.env.RUN_API_KEY}` } },
);
const insights = await res.json();
```

```python Python theme={null}
import os
import requests

res = requests.get(
    f"{os.environ['RUN_BASE_URL']}/business/ava/insights",
    params={"start": "2026-10-01", "end": "2026-10-25"},
    headers={"Authorization": f"Bearer {os.environ['RUN_API_KEY']}"},
)
insights = res.json()
```

```php PHP theme={null}
<?php
$ch = curl_init(getenv('RUN_BASE_URL') . '/business/ava/insights?start=2026-10-01&end=2026-10-25');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('RUN_API_KEY')],
]);
$insights = json_decode(curl_exec($ch), true);
curl_close($ch);
```

```go Go theme={null}
package main

import (
  "net/http"
  "os"
)

func main() {
  req, _ := http.NewRequest("GET", os.Getenv("RUN_BASE_URL")+"/business/ava/insights?start=2026-10-01&end=2026-10-25", nil)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("RUN_API_KEY"))
  http.DefaultClient.Do(req)
}
```

```json 200 theme={null}
{
  "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
    }
  ]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.