Le point de terminaison LivelihoodActivitySummary permet de filtrer les Zones de moyens d’existence selon la contribution des activités de moyens d’existence au revenu total d’un groupe de richesse.
Exemple
Cette URL affiche la liste des Activités de moyens d’existence des Groupes de richesse pour lesquels la production de sorgho fournit au moins 20 % des calories.
Filtres
Ce point de terminaison utilise deux catégories de filtres.
-
Filtres standard : ils filtrent les Lignes de base renvoyées. Les paramètres de
filtre standard déterminent les Activités de moyens d’existence incluses dans les données à agréger. -
Filtres de tranche : à eux seuls, ils ne retirent pas de Lignes de base des résultats ; ils filtrent seulement les statistiques. Les paramètres de tranche servent à calculer la part du revenu global, des dépenses, de kcals_consumed et de percentage_kcals qui provient de la tranche.
Chaque ligne de résultats contient le montant total de chaque indicateur (income, expenditure, kcals_consumed, percentage_kcals), le montant apporté par la tranche et le pourcentage du total apporté par la tranche.
Comme les résultats sont agrégés sur les champs demandés, il est très facile de compter les valeurs en double. Il est important de bien comprendre quelles données sont agrégées et de vérifier que les filtres appropriés sont appliqués. Par exemple, si une Ligne de base contient des données à la fois pour le scénario de référence et pour le scénario de réponse, et que vous ne précisez pas de filtre de scénario, les valeurs des indicateurs correspondront à la somme des deux scénarios.
Filtres standard
Plusieurs filtres standard sont disponibles pour ce point de terminaison.
Filtres de tranche
Les paramètres de tranche sont les suivants :
-
slice_by_product: correspond à tout code CPC qui commence par la valeur indiquée. Pour en indiquer plusieurs, répétez le paramètre, p. ex. slice_by_product=R0&slice_by_product=B01. La hiérarchie des produits est disponible via le point de terminaison des produits classés, /api/classifiedproduct/. -
slice_by_strategy_type: vous pouvez en indiquer plusieurs. Utilisez les codesstrategy_typeindiqués ci-dessus. Ils ne tiennent pas compte de la casse, mais doivent sinon correspondre exactement.
Pour le moment, l’API ne prend en charge qu’une seule tranche à la fois et crée une tranche unique en combinant tous les paramètres de tranche. Si le produit et le type de stratégie sont tous deux indiqués, la tranche sélectionne les Activités de moyens d’existence qui correspondent aux deux. Si vous indiquez un slice_by_product pour un produit sans rapport avec le slice_by_strategy_type sélectionné, aucune activité n’est sélectionnée et les valeurs de la tranche sont nulles.
Les agrégats produits sont les suivants :
-
income_sum_row -
expenditure_sum_row -
kcals_consumed_sum_row -
percentage_kcals_sum_row -
total_income_as_percentage_kcals_row
Si une tranche est indiquée, les agrégats supplémentaires suivants sont produits :
-
income_sum_slice -
income_sum_slice_percentage_of_row -
expenditure_sum_slice -
expenditure_sum_slice_percentage_of_row -
kcals_consumed_sum_slice -
kcals_consumed_sum_slice_percentage_of_row -
percentage_kcals_sum_slice -
percentage_kcals_sum_slice_percentage_of_row -
total_income_as_percentage_kcals_slice -
total_income_as_percentage_kcals_slice_percentage_of_row
Notez que le revenu total correspond au revenu en kcal plus le revenu en espèces.
Vous pouvez filtrer sur n’importe quel agrégat calculé de tranche ou de ligne en ajoutant le préfixe min_ ou max_ à son nom. Par exemple, &min_income_sum_slice_percentage_of_row=52.
Champs
Pour choisir les champs à afficher, utilisez le paramètre fields de la manière habituelle.
Si vous omettez le paramètre fields, tous les champs sont renvoyés. Avec fields=simple, ce point de terminaison ne renvoie que les champs agrégés.
Le paramètre fields détermine la façon dont les données sont agrégées et présentées dans les résultats. Si un champ est inclus, les lignes sont désagrégées pour afficher les chiffres ventilés selon ce champ. Tous les champs non inclus sont agrégés ensemble.
Exemple
Dans cette première URL, il y a un filtre slice_by_product et la liste des champs ne comprend ni product ni product_common_name. Les résultats sont agrégés par strategy_type.
Si l’on ajoute product à la liste des champs, les données sont désormais ventilées par produit.
Comme slice_percentage_of_row indique le pourcentage de la valeur totale de la ligne apporté par la tranche, si le champ de la tranche (produit et/ou type de stratégie) figure aussi dans le paramètre &fields, les valeurs de slice_percentage_of_row sont soit 0, soit 100 %, selon que la valeur du champ de la ligne correspond ou non à la tranche.
Exemple
L’exemple ci-dessus comprend un filtre slice_by_product.
Dans le premier jeu de résultats, où product n’est pas inclus comme champ, les valeurs de kcals_consumed_sum_slice_percentage_of_row comprennent 88 et 15.
Dans le second jeu de résultats, où product est inclus comme champ, les valeurs de kcals_consumed_sum_slice_percentage_of_row sont toutes égales à 100 ou à 0.
Tri
Ce point de terminaison utilise le paramètre standard ordering. Si aucun n’est indiqué, les résultats sont triés par ordre décroissant des agrégats (c.-à-d. le pourcentage le plus élevé en premier).