API Sirene - Documentation des services

retour au sommaire

---

Utilisation des facettes pour les requêtes multicritères

Présentation du service

Les facettes permettent d’effectuer des comptages. Les paramètres pour obtenir les facettes s'ajoutent aux paramètres précédents (q, date...). Les facettes sont applicables à un champ, une requête ou un intervalle. Elles peuvent également être imbriquées.

Facettes sur champ (i.e sur variable)

Pour générer des facettes , il faut ajouter la requête facette.champ à une chaîne de requêtes. Le paramètre date permet d’appliquer les comptages à la date choisie. L’utilisation de facette.champ permet de garantir le comptage de l’exhaustivité des modalités présentes sur la variable sélectionnée.

La syntaxe est la suivante :

facette.champ=champ1
facette.champ=champ1,champ2…

Le résultat des comptages se trouve sous l’item Facettes. Chaque facette possède un nom (celui de la variable) et une liste de comptages, à chaque comptage correspond une valeur de la variable et le nombre d'unités présentant cette valeur. Les comptages s’effectuent sur la période courante des champs quand ceux-ci sont historisés.

Exemples

Répartition des établissements selon leur état administratif courant : https://api.insee.fr/entreprises/sirene/V3/siret?facette.champ=etatAdministratifEtablissement&nombre=0

Répartition des établissements selon leur état administratif courant, via la console :

• nombre : 0
• facette.champ : etatAdministratifEtablissement

{
    "header": {
        "statut": 200,
        "message": "OK",
        "total": 28410765,
        "debut": 0,
        "nombre": 0
    },
    "etablissements": [],
    "facettes": [
        {
            "nom": "etatAdministratifEtablissement",
            "comptages": [
                {
                    "valeur": "F",
                    "nombre": 17123768
                },
                {
                    "valeur": "A",
                    "nombre": 11286997
                }
            ]
        }
    ]
}

Répartition des établissements selon leur état administratif au 1er janvier 2000 : https://api.insee.fr/entreprises/sirene/V3/siret?facette.champ=etatAdministratifEtablissement&nombre=0&date=2000-01-01

{
    "header": {
        "statut": 200,
        "message": "OK",
        "total": 10604359,
        "debut": 0,
        "nombre": 0
    },
    "etablissements": [],
    "facettes": [
        {
            "nom": "etatAdministratifEtablissement",
            "comptages": [
                {
                    "valeur": "A",
                    "nombre": 5303333
                },
                {
                    "valeur": "F",
                    "nombre": 5232329
                }
            ]
        }
    ]
}

Répartition des personnes physiques par sexe (renseigné) et par état administratif courant : https://api.insee.fr/entreprises/sirene/V3/siren?q=periode(categorieJuridiqueUniteLegale:1000) AND sexeUniteLegale:*&facette.champ=sexeUniteLegale,etatAdministratifUniteLegale&nombre=0&date=2099-12-31

Répartition des établissements selon leur état administratif courant, via la console :

• q : periode(categorieJuridiqueUniteLegale:1000) AND sexeUniteLegale:*
• date : 2099-12-31
• nombre : 0
• facette.champ : sexeUniteLegale,etatAdministratifUniteLegale

{
    "header": {
        "statut": 200,
        "message": "OK",
        "total": 13515509,
        "debut": 0,
        "nombre": 0
    },
    "unitesLegales": [],
    "facettes": [
        {
            "nom": "etatAdministratifUniteLegale",
            "comptages": [
                {
                    "valeur": "C",
                    "nombre": 7148761
                },
                {
                    "valeur": "A",
                    "nombre": 6366748
                }
            ]
        },
        {
            "nom": "sexeUniteLegale",
            "comptages": [
                {
                    "valeur": "M",
                    "nombre": 8502427
                },
                {
                    "valeur": "F",
                    "nombre": 5013082
                }
            ]
        }
    ]
}

Format csv

Les facettes ne sont pas disponibles en csv.

Commentaires

Dans le deuxième exemple, la somme des facettes (5303333 + 5232329) est inféreure au total (10604359) : la différence correspond aux établissements pour lesquels la variable n'est pas renseignée. Par défaut, les facettes ne renvoient pas les valeurs manquantes : pour les voir apparaître, il est nécessaire d'ajouter le paramètre facette.manquant:true (non-disponible via la console).
Dans le troisième exemple, les comptages C/A et M/F sont indépendants : pour récupérer la ventilation par sexe des unités selon qu'elles sont actives ou cessées, il faut utiliser les facettes imbriquées.
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 recherche par facette (paramètre facette.champ). 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.
Attention : "facettes.champ" est la seule possibilité d'utiliser les facettes sur la console, et le nombre de facettes affichables y est limité à 10 : pour un nombre de modalités supérieur à 10, il faut ajouter le paramètre facette.nombre (non-disponible via la console).
Pour en savoir plus

Haut de page

---