Logo de l'API Sirene

API Sirene - Documentation des services

 Logo de l'Insee
retour au sommaire

Utilisation des facettes pour les requêtes multicritères

Paramétrage des facettes

En complément du paramètre obligatoire "facette.champ", un certain nombre de paramétrages sont possibles :

Paramètre

Valeur par défaut

Résultat

debut

0

permet de démarrer à partir de la facette suivant celle dont l’index est passé en argument, pour paginer. Valeurs possibles : entiers.
Ex : facette.debut=99 affiche les comptages à partir de la centième facette.

nombre

10

permet de définir le nombre de facettes affichées, pour paginer. Valeurs possibles : entiers. Voir exemples 2 et 3 ci-dessous.

min

1

permet d’exclure les modalités dont le comptage est inférieur à la valeur choisie. Valeurs possibles : entiers. Exemples

tri

count:desc

index:asc

permet de trier les facettes. Les valeurs possibles sont count:desc, count:asc, index:desc,index:asc. count trie par nombre de résultats, index par ordre alphabétique. desc ou asc représentent l’ordre descendant ou ascendant. Exemples

manquant

false

compte les valeurs manquantes sur ce champ. Le comptage est associé à l’intitulé Manquants, au même niveau que le nom de la facette. Valeurs possibles : true ou false. Exemples

total

false

compte la somme de toutes les facettes renvoyées (donc sauf les manquants, même si manquant=true). Le comptage est associé à l’intitulé Total, au même niveau que le Nom de la facette. Valeurs possibles : true ou false. Exemples

modalite

false

compte le nombre de modalités distinctes pour ce champ. Le comptage est associé à l’intitulé Modalites, au même niveau que le nom de la facette. Valeurs possibles : true ou false. Exemples

prefixe

Non valorisé

permet de n’inclure que les facettes commençant par le préfixe saisi. Exemples

La syntaxe pour paramétrer en une fois toutes les facettes définies est :

facette.paramètre=valeur du paramètre
Vous pouvez également paramétrer indépendamment chaque facette sur champ. La syntaxe est alors :
facette.champ1.paramètre=valeur du paramètre
facette.champ2.paramètre=valeur du paramètre

Exemples

Parmi les Sociétés par Actions Simplifiées (SAS), ventilation des établissements par nombre de périodes (compris entre 1 et 5 inclus), tri descendant et par catégorie juridique, tri descendant :
https://api.insee.fr/api-sirene/3.11/siret?q=categorieJuridiqueUniteLegale:57* AND nombrePeriodesEtablissement:[1 TO 5]&facette.champ=categorieJuridiqueUniteLegale,nombrePeriodesEtablissement&nombre=0&facette.categorieJuridiqueUniteLegale.tri=index:desc&facette.nombrePeriodesEtablissement.tri=index:desc
{
    "header": {
        "statut": 200,
        "message": "OK",
        "total": 2827759,
        "debut": 0,
        "nombre": 0
    },
    "etablissements": [],
    "facettes": [
        {
            "nom": "nombrePeriodesEtablissement",
            "comptages": [
                {
                    "valeur": "5",
                    "nombre": 127541
                },
                {
                    "valeur": "4",
                    "nombre": 396942
                },
                {
                    "valeur": "3",
                    "nombre": 511087
                },
                {
                    "valeur": "2",
                    "nombre": 874498
                },
                {
                    "valeur": "1",
                    "nombre": 917691
                }
            ]
        },
        {
            "nom": "categorieJuridiqueUniteLegale",
            "comptages": [
                {
                    "valeur": "5785",
                    "nombre": 15678
                },
                {
                    "valeur": "5770",
                    "nombre": 4861
                },
                {
                    "valeur": "5720",
                    "nombre": 12
                },
                {
                    "valeur": "5710",
                    "nombre": 2807208
                }
            ]
        }
    ]
}
Parmi les Sociétés commerciales, ventilation des établissements par nombre de périodes (au moins égla à 15), tri descendant du nombre d'occurrences, et catégorie juridique, tri descendant des modalités :
https://api.insee.fr/api-sirene/3.11/siret?q=categorieJuridiqueUniteLegale:5* AND nombrePeriodesEtablissement:[15 TO *]&facette.champ=categorieJuridiqueUniteLegale,nombrePeriodesEtablissement&nombre=0&facette.categorieJuridiqueUniteLegale.tri=index:desc&facette.nombrePeriodesEtablissement.tri=count:desc
{
    "header": {
        "statut": 200,
        "message": "OK",
        "total": 196,
        "debut": 0,
        "nombre": 0
    },
    "etablissements": [],
    "facettes": [
        {
            "nom": "nombrePeriodesEtablissement",
            "comptages": [
                {
                    "valeur": "15",
                    "nombre": 52
                },
                {
                    "valeur": "16",
                    "nombre": 38
                },
                {
                    "valeur": "17",
                    "nombre": 25
                },
                {
                    "valeur": "18",
                    "nombre": 16
                },
                {
                    "valeur": "21",
                    "nombre": 12
                },
                {
                    "valeur": "20",
                    "nombre": 11
                },
                {
                    "valeur": "19",
                    "nombre": 10
                },
                {
                    "valeur": "23",
                    "nombre": 6
                },
                {
                    "valeur": "24",
                    "nombre": 6
                },
                {
                    "valeur": "22",
                    "nombre": 4
                }
            ]
        },
        {
            "nom": "categorieJuridiqueUniteLegale",
            "comptages": [
                {
                    "valeur": "5710",
                    "nombre": 32
                },
                {
                    "valeur": "5599",
                    "nombre": 1
                },
                {
                    "valeur": "5499",
                    "nombre": 158
                },
                {
                    "valeur": "5202",
                    "nombre": 5
                }
            ]
        }
    ]
}
Dans l'exemple ci-dessus, les deux facettes contiennent potentiellement plus de 10 modalités (nombre par défaut), mais seul le nombre de périodes affiche 10 modalités, avec une somme des occurrences qui n'atteint pas le total. En ajoutant le paramètre facette.nombre=100, valable pour toutes les facettes (ou facette.nombrePeriodesEtablissement.nombre=100 valable pour la facette indiquée) on obtient l'ensemble des modalités.
On aura toujours intérêt à paramétrer facette.nombre en fonction de la facette présentant le plus grand nombre de modalités potentielles.
https://api.insee.fr/api-sirene/3.11/siret?q=categorieJuridiqueUniteLegale:5* AND nombrePeriodesEtablissement:[15 TO *]&facette.champ=categorieJuridiqueUniteLegale,nombrePeriodesEtablissement&nombre=0&facette.categorieJuridiqueUniteLegale.tri=index:desc&facette.nombrePeriodesEtablissement.tri=count:desc&facette.nombrePeriodesEtablissement.nombre=100
{
    "header": {
        "statut": 200,
        "message": "OK",
        "total": 196,
        "debut": 0,
        "nombre": 0
    },
    "etablissements": [],
    "facettes": [
        {
            "nom": "nombrePeriodesEtablissement",
            "comptages": [
                {
                    "valeur": "15",
                    "nombre": 52
                },
                {
                    "valeur": "16",
                    "nombre": 38
                },
                {
                    "valeur": "17",
                    "nombre": 25
                },
                {
                    "valeur": "18",
                    "nombre": 16
                },
                {
                    "valeur": "21",
                    "nombre": 12
                },
                {
                    "valeur": "20",
                    "nombre": 11
                },
                {
                    "valeur": "19",
                    "nombre": 10
                },
                {
                    "valeur": "23",
                    "nombre": 6
                },
                {
                    "valeur": "24",
                    "nombre": 6
                },
                {
                    "valeur": "22",
                    "nombre": 4
                },
                {
                    "valeur": "26",
                    "nombre": 3
                },
                {
                    "valeur": "27",
                    "nombre": 3
                },
                {
                    "valeur": "25",
                    "nombre": 2
                },
                {
                    "valeur": "33",
                    "nombre": 2
                },
                {
                    "valeur": "36",
                    "nombre": 2
                },
                {
                    "valeur": "30",
                    "nombre": 1
                },
                {
                    "valeur": "34",
                    "nombre": 1
                },
                {
                    "valeur": "38",
                    "nombre": 1
                },
                {
                    "valeur": "46",
                    "nombre": 1
                }
            ]
        },
        {
            "nom": "categorieJuridiqueUniteLegale",
            "comptages": [
                {
                    "valeur": "5710",
                    "nombre": 32
                },
                {
                    "valeur": "5599",
                    "nombre": 1
                },
                {
                    "valeur": "5499",
                    "nombre": 158
                },
                {
                    "valeur": "5202",
                    "nombre": 5
                }
            ]
        }
    ]
}

Commentaires

Voir aussi les exemples plus complets, accessibles à partir du tableau en haut de la page.
Rappel : Les facettes ne sont pas disponibles en csv.
Les facettes sont indépendantes par défaut, mais il est possible de les imbriquer.
Les paramétrages autres que "facettes.champ" ne sont pas disponibles sur la console.
Pour en savoir plus

Haut de page