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

Facettes sur requête

Les facettes sur requête, créées par l’utilisateur, permettent de renvoyer le comptage particulier d’une partie du champ défini par le paramètre q , en sélectionnant tous les éléments répondant à la fois à la requête q et à la requête de la facette. En l’absence de paramètre q , seuls les comptages des facettes créées sont renvoyés.

La syntaxe est la suivante :

facette.requete=nomFacette
facette.nomFacette.q={requête q}
C’est l’utilisateur qui choisit le libellé de nomFacette. {requête q} suit la même syntaxe que la requête sur le paramètre q.
Le comptage apparaît sur une facette dont le Nom vaut nomFacette (valeur de facette.requete) et le résultat du comptage est associé à l’intitulé Total de cette facette. En présence du paramètre q, si le total général (en début de réponse) n’est pas égal à la somme des totaux de facettes, c’est que celles-ci ne couvrent pas l’intégralité du champ q (choix délibéré ou modalités oubliées, comme l’absence de valeur par exemple).

Exemple

Répartition des établissements de SARL des Yvelines selon leur commune d'implantation, avec une facette personnalisée (78646 + 78686 + 78158) :
https://api.insee.fr/entreprises/sirene/V3.11/siret?q=categorieJuridiqueUniteLegale:5499%20AND%20codeCommuneEtablissement:78*&nombre=0&facette.requete=monSecteur&facette.champ=codeCommuneEtablissement&facette.monSecteur.q=codeCommuneEtablissement:78646%20OR%20codeCommuneEtablissement:78158%20OR%20codeCommuneEtablissement:78686
ou
{
    "header": {
        "statut": 200,
        "message": "OK",
        "total": 126418,
        "debut": 0,
        "nombre": 0
    },
    "etablissements": [],
    "facettes": [
        {
            "nom": "codeCommuneEtablissement",
            "comptages": [
                {
                    "valeur": "78646",
                    "nombre": 11728
                },
                {
                    "valeur": "78551",
                    "nombre": 6628
                },
                {
                    "valeur": "78361",
                    "nombre": 4256
                },
                {
                    "valeur": "78586",
                    "nombre": 4040
                },
                {
                    "valeur": "78423",
                    "nombre": 3265
                },
                {
                    "valeur": "78498",
                    "nombre": 3209
                },
                {
                    "valeur": "78158",
                    "nombre": 3051
                },
                {
                    "valeur": "78168",
                    "nombre": 2736
                },
                {
                    "valeur": "78311",
                    "nombre": 2722
                },
                {
                    "valeur": "78517",
                    "nombre": 2623
                }
            ]
        },
        {
            "nom": "monSecteur",
            "total": 16099
        }
    ]
}
Répartition des établissements de SARL des Yvelines selon leur commune d'implantation, avec une facette personnalisée (etablissements actifs du secteur du commerce de détail dans les communes 78646 et 78158) :
https://api.insee.fr/entreprises/sirene/V3.11/siret?q=categorieJuridiqueUniteLegale:5499%20AND%20codeCommuneEtablissement:78*&nombre=0&facette.requete=monChoix&facette.champ=codeCommuneEtablissement&facette.monChoix.q=codeCommuneEtablissement:78646%20OR%20codeCommuneEtablissement:78158%20AND%20periode(etatAdministratifEtablissement:A%20AND%20activitePrincipaleEtablissement:47*)&date=2099-12-31
{
    "header": {
        "statut": 200,
        "message": "OK",
        "total": 125189,
        "debut": 0,
        "nombre": 0
    },
    "etablissements": [],
    "facettes": [
        {
            "nom": "monChoix",
            "total": 226
        },
        {
            "nom": "codeCommuneEtablissement",
            "comptages": [
                {
                    "valeur": "78646",
                    "nombre": 11581
                },
                {
                    "valeur": "78551",
                    "nombre": 6570
                },
                {
                    "valeur": "78361",
                    "nombre": 4213
                },
                {
                    "valeur": "78586",
                    "nombre": 3979
                },
                {
                    "valeur": "78423",
                    "nombre": 3248
                },
                {
                    "valeur": "78498",
                    "nombre": 3176
                },
                {
                    "valeur": "78158",
                    "nombre": 3027
                },
                {
                    "valeur": "78168",
                    "nombre": 2712
                },
                {
                    "valeur": "78311",
                    "nombre": 2684
                },
                {
                    "valeur": "78517",
                    "nombre": 2591
                }
            ]
        }
    ]
}

Commentaires

Les facettes créées par l'utilisateur sont indépendantes des facettes automatiques : les unités dénombrées par les unes le sont aussi par les autres. Ainsi, les 226 établissements de la facette monChoix ci-dessus font-ils également partie des comptages des facettes 78646 et 78158.
Pour un utilisateur n'ayant pas le droit d'accès aux données en diffusion partielle, un contrôle est fait sur chaque variable présente dans la requête (paramètre facette.nomFacette.q). Les unités légales ou les établissements pour lesquels au moins l'une de ces variables est en diffusion partielle, ne seront pas comptabilisés dans les résultats de la recherche.
Rappel : les facettes ne sont pas disponibles en csv. Les facettes sur requête ne sont pas disponibles sur la console. Pour en savoir plus

Haut de page