Donation · Donations · Statistics
Get donation development
Returns the donations of a period and of the period of the same length right before it: their value in cents, count and donators, the value per month and donation type, the five largest donators, the donators who only gave in the previous period, the donators who gave for the first time or in both periods, and the value per campaign. Refers to the single positions of the donations and leaves out revoked ones. Also returns the donations waiting for a confirmation
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readdonation.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Query parameters
-
fromDatestringrequired -
toDatestringrequired
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/donations/statistics/donationDevelopment' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/donations/statistics/donationDevelopment", {
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/donations/statistics/donationDevelopment', 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
-
summaryobject9 properties
-
totalValuenumberat least 0
-
donationCountintegerat least 0
-
donatorCountintegerat least 0
-
previousTotalValuenumberat least 0
-
previousDonationCountintegerat least 0
-
previousDonatorCountintegerat least 0
-
newDonatorCountintegerat least 0
-
retainedDonatorCountintegerat least 0
-
pendingConfirmationCountintegerat least 0
-
-
monthsobject[]8 properties
-
datestring -
totalValuenumberat least 0
-
donationCountintegerat least 0
-
cashnumberat least 0
-
nonCashnumberat least 0
-
membershipFeenumberat least 0
-
assetStocknumberat least 0
-
refundnumberat least 0
-
-
topDonatorsobject[]5 properties
-
keystring -
namestring -
accountnumbernullable -
totalValuenumberat least 0
-
donationCountintegerat least 0
-
-
inactiveDonatorCountintegerat least 0
-
inactiveDonatorsobject[]5 properties
-
keystring -
namestring -
accountnumbernullable -
previousTotalValuenumberat least 0
-
lastDonationDatestring
-
-
campaignsobject[]5 properties
-
campaignidnullable -
namestringnullable1–100 characters
-
goalProgressnumbernullableat least 0
-
totalValuenumberat least 0
-
donationCountintegerat least 0
-
{
"summary": {
"totalValue": 0,
"donationCount": 0,
"donatorCount": 0,
"previousTotalValue": 0,
"previousDonationCount": 0,
"previousDonatorCount": 0,
"newDonatorCount": 0,
"retainedDonatorCount": 0,
"pendingConfirmationCount": 0
},
"months": [
{
"date": "string",
"totalValue": 0,
"donationCount": 0,
"cash": 0,
"nonCash": 0,
"membershipFee": 0,
"assetStock": 0,
"refund": 0
}
],
"topDonators": [
{
"key": "string",
"name": "string",
"account": 1,
"totalValue": 0,
"donationCount": 0
}
],
"inactiveDonatorCount": 0,
"inactiveDonators": [
{
"key": "string",
"name": "string",
"account": 1,
"previousTotalValue": 0,
"lastDonationDate": "string"
}
],
"campaigns": [
{
"campaign": "000000000000000000000001",
"name": "string",
"goalProgress": 0,
"totalValue": 0,
"donationCount": 0
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.