Donation ยท Forms
Get donation form statistics
Returns statistics for a donation form identified by organization, mandate, and donation form IDs. The response includes one-time donation counts, amounts and amounts paid, plus approved recurring donation counts and yearly amounts.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Organization access is required.
- The caller needs
mandate.read. - The caller needs
donationForm.read.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
donationFormIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/forms/YOUR_DONATION_FORM_ID/statistics' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/forms/YOUR_DONATION_FORM_ID/statistics", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/forms/YOUR_DONATION_FORM_ID/statistics', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
oneTimeCountintegerat least 0
-
oneTimeAmountintegerat least 0
-
oneTimePaidAmountintegerat least 0
-
recurringCountintegerat least 0
-
recurringYearlyAmountintegerat least 0
Response200
{
"oneTimeCount": 0,
"oneTimeAmount": 0,
"oneTimePaidAmount": 0,
"recurringCount": 0,
"recurringYearlyAmount": 0
}
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | The donation form was not found. | If the donation form is not found, the endpoint returns HTTP 404 with NOT_FOUND and the key routes.donation.forms.formNotFound. |
Errors nearly every request can meet are listed under Errors.