curl --request POST \
--url https://api.juo.io/admin/v1/analytics/query \
--header 'Content-Type: application/json' \
--header 'X-Juo-Admin-Api-Key: <api-key>' \
--header 'X-Tenant-ID: <x-tenant-id>' \
--data '
{
"range": {
"from": "<string>",
"to": "<string>"
},
"dimensions": [
"<string>"
],
"filter": {
"children": "<array>"
},
"timezone": "<string>",
"currency": "<string>"
}
'import requests
url = "https://api.juo.io/admin/v1/analytics/query"
payload = {
"range": {
"from": "<string>",
"to": "<string>"
},
"dimensions": ["<string>"],
"filter": { "children": "<array>" },
"timezone": "<string>",
"currency": "<string>"
}
headers = {
"X-Tenant-ID": "<x-tenant-id>",
"X-Juo-Admin-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Tenant-ID': '<x-tenant-id>',
'X-Juo-Admin-Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
range: {from: '<string>', to: '<string>'},
dimensions: ['<string>'],
filter: {children: '<array>'},
timezone: '<string>',
currency: '<string>'
})
};
fetch('https://api.juo.io/admin/v1/analytics/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.juo.io/admin/v1/analytics/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'range' => [
'from' => '<string>',
'to' => '<string>'
],
'dimensions' => [
'<string>'
],
'filter' => [
'children' => '<array>'
],
'timezone' => '<string>',
'currency' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Juo-Admin-Api-Key: <api-key>",
"X-Tenant-ID: <x-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.juo.io/admin/v1/analytics/query"
payload := strings.NewReader("{\n \"range\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"dimensions\": [\n \"<string>\"\n ],\n \"filter\": {\n \"children\": \"<array>\"\n },\n \"timezone\": \"<string>\",\n \"currency\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Tenant-ID", "<x-tenant-id>")
req.Header.Add("X-Juo-Admin-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.juo.io/admin/v1/analytics/query")
.header("X-Tenant-ID", "<x-tenant-id>")
.header("X-Juo-Admin-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"range\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"dimensions\": [\n \"<string>\"\n ],\n \"filter\": {\n \"children\": \"<array>\"\n },\n \"timezone\": \"<string>\",\n \"currency\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.juo.io/admin/v1/analytics/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Tenant-ID"] = '<x-tenant-id>'
request["X-Juo-Admin-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"range\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"dimensions\": [\n \"<string>\"\n ],\n \"filter\": {\n \"children\": \"<array>\"\n },\n \"timezone\": \"<string>\",\n \"currency\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"series": [
{
"start": "<string>",
"end": "<string>",
"dimensions": {},
"value": 123
}
],
"meta": {
"additivity": "<string>",
"sourceModel": "<string>",
"currencyConverted": true,
"unit": "<string>",
"ignoredFilters": [
"<string>"
]
}
}Query analytics
Executes a time-series analytics query for a given metric.
curl --request POST \
--url https://api.juo.io/admin/v1/analytics/query \
--header 'Content-Type: application/json' \
--header 'X-Juo-Admin-Api-Key: <api-key>' \
--header 'X-Tenant-ID: <x-tenant-id>' \
--data '
{
"range": {
"from": "<string>",
"to": "<string>"
},
"dimensions": [
"<string>"
],
"filter": {
"children": "<array>"
},
"timezone": "<string>",
"currency": "<string>"
}
'import requests
url = "https://api.juo.io/admin/v1/analytics/query"
payload = {
"range": {
"from": "<string>",
"to": "<string>"
},
"dimensions": ["<string>"],
"filter": { "children": "<array>" },
"timezone": "<string>",
"currency": "<string>"
}
headers = {
"X-Tenant-ID": "<x-tenant-id>",
"X-Juo-Admin-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Tenant-ID': '<x-tenant-id>',
'X-Juo-Admin-Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
range: {from: '<string>', to: '<string>'},
dimensions: ['<string>'],
filter: {children: '<array>'},
timezone: '<string>',
currency: '<string>'
})
};
fetch('https://api.juo.io/admin/v1/analytics/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.juo.io/admin/v1/analytics/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'range' => [
'from' => '<string>',
'to' => '<string>'
],
'dimensions' => [
'<string>'
],
'filter' => [
'children' => '<array>'
],
'timezone' => '<string>',
'currency' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Juo-Admin-Api-Key: <api-key>",
"X-Tenant-ID: <x-tenant-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.juo.io/admin/v1/analytics/query"
payload := strings.NewReader("{\n \"range\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"dimensions\": [\n \"<string>\"\n ],\n \"filter\": {\n \"children\": \"<array>\"\n },\n \"timezone\": \"<string>\",\n \"currency\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Tenant-ID", "<x-tenant-id>")
req.Header.Add("X-Juo-Admin-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.juo.io/admin/v1/analytics/query")
.header("X-Tenant-ID", "<x-tenant-id>")
.header("X-Juo-Admin-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"range\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"dimensions\": [\n \"<string>\"\n ],\n \"filter\": {\n \"children\": \"<array>\"\n },\n \"timezone\": \"<string>\",\n \"currency\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.juo.io/admin/v1/analytics/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Tenant-ID"] = '<x-tenant-id>'
request["X-Juo-Admin-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"range\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"dimensions\": [\n \"<string>\"\n ],\n \"filter\": {\n \"children\": \"<array>\"\n },\n \"timezone\": \"<string>\",\n \"currency\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"series": [
{
"start": "<string>",
"end": "<string>",
"dimensions": {},
"value": 123
}
],
"meta": {
"additivity": "<string>",
"sourceModel": "<string>",
"currencyConverted": true,
"unit": "<string>",
"ignoredFilters": [
"<string>"
]
}
}Authorizations
Long-lived Admin API key issued from the Juo merchant portal. Pass as the X-Juo-Admin-Api-Key header.
Headers
Unique identifier of the tenant in the system (usually a store identifier)
Body
The metric to compute, e.g. subscriptions:mrr, customers:count, subscriptions:purchased.
customers:count, customers:status-changes, customers:churned, subscriptions:count, subscriptions:purchased, subscriptions:renewed, subscriptions:canceled, order-items:revenue, subscriptions:cancellation-flow, customers:ltv, orders:lifetime-aov, customers:avg-lifetime-orders, subscriptions:churned, subscriptions:unique-churned, subscriptions:churned-mrr, orders:with-items, orders:item-aov, subscriptions:mrr, customers:revenue-per-customer, orders:count, orders:revenue, orders:aov, order-items:count, order-items:units, orders:avg-units, customers:new, customers:reactivations, customers:resumes, customers:pauses, customers:churn-transitions, subscriptions:status-changes, subscriptions:pauses, subscriptions:current-mrr, subscription-items:count Time bucket granularity used to group results.
day, week, month, year, total Show child attributes
Show child attributes
Optional list of dimension keys to group results by, e.g. ["plan_id", "billing_interval"].
- SegmentNode
- SegmentNode
Show child attributes
Show child attributes
IANA timezone name used to align bucket boundaries, e.g. America/New_York. Defaults to UTC.
ISO 4217 currency code to convert monetary metrics to, e.g. USD. When omitted, values are returned in the tenant's default currency.
Optional cohort definition. When present, returns a retention triangle or LTV-by-cohort matrix.
Show child attributes
Show child attributes
Aggregation function to apply over time buckets (default: sum). Only applies to metrics that support it.
sum, avg, min, max, last