GET
/
v1
/
analytics
curl --request GET \
  --url https://api.hyperline.co/v1/analytics \
  --header 'Authorization: Bearer <token>'
{
  "revenue_last_30_days": 123,
  "churn_30_days": 123,
  "churned_revenue_30_days": 123,
  "arr": 123,
  "mrr": 123,
  "pending_arr": 123,
  "active_arr": 123,
  "arr_in_discounts": 123,
  "fixed_arr": 123,
  "active_customers": 123,
  "arpa": 123
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json
revenue_last_30_days
number
required

Revenue of the last 30 days. Expressed in the currency's smallest unit.

churn_30_days
number
required

Churn of the last 30 days. Churn corresponds to the number of customers who churned divided by the number of active customers. A churned customer is one who had a subscription but no longer has an active one.

churned_revenue_30_days
number
required

Revenue corresponding to the churn of the last 30 days. Expressed in the currency's smallest unit.

arr
number
required

Computed live Annual Recurring Revenue. Expressed in the currency's smallest unit.

mrr
number
required

Computed live Monthly Recurring Revenue. Expressed in the currency's smallest unit.

pending_arr
number
required

Computed pending Annual Recurring Revenue. The sum of ARR from all pending subscriptions. Expressed in the currency's smallest unit.

active_arr
number
required

Computed pending Annual Recurring Revenue. The sum of ARR from all active subscriptions. Expressed in the currency's smallest unit.

arr_in_discounts
number
required

Annual Recurring Revenue currently under coupons. Expressed in the currency's smallest unit.

fixed_arr
number
required

Computed live Annual Recurring Revenue without the discounted amount (coupons). Expressed in the currency's smallest unit.

active_customers
number
required

Number of customers with an assigned subscriptions.

arpa
number
required

Average Revenue Per Account (customer).

WebhooksCreate billable event