curl --request GET \
--url https://api.privy.com/v1/reports/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.privy.com/v1/reports/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.privy.com/v1/reports/summary', 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.privy.com/v1/reports/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.privy.com/v1/reports/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.privy.com/v1/reports/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.privy.com/v1/reports/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"period": {
"label": "last_30_days",
"start_date": "2026-06-21",
"end_date": "2026-07-20"
},
"comparison_period": {
"start_date": "2026-05-22",
"end_date": "2026-06-20"
},
"signups": {
"value": 1240,
"previous_value": 980,
"change": 26.5,
"change_type": "relative",
"unit": "count",
"by_channel": {
"email": 1050,
"sms": 190
}
},
"new_subscribers": {
"value": 1130,
"previous_value": 950,
"change": 18.9,
"change_type": "relative",
"unit": "count",
"by_source": {
"display": 980,
"import": 120,
"shopify": 30
},
"by_channel": {
"email": 1000,
"sms": 130
}
},
"signup_rate": {
"value": 3.2,
"previous_value": 2.9,
"change": 0.3,
"change_type": "percent_point",
"unit": "percent"
},
"attributed_revenue": {
"value": 18450.2,
"previous_value": 15200,
"change": 21.4,
"change_type": "relative",
"unit": "usd",
"by_channel": {
"email": 15200,
"sms": 3250.2
},
"by_type": {
"campaign": 11400,
"flow": 7050.2
}
},
"attributed_orders": {
"value": 312,
"previous_value": 261,
"change": 19.5,
"change_type": "relative",
"unit": "count",
"by_channel": {
"email": 262,
"sms": 50
},
"by_type": {
"campaign": 190,
"flow": 122
}
},
"order_rate": {
"value": 0.6,
"previous_value": 0.5,
"change": 0.1,
"change_type": "percent_point",
"unit": "percent"
},
"average_order_value": {
"value": 59.13,
"previous_value": 58.24,
"change": 1.5,
"change_type": "relative",
"unit": "usd"
},
"revenue_per_recipient": {
"value": 0.34,
"previous_value": 0.3,
"change": 13.3,
"change_type": "relative",
"unit": "usd"
},
"open_rate": {
"value": 41.2,
"previous_value": 39.8,
"change": 1.4,
"change_type": "percent_point",
"unit": "percent"
},
"click_rate": {
"value": 3.1,
"previous_value": 2.9,
"change": 0.2,
"change_type": "percent_point",
"unit": "percent"
},
"unsubscribe_rate": {
"value": 0.2,
"previous_value": 0.2,
"change": 0,
"change_type": "percent_point",
"unit": "percent"
},
"totals_context": {
"total_orders": 890,
"total_revenue": 52300
}
}
}{
"error": {
"code": "unauthorized",
"message": "Bearer token is missing or invalid"
}
}{
"error": {
"code": "insufficient_scope",
"message": "Token does not have the required scope"
}
}{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid",
"details": [
{
"field": "email",
"message": "is required"
}
]
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded"
}
}Get business report summary
The business-level performance rollup for a period: signups, new
subscribers, attributed revenue and orders, engagement rates, and
business-wide order and revenue totals for context. Pass
compare=previous_period to add previous-period values and typed
change deltas to every metric.
attributed_revenue and attributed_orders credit the email and SMS
messages Privy sent, under the same last-touch rule as the rest of
Privy’s reporting: an order counts when the contact’s most recent
engagement in the 7 days before it was an email open, an email click, or
an SMS click. Orders credited to a display signup are excluded, and
every figure here is dated by when the crediting message was sent,
not by when the order or the engagement happened. A period’s attributed
revenue is therefore the revenue driven by messages sent in that period,
and it includes orders placed after the period closed, whenever the
contact engaged later — so the newest days keep filling in for a while
after the fact. The engagement counts and rates use the same send
window: an open in this period on a message sent last month lands in
last month.
The rates each divide by something different. open_rate is opens
counted once per contact per campaign, over email deliveries — SMS
messages have no opens. click_rate counts clicks the same way but per
channel, over email and SMS deliveries combined. unsubscribe_rate is
unsubscribe and opt-out events, not distinct contacts, over those same
combined deliveries. order_rate is attributed orders over delivered
messages. revenue_per_recipient divides attributed revenue by
email sends only. signup_rate is display form submissions over
display views, so it measures on-site capture, not messaging. signups
counts form submissions on your displays, while new_subscribers counts
contacts becoming subscribed to marketing on either channel from any
source, so the two answer different questions and neither is
de-duplicated by contact.
Periods reaching back before the account’s reporting boundary
(2026-07-01 for most accounts, earlier where more history was
backfilled) are served whole — comparison period included — from
Privy’s historical rollups instead of the live reporting store. The
rate formulas above still hold, but the basis differs: new
subscribers, every by_channel/by_type split, and totals_context are
null; attributed orders and revenue include display-credited orders
and are dated by when the attribution was recorded, not by send time —
so order_rate’s numerator counts orders its message denominator
never sent, and reads a little high for accounts with display-credited
orders; and days are bucketed in US Eastern time regardless of the
account’s time zone. Treat comparisons that straddle the boundary as
approximate, and say so.
Required scope: reports_read
curl --request GET \
--url https://api.privy.com/v1/reports/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.privy.com/v1/reports/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.privy.com/v1/reports/summary', 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.privy.com/v1/reports/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.privy.com/v1/reports/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.privy.com/v1/reports/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.privy.com/v1/reports/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"period": {
"label": "last_30_days",
"start_date": "2026-06-21",
"end_date": "2026-07-20"
},
"comparison_period": {
"start_date": "2026-05-22",
"end_date": "2026-06-20"
},
"signups": {
"value": 1240,
"previous_value": 980,
"change": 26.5,
"change_type": "relative",
"unit": "count",
"by_channel": {
"email": 1050,
"sms": 190
}
},
"new_subscribers": {
"value": 1130,
"previous_value": 950,
"change": 18.9,
"change_type": "relative",
"unit": "count",
"by_source": {
"display": 980,
"import": 120,
"shopify": 30
},
"by_channel": {
"email": 1000,
"sms": 130
}
},
"signup_rate": {
"value": 3.2,
"previous_value": 2.9,
"change": 0.3,
"change_type": "percent_point",
"unit": "percent"
},
"attributed_revenue": {
"value": 18450.2,
"previous_value": 15200,
"change": 21.4,
"change_type": "relative",
"unit": "usd",
"by_channel": {
"email": 15200,
"sms": 3250.2
},
"by_type": {
"campaign": 11400,
"flow": 7050.2
}
},
"attributed_orders": {
"value": 312,
"previous_value": 261,
"change": 19.5,
"change_type": "relative",
"unit": "count",
"by_channel": {
"email": 262,
"sms": 50
},
"by_type": {
"campaign": 190,
"flow": 122
}
},
"order_rate": {
"value": 0.6,
"previous_value": 0.5,
"change": 0.1,
"change_type": "percent_point",
"unit": "percent"
},
"average_order_value": {
"value": 59.13,
"previous_value": 58.24,
"change": 1.5,
"change_type": "relative",
"unit": "usd"
},
"revenue_per_recipient": {
"value": 0.34,
"previous_value": 0.3,
"change": 13.3,
"change_type": "relative",
"unit": "usd"
},
"open_rate": {
"value": 41.2,
"previous_value": 39.8,
"change": 1.4,
"change_type": "percent_point",
"unit": "percent"
},
"click_rate": {
"value": 3.1,
"previous_value": 2.9,
"change": 0.2,
"change_type": "percent_point",
"unit": "percent"
},
"unsubscribe_rate": {
"value": 0.2,
"previous_value": 0.2,
"change": 0,
"change_type": "percent_point",
"unit": "percent"
},
"totals_context": {
"total_orders": 890,
"total_revenue": 52300
}
}
}{
"error": {
"code": "unauthorized",
"message": "Bearer token is missing or invalid"
}
}{
"error": {
"code": "insufficient_scope",
"message": "Token does not have the required scope"
}
}{
"error": {
"code": "validation_failed",
"message": "One or more fields are invalid",
"details": [
{
"field": "email",
"message": "is required"
}
]
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded"
}
}Authorizations
Send either an API token or an OAuth access token as
Authorization: Bearer <token>. See the Authentication page for details.
Headers
Target a subaccount instead of the main connected account.
Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts
of the connected account are reachable — omit this for the main account itself.
Query Parameters
The date range to report over, resolved in the account's time zone. Pass custom together with start_date and end_date.
last_7_days, last_30_days, last_90_days, this_month, last_month, custom Inclusive start of a custom period (ISO 8601 date). Required when period=custom, ignored otherwise.
Inclusive end of a custom period (ISO 8601 date). Required when period=custom, ignored otherwise. Custom periods are capped at 366 days.
Pass previous_period to include previous_value, change and change_type on every metric and a comparison_period block. Any other value is rejected.
previous_period Response
The business's performance rollup over the resolved period.
Show child attributes
Show child attributes
Was this page helpful?