Get flow performance
curl --request GET \
--url https://api.privy.com/v1/reports/flows/{flow_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.privy.com/v1/reports/flows/{flow_id}"
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/flows/{flow_id}', 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/flows/{flow_id}",
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/flows/{flow_id}"
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/flows/{flow_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.privy.com/v1/reports/flows/{flow_id}")
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": {
"flow_id": "Vq7L3mN9xR",
"title": "Abandoned Cart Recovery",
"status": "active",
"trigger_type": "cart_abandoned",
"channels": "multi",
"current_enrollment": {
"value": 86,
"unit": "count"
},
"period": {
"label": "last_30_days",
"start_date": "2026-06-21",
"end_date": "2026-07-20"
},
"stats": {
"sent": {
"value": 5200,
"unit": "count"
},
"delivered": {
"value": 5050,
"unit": "count"
},
"opened": {
"value": 2210,
"unit": "count"
},
"clicked": {
"value": 640,
"unit": "count"
},
"open_rate": {
"value": 51.4,
"unit": "percent"
},
"click_rate": {
"value": 12.7,
"unit": "percent"
},
"attributed_orders": {
"value": 210,
"unit": "count"
},
"attributed_revenue": {
"value": 9640.5,
"unit": "usd"
},
"order_rate": {
"value": 4.2,
"unit": "percent"
},
"average_order_value": {
"value": 45.91,
"unit": "usd"
},
"unsubscribed": {
"value": 34,
"unit": "count"
},
"bounced": {
"value": 61,
"unit": "count"
},
"sms_opted_out": {
"value": 12,
"unit": "count"
},
"sms_failed": {
"value": 9,
"unit": "count"
}
},
"nodes": [
{
"uuid": "7a2f9e1b-5c3d-4d2e-8b4f-3a6c8d9e0f1a",
"type": "email",
"name": "Cart reminder email",
"subject": "You left something behind",
"stats": {
"sent": {
"value": 2600,
"unit": "count"
},
"delivered": {
"value": 2540,
"unit": "count"
},
"opened_unique": {
"value": 1180,
"unit": "count"
},
"clicked_unique": {
"value": 340,
"unit": "count"
},
"bounced": {
"value": 38,
"unit": "count"
},
"unsubscribed": {
"value": 21,
"unit": "count"
},
"attributed_orders": {
"value": 120,
"unit": "count"
},
"attributed_revenue": {
"value": 5610.25,
"unit": "usd"
}
}
},
{
"uuid": "8b3a0f2c-6d4e-4e3f-9c5a-4b7d9e0f1a2b",
"type": "sms",
"name": "Cart reminder text",
"stats": {
"sent": {
"value": 780,
"unit": "count"
},
"delivered": {
"value": 762,
"unit": "count"
},
"clicked_unique": {
"value": 96,
"unit": "count"
},
"opted_out": {
"value": 7,
"unit": "count"
},
"failed": {
"value": 18,
"unit": "count"
},
"attributed_orders": {
"value": 41,
"unit": "count"
},
"attributed_revenue": {
"value": 1890,
"unit": "usd"
}
}
}
]
}
}{
"error": {
"code": "unauthorized",
"message": "Bearer token is missing or invalid"
}
}{
"error": {
"code": "insufficient_scope",
"message": "Token does not have the required scope"
}
}{
"error": {
"code": "not_found",
"message": "Not found"
}
}{
"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"
}
}Reports
Get flow performance
One flow’s performance over a period: the combined email + SMS stat set plus a per-node breakdown of each email and SMS message step.
Configuration — trigger, filters, re-entry behavior, branch graph — is
/v1/flows/{id}. The per-node uuids match that response’s node uuids,
which is how a message step is placed in the flow graph; a step the flow
no longer contains has no counterpart there.
Required scope: reports_read
GET
/
reports
/
flows
/
{flow_id}
Get flow performance
curl --request GET \
--url https://api.privy.com/v1/reports/flows/{flow_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.privy.com/v1/reports/flows/{flow_id}"
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/flows/{flow_id}', 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/flows/{flow_id}",
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/flows/{flow_id}"
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/flows/{flow_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.privy.com/v1/reports/flows/{flow_id}")
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": {
"flow_id": "Vq7L3mN9xR",
"title": "Abandoned Cart Recovery",
"status": "active",
"trigger_type": "cart_abandoned",
"channels": "multi",
"current_enrollment": {
"value": 86,
"unit": "count"
},
"period": {
"label": "last_30_days",
"start_date": "2026-06-21",
"end_date": "2026-07-20"
},
"stats": {
"sent": {
"value": 5200,
"unit": "count"
},
"delivered": {
"value": 5050,
"unit": "count"
},
"opened": {
"value": 2210,
"unit": "count"
},
"clicked": {
"value": 640,
"unit": "count"
},
"open_rate": {
"value": 51.4,
"unit": "percent"
},
"click_rate": {
"value": 12.7,
"unit": "percent"
},
"attributed_orders": {
"value": 210,
"unit": "count"
},
"attributed_revenue": {
"value": 9640.5,
"unit": "usd"
},
"order_rate": {
"value": 4.2,
"unit": "percent"
},
"average_order_value": {
"value": 45.91,
"unit": "usd"
},
"unsubscribed": {
"value": 34,
"unit": "count"
},
"bounced": {
"value": 61,
"unit": "count"
},
"sms_opted_out": {
"value": 12,
"unit": "count"
},
"sms_failed": {
"value": 9,
"unit": "count"
}
},
"nodes": [
{
"uuid": "7a2f9e1b-5c3d-4d2e-8b4f-3a6c8d9e0f1a",
"type": "email",
"name": "Cart reminder email",
"subject": "You left something behind",
"stats": {
"sent": {
"value": 2600,
"unit": "count"
},
"delivered": {
"value": 2540,
"unit": "count"
},
"opened_unique": {
"value": 1180,
"unit": "count"
},
"clicked_unique": {
"value": 340,
"unit": "count"
},
"bounced": {
"value": 38,
"unit": "count"
},
"unsubscribed": {
"value": 21,
"unit": "count"
},
"attributed_orders": {
"value": 120,
"unit": "count"
},
"attributed_revenue": {
"value": 5610.25,
"unit": "usd"
}
}
},
{
"uuid": "8b3a0f2c-6d4e-4e3f-9c5a-4b7d9e0f1a2b",
"type": "sms",
"name": "Cart reminder text",
"stats": {
"sent": {
"value": 780,
"unit": "count"
},
"delivered": {
"value": 762,
"unit": "count"
},
"clicked_unique": {
"value": 96,
"unit": "count"
},
"opted_out": {
"value": 7,
"unit": "count"
},
"failed": {
"value": 18,
"unit": "count"
},
"attributed_orders": {
"value": 41,
"unit": "count"
},
"attributed_revenue": {
"value": 1890,
"unit": "usd"
}
}
}
]
}
}{
"error": {
"code": "unauthorized",
"message": "Bearer token is missing or invalid"
}
}{
"error": {
"code": "insufficient_scope",
"message": "Token does not have the required scope"
}
}{
"error": {
"code": "not_found",
"message": "Not found"
}
}{
"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
Headers
Path Parameters
Query Parameters
Was this page helpful?