GET
/
admin
/
wrapped
/
{year}
curl --request GET \
  --url https://api.helpyousponsor.com/v1/admin/wrapped/{year} \
  --header 'Authorization: Bearer <token>'
{
  "metrics": {
    "overview": {
      "totalDonations": 1234,
      "totalAmount": 567890,
      "newDonors": 89,
      "avgDonation": 460
    },
    "monthly": [
      {
        "month": "2024-01",
        "donationCount": 123,
        "amount": 45000
      }
    ],
    "donorGrowth": {
      "newDonors": 89,
      "totalDonors": 500,
      "growthRate": 17.8
    },
    "programPerformance": [
      {
        "programId": 1,
        "programName": "Education Fund",
        "totalDonations": 150,
        "totalAmount": 75000,
        "commitments": {
          "total": 50,
          "active": 45,
          "pastDue": 3,
          "inactive": 2,
          "uniqueDonors": 40,
          "donorsWithoutCommitments": 10,
          "totalAmount": 25000,
          "annualizedAmount": 300000
        }
      }
    ],
    "retention": {
      "retentionRate": 75.5,
      "retainedDonors": 300,
      "previousYearDonors": 400,
      "currentYearDonors": 450
    },
    "topDonors": [
      {
        "donorId": 123,
        "donationCount": 5,
        "totalAmount": 25000,
        "name": "Anonymous"
      }
    ],
    "avgFillTime": 14.5
  },
  "descriptions": {
    "overview": {
      "title": "Your Year in Giving",
      "description": "<string>",
      "stats": {}
    },
    "donorGrowth": {
      "title": "Growing Together",
      "description": "<string>",
      "stats": {}
    },
    "retention": {
      "title": "Lasting Connections",
      "description": "<string>",
      "stats": {}
    },
    "monthly": {
      "title": "Monthly Impact",
      "description": "<string>",
      "stats": {}
    },
    "programPerformance": {
      "title": "Program Success",
      "description": "<string>",
      "stats": {}
    },
    "summary": {
      "title": "2024 Impact Story",
      "description": "<string>",
      "stats": {}
    }
  },
  "lastUpdated": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
year
integer
required

Year to get wrapped data for. Must not be a future year. If not specified, defaults to current year.

Example:

2024

Query Parameters

​
refresh
boolean

Force refresh of wrapped statistics. For large datasets (>10,000 donations), triggers async calculation.

Example:

false

Response

200
application/json
Successful operation
​
metrics
object
​
descriptions
object
​
lastUpdated
string
Previous
Check calculation status for wrapped statistics
Next