Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api.docs.onlydrams.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

This endpoint requires authentication. The authenticated user must be the community owner or an admin.

​
Path Parameters

​
community_id
string
required
The unique identifier of the community

​
Query Parameters

​
period
string
default:"last_6_months"
The time period for revenue calculations. Valid values:
  • all_time - All historical data
  • last_year - Last 12 months
  • last_6_months - Last 6 months (default)
  • last_month - Last 30 days

​
Response

​
period
string
The selected time period key (e.g., “last_6_months”)
​
period_label
string
Human-readable label for the time period (e.g., “Last 6 Months”)
​
total_revenue
object
Total revenue from all completed transactions (payments, upgrades, renewals)
​
total_recurring
object
Revenue from renewal transactions only
​
active_members
object
Current active membership count
​
churn_rate
object
Member churn rate for the selected period
​
tier_performance
array
Performance metrics for each membership tier
{
  "period": "last_6_months",
  "period_label": "Last 6 Months",
  "total_revenue": {
    "cents": 1245000,
    "formatted": "$12,450.00"
  },
  "total_recurring": {
    "cents": 820000,
    "formatted": "$8,200.00"
  },
  "active_members": {
    "count": 1234,
    "formatted": "1,234"
  },
  "churn_rate": {
    "rate": 5.2,
    "formatted": "5.2%"
  },
  "tier_performance": [
    {
      "id": "t1b2c3d4-5678-90ab-cdef-123456789abc",
      "name": "Basic",
      "members": {
        "count": 850,
        "formatted": "850"
      },
      "revenue": {
        "cents": 425000,
        "formatted": "$4,250.00"
      }
    },
    {
      "id": "t2b2c3d4-5678-90ab-cdef-123456789abc",
      "name": "Premium",
      "members": {
        "count": 320,
        "formatted": "320"
      },
      "revenue": {
        "cents": 640000,
        "formatted": "$6,400.00"
      }
    },
    {
      "id": "t3b2c3d4-5678-90ab-cdef-123456789abc",
      "name": "VIP",
      "members": {
        "count": 64,
        "formatted": "64"
      },
      "revenue": {
        "cents": 180000,
        "formatted": "$1,800.00"
      }
    }
  ]
}