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

# Bot Dashboard Stats — POST /api/v1/bot-dashboard-stats

> Fetch aggregated performance statistics for your Botsify bot over a custom date range, including message counts, unique users, and engagement metrics.

Use this endpoint to retrieve aggregated performance statistics for your Botsify bot over a specific date range. The response includes key metrics such as total messages sent and received, unique users engaged, and other engagement indicators that mirror what you see on your bot dashboard. You must provide your bot API key along with the start and end dates for the reporting period.

## Request

**apikey** `string` *required*

Your bot's API key. You may alternatively supply this value in the `X-Api-Key` request header instead of the body.

**date\_from** `string` *required*

The start date of the reporting period in `YYYY-MM-DD` format (e.g., `2024-01-01`).

**date\_to** `string` *required*

The end date of the reporting period in `YYYY-MM-DD` format (e.g., `2024-01-31`). Must be greater than or equal to `date_from`.

## Example Request

```bash theme={null}
curl --request POST \
  --url https://app.botsify.com/api/v1/bot-dashboard-stats \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: YOUR_BOT_API_KEY' \
  --data '{
    "apikey": "BOT_KEY",
    "date_from": "2024-01-01",
    "date_to": "2024-01-31"
  }'
```

## Response

A successful request returns a JSON object containing aggregated statistics for the specified date range. Metrics include total messages exchanged, the number of unique active users, new subscriber counts, and any other engagement figures tracked on your bot dashboard.

```json theme={null}
{
  "date_from": "2024-01-01",
  "date_to": "2024-01-31",
  "stats": {
    "total_messages": 4820,
    "messages_sent": 2710,
    "messages_received": 2110,
    "unique_users": 390,
    "new_subscribers": 75
  }
}
```


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