API documentation
Integrations
Analytics
Billable events
Companies
Coupons > Promotion codes
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoices > Transactions
Invoicing entities
Organisations
Payments
Price configurations
Products
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTTransition subscription to next phase
Third-party apps
Wallets
Analytics
Get analytics
Retrieve your pre-computed account’s analytics (ARR, revenues, churn, etc).
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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Invoicing Entity ID to filter analytics
Example:
"ive_47484fjdhy5"
Response
200 - application/json
The response is of type object
.
Was this page helpful?
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
}
Assistant
Responses are generated using AI and may contain mistakes.