Get project funding stats

GET

/projects/{fundraiserId}/stats

Returns allocation, disbursement, and milestone-count stats for a project-type fundraiser. Non-project fundraisers return zeroed stats. Not available yet for project fundraisers: the endpoint currently answers 500 for them. 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

fundraiserId*

Type

string

Required

Responses

Project stats

Content-Type

application/json

{

"totalAllocated": 0,

"totalDisbursed": 0,

"unallocated": 0,

"milestones": {

"total": 0,

"additionalProperties": 0

}

}

GET

/projects/{fundraiserId}/stats

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

fundraiserId*

Samples

Powered by VitePress OpenAPI