L'API de cada.data.gouv.fr ne contient que deux points d'entrée:

  • /api/<id>/: pour l'accès direct à un avis depuis son identifiant
  • /api/search/: pour la recherche paginée

Le fonctionnement est strictement similaire à celui des pages web.

Accès direct

Cette API permet l'accès direct à un avis CADA par son identifiant

Exemple

Voici un exemple d'accès direct à l'avis CADA n°20134525

GET /api/20134525/

Recherche

La recherche accepte les paramètres d'URL suivants:

  • q: recherche textuelle
  • sort: critère de tri. Le tri s'effectue sur le score de recherche si ce paramètre n'est pas spécifié. Les valeurs possibles sont:
    • administration (asc|desc): tri par administrations
    • topic (asc|desc): tri par thémes
    • session (asc|desc): tri par date de séance
  • administration: filtre sur l'administration spécifiée
  • tag: filtre sur la tag spécifié (peut-être spécifié plusieurs fois)
  • topic: filtre sur le thème spécifié
  • session: filtre sur la session spécifiée (au format yyyy-mm-dd
  • part: filtre sur le partie pris (au choix, 1, 2 ou 3)
  • meaning: filtre sur les réponses données
  • page: affiche la page indiquée (en relation avec page_size
  • page_size: spécifie la taille de la pagination (20 par défaut)

La réponse est un objet JSON à 5 attributs:

  • advices: une liste triée des avis correspondants aux critères de recherche
  • page: le numéro de la page courante
  • page_size: la taille de la pagination
  • total: le nombre total d'avis retournés par la recherche
  • facets: Les différents facettes associées à la recherche sous la forme de liste de triplets:
    1. la valeur du champ associé à la facette
    2. le nombre d'occurence dans les résultats de la recherche
    3. true si un filtre est appliqué sur cette valeur

Exemple

Voici un exemple de recherche sur le terme "Paris", triée par dates de séance décroissantes et n'affichant que les 3 premiers éléments

GET /api/search?q=Paris&sort=session+desc&page_size=3