curl --request GET \
--url https://api.privy.com/v1/reports/displays/{display_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.privy.com/v1/reports/displays/{display_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/displays/{display_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/displays/{display_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/displays/{display_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/displays/{display_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.privy.com/v1/reports/displays/{display_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": {
"display_id": "gk2P8Zw1Lq",
"title": "Summer Sale Popup",
"display_type": "popup",
"status": "live",
"period": {
"label": "last_30_days",
"start_date": "2026-06-21",
"end_date": "2026-07-20"
},
"stats": {
"views": {
"value": 4200,
"unit": "count"
},
"signups": {
"value": 310,
"unit": "count"
},
"signup_rate": {
"value": 7.4,
"unit": "percent"
},
"attributed_orders": {
"value": 28,
"unit": "count"
},
"attributed_revenue": {
"value": 1840.5,
"unit": "usd"
},
"average_order_value": {
"value": 65.73,
"unit": "usd"
}
},
"ab_test": {
"name": "Headline test",
"state": "finished",
"goal": "signup",
"total_participants": 9400,
"winner_variation_id": null,
"variations": [
{
"id": "abv_Jq8T2vY",
"display_id": "gk2P8Zw1Lq",
"name": "Original",
"is_control": true,
"traffic_ratio": 0.5,
"participants": 4700,
"conversions": 94,
"conversion_rate": {
"value": 2,
"unit": "percent"
}
},
{
"id": "abv_Nk2P5rW",
"display_id": "mP4tR9xK2b",
"name": "Challenger",
"is_control": false,
"traffic_ratio": 0.5,
"participants": 4700,
"conversions": 129,
"conversion_rate": {
"value": 2.7,
"unit": "percent"
}
}
]
}
}
}{
"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"
}
}Get display performance
The full performance stat set for one display over a period, including average order value and, when the display has run an A/B test, per-variation participants, conversions, and conversion rates.
Ask this per display rather than hunting the leaderboard: unlike
/v1/reports/displays it reports zeroed stats for a quiet display instead
of leaving it out. The display’s own configuration — triggers, schedule,
status — is /v1/displays/{id}, keyed on the same identifier.
Required scope: reports_read
curl --request GET \
--url https://api.privy.com/v1/reports/displays/{display_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.privy.com/v1/reports/displays/{display_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/displays/{display_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/displays/{display_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/displays/{display_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/displays/{display_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.privy.com/v1/reports/displays/{display_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": {
"display_id": "gk2P8Zw1Lq",
"title": "Summer Sale Popup",
"display_type": "popup",
"status": "live",
"period": {
"label": "last_30_days",
"start_date": "2026-06-21",
"end_date": "2026-07-20"
},
"stats": {
"views": {
"value": 4200,
"unit": "count"
},
"signups": {
"value": 310,
"unit": "count"
},
"signup_rate": {
"value": 7.4,
"unit": "percent"
},
"attributed_orders": {
"value": 28,
"unit": "count"
},
"attributed_revenue": {
"value": 1840.5,
"unit": "usd"
},
"average_order_value": {
"value": 65.73,
"unit": "usd"
}
},
"ab_test": {
"name": "Headline test",
"state": "finished",
"goal": "signup",
"total_participants": 9400,
"winner_variation_id": null,
"variations": [
{
"id": "abv_Jq8T2vY",
"display_id": "gk2P8Zw1Lq",
"name": "Original",
"is_control": true,
"traffic_ratio": 0.5,
"participants": 4700,
"conversions": 94,
"conversion_rate": {
"value": 2,
"unit": "percent"
}
},
{
"id": "abv_Nk2P5rW",
"display_id": "mP4tR9xK2b",
"name": "Challenger",
"is_control": false,
"traffic_ratio": 0.5,
"participants": 4700,
"conversions": 129,
"conversion_rate": {
"value": 2.7,
"unit": "percent"
}
}
]
}
}
}{
"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
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.
Path Parameters
The display's unique identifier (returned as display_id in report responses and id in display responses). Ids are opaque public strings — a numeric id from a Privy dashboard URL is not a valid API id and will 404; list displays and match by title instead.
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.
Response
The display's performance over the resolved period.
One display's report: its identity, the period-scoped stats block, and A/B test results when the display has ever had a test.
Show child attributes
Show child attributes
Was this page helpful?