Skip to main content
GET /v1/revenuecat/overview
Returns a snapshot of your app’s key subscription metrics from RevenueCat, including MRR, revenue (last 28 days), active subscriptions, active trials, new customers, and active users. This is the fastest way to get a high-level view of your subscription business.
This endpoint proxies to the RevenueCat Charts & Metrics API. You need a RevenueCat secret API key (sk_xxx) to use it. Charts require the Pro plan (free up to $2,500 MTR).

​
Headers

NameTypeRequiredDescription
X-RC-KeystringYesYour RevenueCat secret API key (starts with sk_)
X-RC-ProjectstringNoRevenueCat project ID (e.g. proj28fad9ba). Auto-detected if you have one project.

​
Query Parameters

NameTypeDefaultDescription
currencystringUSDISO 4217 currency code (e.g. USD, EUR, GBP)

​
Code Examples

curl -X GET "https://api.appeeky.com/v1/revenuecat/overview" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-RC-Key: sk_YOUR_REVENUECAT_SECRET_KEY"

​
Response

{
  "data": {
    "metrics": [
      {
        "id": "active_trials",
        "name": "Active Trials",
        "description": "In total",
        "unit": "#",
        "period": "P0D",
        "value": 0,
        "last_updated_at": null,
        "last_updated_at_iso8601": null
      },
      {
        "id": "active_subscriptions",
        "name": "Active Subscriptions",
        "description": "In total",
        "unit": "#",
        "period": "P0D",
        "value": 1,
        "last_updated_at": null,
        "last_updated_at_iso8601": null
      },
      {
        "id": "mrr",
        "name": "MRR",
        "description": "Monthly Recurring Revenue",
        "unit": "$",
        "period": "P28D",
        "value": 11,
        "last_updated_at": null,
        "last_updated_at_iso8601": null
      },
      {
        "id": "revenue",
        "name": "Revenue",
        "description": "Last 28 days",
        "unit": "$",
        "period": "P28D",
        "value": 11,
        "last_updated_at": null,
        "last_updated_at_iso8601": null
      },
      {
        "id": "new_customers",
        "name": "New Customers",
        "description": "Last 28 days",
        "unit": "#",
        "period": "P28D",
        "value": 67,
        "last_updated_at": null,
        "last_updated_at_iso8601": null
      },
      {
        "id": "active_users",
        "name": "Active Users",
        "description": "Last 28 days",
        "unit": "#",
        "period": "P28D",
        "value": 67,
        "last_updated_at": null,
        "last_updated_at_iso8601": null
      }
    ]
  }
}
The response includes metrics for multiple currencies (e.g. mrr_eur, revenue_gbp). Only the primary currency metrics are shown above — the full response includes all currency variants.

​
Metric Object

FieldTypeDescription
idstringMetric identifier (e.g. mrr, active_subscriptions)
namestringHuman-readable name
descriptionstringShort description of the metric
unitstring$ for currency, # for count
periodstringISO 8601 duration — P0D = current snapshot, P28D = last 28 days
valuenumberMetric value
last_updated_atnumber | nullUnix timestamp of last update
last_updated_at_iso8601string | nullISO 8601 timestamp of last update

​
Key Metrics

Metric IDDescription
active_trialsCurrently active free trials
active_subscriptionsCurrently active paid subscriptions
mrrMonthly Recurring Revenue (USD)
revenueTotal revenue in last 28 days (USD)
new_customersNew customers in last 28 days
active_usersActive users in last 28 days

​
X-RC-Project Header

If your RevenueCat account has one project, the project is auto-detected from your API key — no X-RC-Project header needed. If you have multiple projects, omitting the header returns an error listing your available projects: 
{
  "error": {
    "code": "MULTIPLE_PROJECTS",
    "message": "Multiple projects found: My App (projABC123), Other App (projDEF456). Please specify X-RC-Project header."
  }
}

​
Errors

StatusCodeWhen
400MISSING_RC_KEYX-RC-Key header not provided
400MULTIPLE_PROJECTSMultiple projects found, X-RC-Project not specified
401UNAUTHORIZEDInvalid RevenueCat API key
404NO_PROJECTSNo projects found for this API key