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

# Analytics Tools

> Dashboard metrics, message delivery stats, campaign comparisons, and data exports with the Zeplo MCP Server.

# Analytics Tools

Tools for pulling analytics and reporting data from your Zeplo workspace.

## analytics\_dashboard

Get key dashboard metrics: messages, campaigns, contacts, and conversations.

**Parameters:**

| Parameter | Type | Required | Default | Description |
| - | - | - | - | - |
| `channelId` | string | No | — | Filter by channel |
| `days` | number | No | 30 | Lookback period in days |

**Response:**

```json theme={null}
{
  "period": "30 days",
  "contacts": {
    "total": 12450,
    "new": 320
  },
  "campaigns": {
    "active": 3,
    "new": 8
  },
  "conversations": {
    "open": 24
  },
  "channels": {
    "active": 5
  }
}
```

***

## analytics\_messages

Get daily message delivery statistics.

**Parameters:**

| Parameter | Type | Required | Default | Description |
| - | - | - | - | - |
| `channelId` | string | No | — | Filter by channel |
| `days` | number | No | 30 | Lookback period |

**Response:**

```json theme={null}
{
  "period": "30 days",
  "dailyStats": [
    {
      "date": "2026-05-08",
      "direction": "outbound",
      "status": "delivered",
      "count": 450
    },
    {
      "date": "2026-05-08",
      "direction": "inbound",
      "status": "delivered",
      "count": 120
    }
  ]
}
```

***

## analytics\_campaigns

Compare performance metrics across recent campaigns.

**Parameters:**

| Parameter | Type | Required | Default | Description |
| - | - | - | - | - |
| `channelId` | string | No | — | Filter by channel |
| `limit` | number | No | 10 | Number of recent campaigns to compare |

**Response:**

```json theme={null}
{
  "campaigns": [
    {
      "id": "camp_abc123",
      "name": "Flash Sale May",
      "status": "completed",
      "type": "marketing",
      "recipientCount": 5000,
      "sentCount": 4950,
      "deliveredCount": 4800,
      "readCount": 3200,
      "failedCount": 150,
      "deliveryRate": "96.0%",
      "readRate": "64.0%"
    }
  ]
}
```

***

## analytics\_export

Export aggregated analytics data as structured JSON.

**Parameters:**

| Parameter | Type | Required | Description |
| - | - | - | - |
| `type` | enum | Yes | Data type: `contacts`, `campaigns`, or `messages` |
| `channelId` | string | No | Filter by channel |
| `startDate` | string | No | Start date (ISO format) |
| `endDate` | string | No | End date (ISO format) |

**Example:**

```json theme={null}
{
  "type": "contacts",
  "startDate": "2026-04-01",
  "endDate": "2026-05-01"
}
```

> [!NOTE]
>
> Exports are capped at 1,000 records for contacts and messages, and 500 for campaigns. Use date ranges to narrow results.


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