Skip to main content
GET
/
analytics
/
subscriptions
/
optimized
Get optimized subscription analytics dashboard
curl --request GET \
  --url https://api.sprucecollective.co.uk/analytics/subscriptions/optimized \
  --header 'Authorization: <api-key>'
{
  "churn_analysis": {},
  "credit_analytics": {},
  "generated_at": "<string>",
  "period": "<string>",
  "subscription_metrics": {
    "active_subscribers_by_tier": {},
    "churn_rate": 123,
    "credit_usage_distribution": {},
    "credit_utilization_rate": 123,
    "expired_vs_used_ratio": {
      "expired_credits": 123,
      "ratio": 123,
      "used_credits": 123
    },
    "mrr": 123,
    "revenue_by_tier": {},
    "total_active_subscriptions": 123,
    "total_cancelled_subscriptions": 123,
    "user_engagement_correlation": {
      "engagement_correlation": 123,
      "high_engagement_users": 123,
      "low_engagement_users": 123
    }
  }
}

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and JWT token.

Query Parameters

days
integer

Number of days to analyze (default: 30)

start
string

Start date (YYYY-MM-DD)

end
string

End date (YYYY-MM-DD)

site_id
string

Site ID for multi-tenant filtering

Response

200 - application/json

OK

churn_analysis
object
credit_analytics
object
generated_at
string
period
string
subscription_metrics
object