Skip to content

Read fundraising and audience analytics​

GET
/org-admin/{slug}/analytics

Raised money uses the shared ledger net-of-fees definition and stays grouped by currency. GA4 audience data is restricted to organization and fundraiser page paths. Geography contains approximate city aggregates, not donor identities or street addresses. Requires organization permission org.read_donations.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Path Parameters

slug*

Organization slug; middleware resolves and authorizes this organization before any read or write.

Type
string
Required

Query Parameters

range

Existing analytics range such as 7d, 28d, 90d or alltime; custom dates use the analytics range format.

Type
string
Default
"28d"

Responses​

Successful organization-scoped response

application/json
JSON
{
"data": {
"range": "string",
"from": "string",
"to": "string",
"donors": 0,
"totals": [
{
"currency": "string",
"gifts": 0,
"donors": 0,
"raised_cents": 0
}
],
"trend": [
{
"date": "string",
"currency": "string",
"raised_cents": 0,
"gifts": 0
}
],
"geography": [
{
"city": "string",
"country": "string",
"gifts": 0,
"lat": 0,
"lng": 0
}
],
"fundraisers": [
{
}
],
"audience": {
},
"ga_status": "string"
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress