---
title: "Agrégats sur un jeu de données"
method: GET
path: "/jeux/{jeu}/agregats"
---

# Agrégats sur un jeu de données

`GET /jeux/{jeu}/agregats`

## Request

- Base URL: `https://pillr.fr/api/v1`
- URL: `https://pillr.fr/api/v1/jeux/{jeu}/agregats`
- Auth: HTTP bearer

Des agrégats sur un jeu, avec les filtres de lire_jeu : le nombre de lignes de chaque groupe (n, toujours rendu) et des mesures sur les colonnes mesurables (nombre, somme, moyenne, médiane, quantile, minimum, maximum ; médiane et quantiles continus), groupées par 3 colonnes groupables au plus. Les groupes les plus nombreux d'abord, 1000 au plus. Aucun seuil ne masque un groupe : un petit groupe est servi avec son n et le drapeau peu_d_observations. Servi depuis la mémoire seulement de 20h30 à minuit (heure de Paris). Coût : 5 crédits par appel réussi.

## Path parameters

- `jeu` 'annonces' | 'evenements_prix' | 'diffusions' | 'communes' | 'prix_iris' | 'loyers' | 'mutations' | 'indice_travaux' | 'adresses' | 'dvf' | 'dvf_ancien' | 'ban' | 'dpe_existant' | 'dpe_neuf' | 'dpe_tertiaire' | 'dpe_ancien' | 'audits' | 'coproprietes' | 'permis_logements' | 'permis_locaux' | 'permis_demolir' | 'permis_amenager' | 'bodacc' | 'lovac' | 'plu' | 'signaux_communes' | 'marche_commune' | 'agences_commune' | 'sirene_immobilier' | 'annonces_archives' | 'biens', required: Nom du jeu, tel que GET /jeux le liste.

## Query parameters

- `grouper` union: Colonnes de groupe, séparées par des virgules (3 au plus, colonnes groupables du jeu).
  - string
  - string[]
- `mesures` union: Mesures, séparées par des virgules, chacune « fonction:colonne » (10 au plus) : nombre, somme, moyenne, mediane, quantile, min, max (alias count, sum, avg, median) ; « quantile:colonne:0.9 » pour un quantile. Le nombre de lignes de chaque groupe (n) est toujours rendu.
  - string
  - string[]
- `filtre` object: Filtres : filtre[colonne][operateur]=valeur, 12 au plus, combinés par « et ». Opérateurs : eq, in, lt, lte, gt, gte, entre, prefixe, nul. Les colonnes filtrables et leurs opérateurs sont dans le schéma du jeu ; un jeu volumineux exige au moins un filtre sur une colonne indexée.
- `limite_groupes` integer: Groupes rendus au plus, les plus nombreux d'abord (100 par défaut, 1000 au plus).

## Response `200`

Réponse servie et débitée (sauf réponse identique déjà servie dans les 24 h).

- object
  - `jeu` string, required
  - `titre` string, required
  - `base` 'servie' | 'lac', required
  - `nature` 'calcule_pillr' | 'public_brut', required
  - `grouper` string[], required
  - `mesures` object[], required: Les mesures demandées.
    - `nom` string, required: Nom de la mesure dans chaque groupe.
    - `fonction` string, required
    - `colonne` string, required
    - `q` number, nullable, required: Ordre du quantile ; null pour les autres fonctions.
  - `groupes` object[], required: Les groupes, les plus nombreux d'abord.
    - `cles` object, required: Valeurs des colonnes de groupe.
    - `n` integer, required: Nombre de lignes du groupe.
    - `mesures` object, required: Mesures du groupe, sous leur nom (fonction_colonne).
    - `drapeaux` string[], required: peu_d_observations : moins de 5 lignes dans le groupe.
  - `n_groupes` integer, required
  - `tronque` boolean, required: Vrai : la limite de groupes est atteinte, d'autres groupes existent peut-être.
  - `donnees_du` string, nullable, required
  - `qualite` object, required: Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
    - `n` integer, nullable, required: Nombre d'observations derrière la valeur ; null si sans objet.
    - `provenance` 'mesure' | 'estime', nullable, required: mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
    - `incertitude` object, nullable, required: Incertitude de la valeur : fourchette et demi-largeur.
      - `demi_largeur_pct` number, nullable, required: Demi-largeur de la fourchette, en % de la valeur.
      - `bas` number, nullable, required
      - `haut` number, nullable, required
    - `drapeaux` string[], required: Ce qui doit faire lire la valeur avec prudence ; vide si rien.
    - `methode` string, nullable, required: Méthode de calcul ou de rattachement, en clair.
    - `donnees_du` string, nullable, required: Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
    - `source` string, required: Source publique ou moteur Pillr, en clair.
  - `credits` object, required: Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
    - `debites` integer, required
    - `restants` integer, nullable, required

## Other responses

- `304`: Non modifiée depuis l'ETag fourni : rien n'est débité.
- `400`: Paramètres invalides
- `401`: Clé d'API absente
- `402`: Crédits insuffisants ; Carte requise ; Plafond mensuel de dépense atteint
- `403`: Portée insuffisante
- `404`: Ressource absente : rien n'est débité
- `429`: Trop de requêtes par minute
- `500`: Erreur interne
- `503`: API indisponible ; Donnée momentanément indisponible ; Opération coupée sur ce créneau

---

[API](https://skmtc.dev/pillr/apis/api-pillr.md) · [All operations](https://skmtc.dev/pillr/apis/api-pillr/llms.txt) · [OpenAPI document](https://skmtc.dev/pillr/apis/api-pillr/revisions/218b2866bd6c?raw)