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

# Superwall Metrics

> Live Superwall statistics, KPI charts, transactions, and campaigns using the saved organization API key

```
GET  /v1/connect/superwall/metrics/overview
GET  /v1/connect/superwall/metrics/dashboard
POST /v1/connect/superwall/metrics/charts/data
GET  /v1/connect/superwall/metrics/transactions
GET  /v1/connect/superwall/campaigns
```

These endpoints proxy the [Superwall API](https://api.superwall.com). Connect Superwall first ([Credentials](/docs/superwall)), then call them with your Appeeky API key.

<Note>
  Omit `application_id` to use the first application in the connected organization. For co-founder and product dashboards, attach the matching Superwall application on the app so metrics stay scoped to that product.
</Note>

## Overview

```
GET /v1/connect/superwall/metrics/overview
```

Snapshot KPIs for one Superwall application: proceeds, MRR, users, conversion, and related statistics.

### Query parameters

| Name             | Type   | Default          | Description                                                              |
| ---------------- | ------ | ---------------- | ------------------------------------------------------------------------ |
| `application_id` | string | first listed app | Superwall application id                                                 |
| `environment`    | string | `PRODUCTION`     | `PRODUCTION` or `SANDBOX`                                                |
| `date_preset`    | string | `last_30_days`   | Superwall date preset (`last_7_days`, `last_30_days`, `last_90_days`, …) |

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl "https://api.appeeky.com/v1/connect/superwall/metrics/overview?date_preset=last_30_days" \
  -H "X-API-Key: YOUR_API_KEY"
```

## Dashboard

```
GET /v1/connect/superwall/metrics/dashboard
```

Bundled payload: statistics, KPI charts (`netProceeds`, `mrr`, `newUsers`, `transactionCompletes`, `trialStarts`), and recent transactions. Same query parameters as overview.

## Chart data

```
POST /v1/connect/superwall/metrics/charts/data
```

Time-series for one Superwall y-axis metric.

### Body

| Name            | Type   | Required | Description                                                                                                                                     |
| --------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `yAxis`         | string | yes      | Metric key, e.g. `netProceeds`, `mrr`, `newUsers`, `transactionCompletes`, `trialStarts`, `paywallConvRate`                                     |
| `applicationId` | string | no       | Superwall application id                                                                                                                        |
| `xAxis`         | string | no       | `purchaseDate`, `installDate`, or `mrrDate`. Defaults from `yAxis` (`mrr`/`arr` → `mrrDate`, user metrics → `installDate`, else `purchaseDate`) |
| `datePreset`    | string | no       | Superwall date preset (`last_30_days` default)                                                                                                  |
| `dateInterval`  | string | no       | `hour`, `day`, `week`, or `month` (`day` default)                                                                                               |

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X POST "https://api.appeeky.com/v1/connect/superwall/metrics/charts/data" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"yAxis":"netProceeds","datePreset":"last_30_days","dateInterval":"day"}'
```

## Transactions

```
GET /v1/connect/superwall/metrics/transactions
```

Recent purchases, renewals, and trials.

| Name             | Type   | Description                          |
| ---------------- | ------ | ------------------------------------ |
| `application_id` | string | Superwall application id             |
| `environment`    | string | `PRODUCTION` or `SANDBOX`            |
| `date_preset`    | string | Superwall date preset                |
| `event_type`     | string | Optional Superwall event type filter |

## Campaigns

```
GET /v1/connect/superwall/campaigns
```

Campaigns and placements for an application. Optional `application_id` query parameter.

## Errors

| Status          | Code               | Meaning                               |
| --------------- | ------------------ | ------------------------------------- |
| 401             | `AUTH_REQUIRED`    | Missing Appeeky session or API key    |
| 404             | `NOT_CONNECTED`    | Save Superwall credentials first      |
| 400 / 401 / 403 | Superwall upstream | Invalid or insufficient Superwall key |
| 502             | Superwall upstream | Superwall API error                   |

## MCP equivalents

| REST                        | MCP               |
| --------------------------- | ----------------- |
| `GET /metrics/overview`     | `sw_overview`     |
| `GET /metrics/dashboard`    | `sw_dashboard`    |
| `POST /metrics/charts/data` | `sw_chart`        |
| `GET /metrics/transactions` | `sw_transactions` |
| `GET /campaigns`            | `sw_campaigns`    |
| `GET /apps`                 | `sw_apps`         |

See [Superwall](/docs/superwall) for connect flow and [MCP Server](/docs/mcp#sw_apps) for tool parameters.