Intelligence
Read Donor Intelligence coverage and capacity summary
Requires the donor_intelligence feature and route permissions. Every client_id route is restricted to the authenticated organization, including platform administrators using workspace routes. Stored profiles are filtered against current email-privacy state; obsolete privacy snapshots are concealed. Legacy wealth-insights URLs are equivalent aliases. Coverage is the fraction of supporter donors with a current profile. Stale/high-capacity counts use dashboard settings; large workspaces may use a cached summary.
GET
/
admin
/
wealth-insights
/
{client_id}
/
summary
Read Donor Intelligence coverage and capacity summary
curl --request GET \
--url https://api.gratona.com/v1/admin/wealth-insights/{client_id}/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/wealth-insights/{client_id}/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.gratona.com/v1/admin/wealth-insights/{client_id}/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.gratona.com/v1/admin/wealth-insights/{client_id}/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.gratona.com/v1/admin/wealth-insights/{client_id}/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.gratona.com/v1/admin/wealth-insights/{client_id}/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/wealth-insights/{client_id}/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{
"status": "success",
"data": {
"total_donors": 123,
"insights_distinct_donors": 123,
"coverage_pct": 123,
"ready_count": 123,
"insufficient_data_count": 123,
"stale_count": 123,
"high_capacity_count": 123,
"profile_capacity_total": 123,
"available_profile_runs": 123,
"has_ai_capacity": true,
"subscription_metadata": {
"included_plan_remaining": 123,
"top_up_remaining": 123,
"renewal_date": "2023-11-07T05:31:56Z"
},
"ai_capacity": {
"available_credits": 123,
"reserved_credits": 123,
"spent_credits": 123,
"included_plan_granted": 123,
"included_plan_remaining": 123,
"annual_pack_remaining": 123,
"top_up_remaining": 123,
"display_label": "<string>",
"paid_runs_disabled": true,
"expiring_soon": [
{
"credits": 123,
"expires_at": "2023-11-07T05:31:56Z",
"source_type": "<string>"
}
],
"top_up": {
"credits": 123,
"price_cents": 123,
"currency": "<string>"
},
"action_rates": {},
"recent_entries": [
{
"id": 123,
"client_id": 123,
"user_id": 123,
"entry_type": "<string>",
"action_type": "<string>",
"credit_delta": 123,
"balance_after_credits": 123,
"amount_cents": 123,
"currency": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"run_id": 123,
"expires_at": "2023-11-07T05:31:56Z",
"pricing_version": "<string>",
"idempotency_key": "<string>",
"stripe_payment_intent_id": "<string>",
"note": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"metadata_json": {}
}
]
}
}
}{
"status": "error",
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"status": "error",
"message": "<string>",
"code": "<string>",
"errors": {}
}Authorizations
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Client id.
⌘I
Read Donor Intelligence coverage and capacity summary
curl --request GET \
--url https://api.gratona.com/v1/admin/wealth-insights/{client_id}/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/wealth-insights/{client_id}/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.gratona.com/v1/admin/wealth-insights/{client_id}/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.gratona.com/v1/admin/wealth-insights/{client_id}/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.gratona.com/v1/admin/wealth-insights/{client_id}/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.gratona.com/v1/admin/wealth-insights/{client_id}/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/wealth-insights/{client_id}/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{
"status": "success",
"data": {
"total_donors": 123,
"insights_distinct_donors": 123,
"coverage_pct": 123,
"ready_count": 123,
"insufficient_data_count": 123,
"stale_count": 123,
"high_capacity_count": 123,
"profile_capacity_total": 123,
"available_profile_runs": 123,
"has_ai_capacity": true,
"subscription_metadata": {
"included_plan_remaining": 123,
"top_up_remaining": 123,
"renewal_date": "2023-11-07T05:31:56Z"
},
"ai_capacity": {
"available_credits": 123,
"reserved_credits": 123,
"spent_credits": 123,
"included_plan_granted": 123,
"included_plan_remaining": 123,
"annual_pack_remaining": 123,
"top_up_remaining": 123,
"display_label": "<string>",
"paid_runs_disabled": true,
"expiring_soon": [
{
"credits": 123,
"expires_at": "2023-11-07T05:31:56Z",
"source_type": "<string>"
}
],
"top_up": {
"credits": 123,
"price_cents": 123,
"currency": "<string>"
},
"action_rates": {},
"recent_entries": [
{
"id": 123,
"client_id": 123,
"user_id": 123,
"entry_type": "<string>",
"action_type": "<string>",
"credit_delta": 123,
"balance_after_credits": 123,
"amount_cents": 123,
"currency": "<string>",
"source_type": "<string>",
"source_id": "<string>",
"run_id": 123,
"expires_at": "2023-11-07T05:31:56Z",
"pricing_version": "<string>",
"idempotency_key": "<string>",
"stripe_payment_intent_id": "<string>",
"note": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"metadata_json": {}
}
]
}
}
}{
"status": "error",
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Something went wrong. Please try again.",
"status": "error",
"error": "invalid_request",
"code": "DONOR_NOT_FOUND"
}{
"status": "error",
"message": "<string>",
"code": "<string>",
"errors": {}
}