Developer Documentation

Dashboard Stats API Reference

Read account-level totals from the FundraiserMax API: campaigns, dollars raised against goal, contact counts, and average gift.

Dashboard Stats

The Dashboard API returns aggregated statistics for your account, useful for building custom dashboards or reporting tools.

GET/v1/dashboard/stats

Retrieve account totals: campaign counts and dollars raised against goal, plus contact counts and average gift.

NameTypeRequiredDescription
accountIdstringYesYour organization account ID.
curl -X GET "https://api.fundraisermax.com/api/v1/dashboard/stats?accountId=acct_123" \
  -H "X-API-Key: fmx_your_key_id" \
  -H "Authorization: Bearer your_api_secret"

Response

{
  "campaigns": {
    "totalCampaigns": 4,
    "activeCampaigns": 3,
    "totalRaised": 284750.00,
    "totalGoal": 500000.00,
    "averageProgress": 56.95
  },
  "contacts": {
    "totalContacts": 1247,
    "activeContacts": 1180,
    "inactiveContacts": 67,
    "totalDonated": 284750.00,
    "averageDonation": 241.31
  },
  "summary": {
    "totalCampaigns": 4,
    "totalContacts": 1247,
    "totalRaised": 284750.00,
    "goalProgress": 56.95
  }
}