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

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
invoicing_entity_id
string

Invoicing Entity ID to filter analytics

Example:

"ive_47484fjdhy5"

Response

200 - application/json
​
revenue_last_30_days
number
required

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

Example:

24000

​
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.

Example:

24000

​
arr
number
required

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

Example:

24000

​
mrr
number
required

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

Example:

24000

​
pending_arr
number
required

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

Example:

24000

​
active_arr
number
required

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

Example:

24000

​
arr_in_discounts
number
required

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

Example:

24000

​
fixed_arr
number
required

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

Example:

24000

​
active_customers
number
required

Number of customers with an assigned subscriptions.

​
arpa
number
required

Average Revenue Per Account (customer).