API reference
Statistics
How your live customers use Monotree, from numbers collected every night: one customer, all of them together, and what the numbers mean.
Base URL https://partners.monotree.com/api/v1
· every call needs a token
Endpoints
get/customers/{customer}/statistics
Get a customer's statistics
get
/customers/{customer}/insights
Get a customer's insights
get
/statistics
Get the statistics of all customers
get
/summary
Get the headline numbers
Get a customer's statistics
/customers/{customer}/statistics
customers:read How one customer uses Monotree over a period, from the numbers Monotree counts once a night. totals are the latest day in the range, period and daily cover the range. A customer with no numbers in the range (not live yet, or live since today) answers zeros, an empty daily and updated_at: null. See Statistics and adoption.
Parameters
customer
required
string · path
cus_…), or external_ref: followed by your own reference, such as external_ref:org_48213.
range
string · query
one of 7d, 30d, 90d · default 30d
Response · 200 The customer's numbers.
range
string
one of 7d, 30d, 90d
updated_at
string, nullable
null when there are none.
totals
object
0 when there are no numbers.
users
integer
invited
integer
active_users_7d
integer
activation_rate
integer
users as a percent of invited, rounded. 0 when nobody is invited.
weekly_active_rate
integer
active_users_7d as a percent of users, rounded. 0 when there are no users.
devices
object
ios
integer
android
integer
push_enabled_rate
integer
0 when there are no phones.
period
object
posts
integer
comments
integer
reactions
integer
messages
integer
user_growth
number, nullable
users since the day before the range began, with one decimal. null when there were no users or no numbers then.
languages
object
{}) when there are no numbers.
daily
array of objects
object
string
customer
string
Errors
invalid_token: the token is missing, revoked or expired.
insufficient_ability: the token lacks the ability this call needs.
not_found: no such customer.
validation_error: range is not 7d, 30d or 90d.
rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl https://partners.monotree.com/api/v1/customers/cus_01jcz8w3k1x9q2v7s4e6m0b5n8/statistics \
-H "Authorization: Bearer $MONOTREE_TOKEN"$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://partners.monotree.com/api/v1/customers/cus_01jcz8w3k1x9q2v7s4e6m0b5n8/statistics', [
'headers' => [
'Authorization' => 'Bearer '.getenv('MONOTREE_TOKEN'),
],
]);
$data = json_decode($response->getBody(), true);const response = await fetch('https://partners.monotree.com/api/v1/customers/cus_01jcz8w3k1x9q2v7s4e6m0b5n8/statistics', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.MONOTREE_TOKEN}`,
},
});
const data = await response.json();import os
import requests
response = requests.get(
"https://partners.monotree.com/api/v1/customers/cus_01jcz8w3k1x9q2v7s4e6m0b5n8/statistics",
headers={
"Authorization": f"Bearer {os.environ['MONOTREE_TOKEN']}",
},
)
data = response.json(){
"object": "statistics",
"customer": "cus_01jcz8w3k1x9q2v7s4e6m0b5n8",
"range": "7d",
"updated_at": "2026-11-14",
"totals": {
"users": 8,
"invited": 9,
"active_users_7d": 7,
"activation_rate": 89,
"weekly_active_rate": 88,
"devices": {
"ios": 4,
"android": 3
},
"push_enabled_rate": 86
},
"period": {
"posts": 3,
"comments": 9,
"reactions": 27,
"messages": 48,
"user_growth": 0
},
"languages": {
"fr": 7,
"en": 1
},
"daily": [
{
"date": "2026-11-13",
"users": 8,
"active_users": 4,
"posts": 1,
"comments": 2,
"reactions": 5,
"messages": 9
},
{
"date": "2026-11-14",
"users": 8,
"active_users": 2,
"posts": 0,
"comments": 1,
"reactions": 3,
"messages": 4
}
]
}
Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.
Get a customer's insights
/customers/{customer}/insights
customers:read What the numbers mean for one customer, as the Statistics tab of the portal shows it: a verdict with the next thing to do, how far the rollout has come, the customer beside the average of your other live customers, and its weekly active rate day by day. The texts are English and may be reworded; build on the keys. A customer that was never live answers 409. See Statistics and adoption.
Parameters
customer
required
string · path
cus_…), or external_ref: followed by your own reference, such as external_ref:org_48213.
range
string · query
one of 7d, 30d, 90d · default 30d
Response · 200 The customer's insights.
object
string
customer
string
range
string
one of 7d, 30d, 90d
live_days
integer
verdict
object
key.
key
string
needs_attention: the customer is live and has an open adoption alert. getting_started: it went live less than 14 days ago. doing_well: its weekly active rate is at or above that of your other live customers together. on_track: anything else.
one of needs_attention, getting_started, doing_well, on_track
title
string
text
string
next_step
string
funnel
array of objects
comparison
array of objects
activity
object
now
integer
before
integer
change
integer, nullable
before to now. null when before is 0.
weekly_active_rate
array of objects
Errors
invalid_token: the token is missing, revoked or expired.
insufficient_ability: the token lacks the ability this call needs.
not_found: no such customer.
invalid_state: the customer was never live, so there is nothing to say yet.
validation_error: range is not 7d, 30d or 90d.
rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl https://partners.monotree.com/api/v1/customers/cus_01jcz8w3k1x9q2v7s4e6m0b5n8/insights \
-H "Authorization: Bearer $MONOTREE_TOKEN"$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://partners.monotree.com/api/v1/customers/cus_01jcz8w3k1x9q2v7s4e6m0b5n8/insights', [
'headers' => [
'Authorization' => 'Bearer '.getenv('MONOTREE_TOKEN'),
],
]);
$data = json_decode($response->getBody(), true);const response = await fetch('https://partners.monotree.com/api/v1/customers/cus_01jcz8w3k1x9q2v7s4e6m0b5n8/insights', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.MONOTREE_TOKEN}`,
},
});
const data = await response.json();import os
import requests
response = requests.get(
"https://partners.monotree.com/api/v1/customers/cus_01jcz8w3k1x9q2v7s4e6m0b5n8/insights",
headers={
"Authorization": f"Bearer {os.environ['MONOTREE_TOKEN']}",
},
)
data = response.json(){
"object": "insights",
"customer": "cus_01jcz8w3k1x9q2v7s4e6m0b5n8",
"range": "7d",
"live_days": 128,
"verdict": {
"key": "doing_well",
"title": "Doing well",
"text": "88% of its users came this week, more than your customers on average (64%).",
"next_step": "A good customer to ask for a quote or a reference."
},
"funnel": [
{
"key": "employees",
"label": "Employees",
"value": 9
},
{
"key": "invited",
"label": "Invited",
"value": 9
},
{
"key": "signed_in",
"label": "Signed in",
"value": 8
},
{
"key": "active_this_week",
"label": "Active this week",
"value": 7
}
],
"comparison": [
{
"key": "activation_rate",
"label": "Signed in",
"value": 89,
"average": 76,
"unit": "percent"
},
{
"key": "weekly_active_rate",
"label": "Active this week",
"value": 88,
"average": 64,
"unit": "percent"
},
{
"key": "activity_per_active_user",
"label": "Activity per active user",
"value": 12.4,
"average": 10.7,
"unit": "per_week"
},
{
"key": "push_enabled_rate",
"label": "Push notifications on",
"value": 86,
"average": 80,
"unit": "percent"
}
],
"activity": {
"now": 87,
"before": 92,
"change": -5
},
"weekly_active_rate": [
{
"date": "2026-11-13",
"rate": 88,
"average": 65
},
{
"date": "2026-11-14",
"rate": 88,
"average": 65
}
]
}
Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.
Get the statistics of all customers
/statistics
customers:read How all your live customers use Monotree together over a period, in the shape of a customer's statistics, and each live customer beside the others in customers_ranked, the best taken up first. Only customers with the status live are counted. The numbers of the Statistics page in the portal. A sandbox token gets the sandbox's customers.
Parameters
range
string · query
one of 7d, 30d, 90d · default 30d
seller
string · query
sel_12), or external_ref: followed by your own reference for them (external_ref:usr_20503). The same on every list that takes seller. A seller that does not exist answers 404.
Response · 200 The numbers.
range
string
one of 7d, 30d, 90d
updated_at
string, nullable
null when there are none.
totals
object
0 when there are no numbers.
users
integer
invited
integer
active_users_7d
integer
activation_rate
integer
users as a percent of invited, rounded. 0 when nobody is invited.
weekly_active_rate
integer
active_users_7d as a percent of users, rounded. 0 when there are no users.
devices
object
ios
integer
android
integer
push_enabled_rate
integer
0 when there are no phones.
period
object
posts
integer
comments
integer
reactions
integer
messages
integer
user_growth
number, nullable
users since the day before the range began, with one decimal. null when there were no users or no numbers then.
languages
object
{}) when there are no numbers.
daily
array of objects
object
string
customers
integer
employees
integer
customers_ranked
array of objects
activation_rate times weekly_active_rate, then by users. Never paged.
Errors
invalid_token: the token is missing, revoked or expired.
insufficient_ability: the token lacks the ability this call needs.
not_found: no seller matches seller.
validation_error: range is not 7d, 30d or 90d, or a seller filter is too long.
rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl https://partners.monotree.com/api/v1/statistics \
-H "Authorization: Bearer $MONOTREE_TOKEN"$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://partners.monotree.com/api/v1/statistics', [
'headers' => [
'Authorization' => 'Bearer '.getenv('MONOTREE_TOKEN'),
],
]);
$data = json_decode($response->getBody(), true);const response = await fetch('https://partners.monotree.com/api/v1/statistics', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.MONOTREE_TOKEN}`,
},
});
const data = await response.json();import os
import requests
response = requests.get(
"https://partners.monotree.com/api/v1/statistics",
headers={
"Authorization": f"Bearer {os.environ['MONOTREE_TOKEN']}",
},
)
data = response.json(){
"object": "partner_statistics",
"range": "7d",
"updated_at": "2026-11-14",
"customers": 43,
"employees": 949,
"totals": {
"users": 724,
"invited": 947,
"active_users_7d": 468,
"activation_rate": 76,
"weekly_active_rate": 65,
"devices": {
"ios": 392,
"android": 274
},
"push_enabled_rate": 80
},
"period": {
"posts": 147,
"comments": 390,
"reactions": 1450,
"messages": 3019,
"user_growth": 3.9
},
"languages": {
"fr": 425,
"es": 112,
"en": 88,
"it": 67,
"nl": 17,
"de": 15
},
"daily": [
{
"date": "2026-11-13",
"users": 722,
"active_users": 296,
"posts": 23,
"comments": 64,
"reactions": 232,
"messages": 506
},
{
"date": "2026-11-14",
"users": 724,
"active_users": 160,
"posts": 13,
"comments": 29,
"reactions": 128,
"messages": 252
}
],
"customers_ranked": [
{
"customer": "cus_01jcz8w3k1x9q2v7s4e6m0b5n8",
"company_name": "Boulangerie Martin",
"company_id": "boulangeriemartin",
"external_ref": "org_48213",
"seller": {
"id": "sel_12",
"name": "Emma Dubois",
"external_ref": "usr_20503"
},
"employees": 9,
"users": 8,
"activation_rate": 89,
"weekly_active_rate": 88,
"weekly_active_change": 0,
"activity": 87,
"adoption": null
},
{
"customer": "cus_01jd0b2q4m6s8u0w2y4a6c8e0g",
"company_name": "Librairie Voltaire",
"company_id": "librairievoltaire",
"external_ref": "org_51877",
"seller": {
"id": "sel_12",
"name": "Emma Dubois",
"external_ref": "usr_20503"
},
"employees": 21,
"users": 4,
"activation_rate": 19,
"weekly_active_rate": 75,
"weekly_active_change": 0,
"activity": 34,
"adoption": {
"alert": "ala_01jd3m5p7r9t1v3x5z7b9d1f3h",
"reason": "activation",
"message": "Only 19% of invited employees have signed in, 126 days after going live"
}
}
]
}
Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.
Get the headline numbers
/summary
customers:read Where you stand right now: how many customers are in each state, how the live ones use the app, how many of them have an open adoption alert, and the customers signed in each of the last six months. The numbers on top of the Customers page in the portal. It takes no parameters.
Response · 200 The numbers.
object
string
counts
object
draft
integer
provisioning
integer
live
integer
failed
integer
suspended
integer
cancelled
integer
live_customers
integer
live, the same number as counts.live.
employees
integer
users
integer
activation_rate
integer
weekly_active_rate
integer
low_adoption
integer
signed_by_month
array of objects
Errors
invalid_token: the token is missing, revoked or expired.
insufficient_ability: the token lacks the ability this call needs.
rate_limited: too many requests. The general limit is 120 requests a minute for all your tokens of one mode (live or sandbox) together, and 300 a minute per IP address before the token is checked. Some calls have a lower limit of their own, which counts only calls that did what they ask (a call refused with another error uses up no place); the Rate limits guide lists them. Wait for the number of seconds in the Retry-After header.
curl https://partners.monotree.com/api/v1/summary \
-H "Authorization: Bearer $MONOTREE_TOKEN"$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://partners.monotree.com/api/v1/summary', [
'headers' => [
'Authorization' => 'Bearer '.getenv('MONOTREE_TOKEN'),
],
]);
$data = json_decode($response->getBody(), true);const response = await fetch('https://partners.monotree.com/api/v1/summary', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.MONOTREE_TOKEN}`,
},
});
const data = await response.json();import os
import requests
response = requests.get(
"https://partners.monotree.com/api/v1/summary",
headers={
"Authorization": f"Bearer {os.environ['MONOTREE_TOKEN']}",
},
)
data = response.json(){
"object": "summary",
"counts": {
"draft": 1,
"provisioning": 0,
"live": 43,
"failed": 1,
"suspended": 2,
"cancelled": 3
},
"live_customers": 43,
"employees": 949,
"users": 724,
"activation_rate": 76,
"weekly_active_rate": 65,
"low_adoption": 4,
"signed_by_month": [
{
"month": "2026-06",
"signed": 6
},
{
"month": "2026-07",
"signed": 7
},
{
"month": "2026-08",
"signed": 6
},
{
"month": "2026-09",
"signed": 5
},
{
"month": "2026-10",
"signed": 5
},
{
"month": "2026-11",
"signed": 7
}
]
}
Only mpt_test_… tokens work here; nothing reaches a real customer. Kept in this browser tab only.