Stats
Représente les données statistiques de l'ensemble des cagnottes asssociées à un compte.
Les données renvoyées correspondent à une plage de date définie par les paramètres ts_start et ts_end sur l'ensemble des endpoints.
Par défaut, la période correspond à celle d'aujourd'hui.
ts_start vaut la date d'aujourd'hui à 00:00.
ts_end vaut la date d'aujourd'hui à 23:59.
Les valeurs monétaires sont exprimées en centimes d'euros.
Paramètres
ts_start (entier facultatif)
Un timestamp en millisecondes. Par défault, vaut la date d'aujourd'hui à 00:00.
ts_end (entier facultatif )
Un timestamp en millisecondes. Par défault, vaut la date d'aujourd'hui à 23:59.
| GET | /stats/dashboard |
| GET | /stats/pots |
Récupérer le Dashboard
La requête doit être exécutée depuis un code client-side.
Les données dites dashboard représentent le nombre de cagnottes total, le montant total collecté, le montant moyen collecté, le nombre de don etc...
Ces données pouvant servir à la construction d'un dashboard avec l'UI correspondante.
Retourne code 200
Les données statistiques correspondantes à la période sélectionnée.
Les champs
total dictionnaire
Les données totales (sans tenir compte de la période demandée)
{
// le nombre de cagnottes - entier
"nb_pots": 0,
// le montant colecté - entier
"amount_donations": 0,
// le montant moyen collecté - entier
"amount_moy_donations": 0,
// le nombre de dons - entier
"nb_donations": 0
}
date_range dictionnaire
Les données similaires à total mais sur la période sélectionnée
tips dictionnaire (facultatif)
Représente les données des pourboires laissés par les donateurs.
Ce champs peut être null (dépend de la configuration avec La Cagnotte des Proches).
Si la valeur de tips n'est pas nulle, contient les champs total et date_range.
tips.total dictionnaire
Les données totales (sans tenir compte de la période demandée)
{
// le nombre de pourboires - entier
"nb_tips": 0,
// le montant - entier
"amount": 0,
// le montant réel (sans les frais bancaires) - entier
"amount_real": 0
}
tips.date_range dictionnaire
Les données similaires à tips.total mais sur la période sélectionnée
curl "https://api.lacagnottedesproches.fr/stats/dashboard?ts_start=1681509600000&ts_end=1713170066153" \ -X GET \ -H "lcdp-pubkey: PUBLISHABLE_KEY" \ -H "Origin: https://allowed-domain.com"
{
"total": {
"nb_pots": 0,
"amount_donations": 0,
"amount_moy_donations": 0,
"nb_donations": 0
},
"date_range": {
"nb_pots": 0,
"amount_donations": 0,
"amount_moy_donations": 0,
"nb_donations": 0
},
"tips": {
"total": {
"nb_tips": 0,
"amount": 0,
"amount_real": 0
},
"date_range": {
"nb_tips": 0,
"amount": 0,
"amount_real": 0
}
}
}
Récupérer les Cagnottes
La requête doit être exécutée depuis un code client-side.
Retourne la liste des informations statistiques des cagnottes attachées au compte.
Les champs nb_tips, amount_tips, amount_real_tips sont facultatifs.
Suivant la configuration avec La Cagnotte des Proches ces valeurs peuvent ne pas être retournées.
Retourne code 200
Un dictionnaire avec le champs items qui contient un tableau d'informations statistiques d'une cagnotte.
Les paramètres de pagination sont utilisés.
Voir /dev/api#pagination
Les champs
date_created_ts entier
Le timestamp en millisecondes représentent la date de création de la cagnotte.
slug chaine de caractères
Le slug correspondant à l'URL publique de la cagnotte.
name chaine de caractères
Le nom de la cagnotte.
status_online boolean
Indique si la cagnotte est en ligne ou non.
status_public boolean
Indique si la cagnotte est publique. Publique signifie qu'elle est visible par le moteur de recherche et donc disponible via la page d'accueil.
Si la cagnotte n'est pas publique, elle n'est pas indexée et est accessible uniquement via son lien URL.
status_closed boolean
Indique si la cagnotte est clôturée.
owner_first_name chaine de caractères (facultatif)
Le prénom du cagnotteur. La personne qui a créé la cagnotte.
owner_last_name chaine de caractères (facultatif)
Le nom du cagnotteur. La personne qui a créé la cagnotte.
tags chaine de caractères (facultatif)
Les informations transmises lors de la création du compte via un partenaire.
nb_donations entier
Le nombre de dons.
amount_donations entier
Le montant collecté.
amount_moy_donations entier
Le montant moyen collecté.
nb_tips entier (facultatif)
Le nombre de pourboires.
amount_tips entier (facultatif)
Le montant des pourboires.
amount_real_tips entier (facultatif)
Le montant réel (sans les frais bancaires) des pourboires.
curl "https://api.lacagnottedesproches.fr/stats/pots?ts_start=1681509600000&ts_end=1713170066153" \ -X GET \ -H "lcdp-pubkey: PUBLISHABLE_KEY" \ -H "Origin: https://allowed-domain.com"
{
"page": 1,
"per_page": 20,
"total": 59,
"items": [
{
"date_created_ts": 1712646415361,
"slug": "obseques-de-john-doe",
"name": "Obsèques de John DOE",
"status_online": false,
"status_public": false,
"status_closed": false,
"owner_first_name": "John",
"owner_last_name": "Doe",
"tags": "client=abcde",
"nb_donations": 0,
"amount_donations": 0,
"amount_moy_donations": 0,
"nb_tips": 0,
"amount_tips": 0,
"amount_real_tips": 0
},
{...},
],
}