Skip to content

Get fundraiser statistics​

GET
/fundraisers/{id}/stats

Aggregate totals for one campaign. Readable exactly when GET /fundraisers/{id} is: a campaign that is not active, paused or ended, is private, or has been deleted answers 404 to everyone but its owner. Authentication is optional.

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)
or

Parameters​

Path Parameters

id*
Type
string
Required
Format
"uuid"

Responses​

Campaign statistics

application/json
JSON
{
"data": {
"fundraiser_id": "string",
"title": "string",
"goal_amount_cents": 0,
"total_raised_cents": 0,
"total_tips_cents": 0,
"donation_count": 0,
"donor_count": 0,
"percentage_funded": 0
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress