Ventiler une sélection selon une dimension

GET

/v1/stats/repartition

const url = 'https://api-equides.org/v1/stats/repartition?race=Pur%20Sang&robe=Bai&sexe=Femelle&discipline=TROT%20COURSE&indice=ISO&annee_naissance=2015&nom=qabalah&annee_min=2010&annee_max=2020&avec_performances=true&dimension=race&limite=20';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api-equides.org/v1/stats/repartition";

    let querystring = [
        ("race", "Pur Sang"),
        ("robe", "Bai"),
        ("sexe", "Femelle"),
        ("discipline", "TROT COURSE"),
        ("indice", "ISO"),
        ("annee_naissance", "2015"),
        ("nom", "qabalah"),
        ("annee_min", "2010"),
        ("annee_max", "2020"),
        ("avec_performances", "true"),
        ("dimension", "race"),
        ("limite", "20"),
    ];

    let client = reqwest::Client::new();
    let response = client.get(url)
        .query(&querystring)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request GET \
  --url 'https://api-equides.org/v1/stats/repartition?race=Pur%20Sang&robe=Bai&sexe=Femelle&discipline=TROT%20COURSE&indice=ISO&annee_naissance=2015&nom=qabalah&annee_min=2010&annee_max=2020&avec_performances=true&dimension=race&limite=20'

Accepte les mêmes filtres que la recherche : la répartition porte sur la sélection filtrée.

De quoi peupler des facettes sans rapatrier les lignes : seuls les effectifs traversent le réseau.

Parameters

Query Parameters

race

Array<string>

Race, répétable pour un OU (?race=A&race=B) ou séparée par des virgules. Insensible à la casse et aux accents. Le jeu compte 11 747 races distinctes ; valeurs admises sur /v1/referentiels/races.

Example

Pur Sang

robe

Array<string>

Robe, mêmes règles que race. Valeurs admises : /v1/referentiels/robes.

Example

Bai

sexe

Array<string>

Sexe tel qu’écrit par la source : Femelle, Male, Hongre, Indeter.

Example

Femelle

discipline

Array<string>

Restreint aux équidés portant des performances dans cette discipline. Valeurs admises : /v1/referentiels/disciplines.

Example

TROT COURSE

indice

Array<string>

Restreint aux équidés portant un indice de ce code (BTR, ISO, ITR…). Valeurs admises : /v1/referentiels/codes_indice.

Example

ISO

annee_naissance

Array<integer>

Millésime de naissance, répétable.

Example

nom

string

Recherche sur le nom. Chaque mot de la requête est traité comme un préfixe et tous doivent être présents : qabalah mer retrouve « QABALAH MERCURY ».

Example

qabalah

annee_min

integer

Millésime de naissance minimal, inclus.

Example

annee_max

integer

Millésime de naissance maximal, inclus.

Example

avec_performances

boolean

Restreint aux équidés portant (ou non) des indices de performance. Accepte true, false, 1, 0, oui, non. Attention : false ne signifie pas que l’équidé n’a jamais concouru, seulement qu’aucun indice n’est publié — 75,1 % du jeu est dans ce cas.

Example

true

dimension

string

default: race

Allowed values: race robe sexe discipline annee_naissance

Dimension à ventiler : race, robe, sexe, discipline, annee_naissance.

Example

race

limite

integer

default: 50 >= 1 <= 1000

Nombre de modalités renvoyées, les plus fournies d’abord (1 à 1000, défaut 50). Une valeur hors bornes est ramenée au plafond, non refusée. Sans effet sur annee_naissance, rendue en entier.

Example

Responses

200

Effectifs par modalité.

application/json

object

dimension

required

string

donnees

required

Array<object>

Une modalité et son effectif dans la sélection.

object

nombre

required

integer

valeur

required

string

effectif_affiche

required

Somme des effectifs renvoyés. Inférieure à effectif_filtre si limite tronque la liste, ou si des lignes n’ont pas de valeur pour cette dimension.

integer

effectif_filtre

required

Lignes retenues par les filtres, avant découpage.

integer

Example^generated

{
  "dimension": "example",
  "donnees": [
    {
      "nombre": 1,
      "valeur": "example"
    }
  ],
  "effectif_affiche": 1,
  "effectif_filtre": 1
}

304

Contenu inchangé depuis l’ETag fourni en If-None-Match. Aucun corps, et rien n’est recalculé côté service.

400

Dimension ou filtre invalide.

application/problem+json

Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.

object

detail

required

Explication propre à cette occurrence.

string

documentation

string

indice

Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.

string

parametre

Extension : paramètre fautif, quand l’erreur en désigne un.

string

status

required

integer

title

required

Résumé lisible, stable pour un type donné.

string

type

required

URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.

string

Example

{
  "detail": "paramètre inconnu `rase`",
  "documentation": "https://docs.api-equides.org",
  "indice": "vouliez-vous dire `race` ?",
  "parametre": "rase",
  "status": 400,
  "title": "Paramètre invalide",
  "type": "/#erreur-parametre-invalide"
}

429

Quota de débit dépassé pour l’adresse appelante. Retry-After indique le délai.

application/problem+json

Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.

object

detail

required

Explication propre à cette occurrence.

string

documentation

string

indice

Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.

string

parametre

Extension : paramètre fautif, quand l’erreur en désigne un.

string

status

required

integer

title

required

Résumé lisible, stable pour un type donné.

string

type

required

URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.

string

Example

{
  "detail": "paramètre inconnu `rase`",
  "documentation": "https://docs.api-equides.org",
  "indice": "vouliez-vous dire `race` ?",
  "parametre": "rase",
  "status": 400,
  "title": "Paramètre invalide",
  "type": "/#erreur-parametre-invalide"
}

503

Capacité de traitement simultané atteinte, délai maximal dépassé, ou données non chargées. Retry-After indique le délai.

application/problem+json

Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.

object

detail

required

Explication propre à cette occurrence.

string

documentation

string

indice

Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.

string

parametre

Extension : paramètre fautif, quand l’erreur en désigne un.

string

status

required

integer

title

required

Résumé lisible, stable pour un type donné.

string

type

required

URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.

string

Example

{
  "detail": "paramètre inconnu `rase`",
  "documentation": "https://docs.api-equides.org",
  "indice": "vouliez-vous dire `race` ?",
  "parametre": "rase",
  "status": 400,
  "title": "Paramètre invalide",
  "type": "/#erreur-parametre-invalide"
}

Ventiler une sélection selon une dimension

Parameters

Query Parameters

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Responses

200

Examplegenerated

304

400

Example

429

Example

503

Example

Example^generated