The current code exposes GET /api/external/schools/{school_id}/campaigns/{campaign_id}/stats. Replace the placeholders with actual IDs and confirm that the deployment supports this external API. Its current registry version is v1; use the deployed API documentation for the version contract.
The response includes total, total_display, currency_code, donor_count, goal, progress_percentage, status, campaign_type and visibility/countdown data. It requires an eligible current-partner school and publicly visible campaign, applies authorization, and excludes campaigns configured to hide statistics. A hidden goal returns null for goal/progress; a hidden or unavailable countdown is also null. Do not interpret hidden fields as zero.
Progress uses donor count for donor-goal campaigns and total for dollar-goal campaigns, floors the percentage, and returns zero when the goal is zero. Completed campaigns can use saved positive final dollar/donor totals. The reported amount is campaign progress, not a bank-deposit reconciliation.
This external API is distinct from legacy API-key endpoints. Its base supports unauthenticated access subject to endpoint authorization, existing sessions, or accepted WorkOS external-api-scope tokens. Legacy GiveCampus API-key bearer authentication is rejected. Do not paste a key into a URL or assume that generating a legacy key grants access here. Responses use conditional caching and ETags. Follow the endpoint’s current response contract when implementing polling.
Comments
0 comments
Please sign in to leave a comment.