Indicateur de Données & Territoires

Décrit un indicateur défini pour Données & Territoires.

Properties

• identifiant (string): Identifiant de l’indicateur, utilisé pour appelé l’indicateur.
• nom (string): Nom pour désigner l’indicateur dans les interfaces.
• description (string): Description de l’indicateur pour donner plus de contexte que dans le nom.
• schema (object): JSON schema de l’indicateur.
• sql (string): Requête SQL de l’indicateur.
• expression (string): Expression SQL qui permet de faire des opérations sur d’autres indicateurs.
• ratio (object): Expression SQL qui permet de faire un ratio entre deux indicateurs d’une même maille.
• numerateur (string)
• denominateur (string)
• return_type: Type de données retourné par l’indicateur. Must be one of: ['auto', 'list', 'row', 'rows', 'one_value']. Default: auto.
• catégorie (string): Catégorie de l’indicateur.
• maille_origine: Maille des données. Must be one of: ['commune', 'département', 'région', 'pays']. Default: département.
• mailles_origine (array): Mailles des données.
• Items: Must be one of: ['commune', 'département', 'région', 'pays'].
• tables (array): Dans certains cas nous n’arrivons pas à déterminer automatiquement les tables utilisées par la requête SQL, on peut les définir ici.
• Items (string)
• unité (string): Unité retourné par la requête, peut par exemple être des euros, dans ce cas on met €.
• mailles (array): Mailles pouvant être demandées pour calculer cet indicateur.
• Items (string): Must be one of: ['commune', 'epci', 'département', 'région', 'pays'].
• colonne_geo (string): Sert dans le cas où on ne parvient pas à déterminer automatiquement quelle est la colonne géographique de la requête.
• tags (array): Une série de clés et valeurs arbitraires pour catégoriser cet indicateur.
• Items (object): Can contain additional properties.
  • Additional Properties (string)
• deprecated (boolean): Indique si l’indicateur est déprécié. Default: False.
• dimensions (array): Les dimensions additionnelles sur lesquelles filtrer l’indicateur.
• Items (object)
  • identifiant (string)
  • titre (string)
  • description (string)
  • colonne (string)
  • catégories (array)
  • Items (object)
    • titre (string)
    • valeur
    • valeurs
• publish (array): Liste des publications à effectuer pour cet indicateur.
• Items (object)
  • target: Type de publication. Must be one of: ['pilote'].
  • pilote_idenfitiant (string): Identifiant du pilote à utiliser pour la publication.
  • pilote_chantier (string): Chantier pilote à utiliser pour la publication.
  • pilote_mailles (array): Mailles à utiliser pour la publication.
  • Items: Must be one of: ['commune', 'département', 'région', 'pays'].
• geo (object): Exposer des informations géographiques avec chaque valeur de l’indicateur.
• auto (boolean): Déterminer automatiquement les colonnes à utiliser et le référentiel à joindre. Default: False.
• colonnes (object): Spécifier les colonnes à utiliser pour les informations géographiques.
  • code (string): Colonne ou expression SQL à utiliser pour le code géographique.
  • libelle (string): Colonne ou expression SQL à utiliser pour le libellé géographique.
  • point (string): Colonne ou expression SQL à utiliser pour les coordonnées du point.
  • contour (string): Colonne ou expression SQL à utiliser pour la géométrie du contour.
• surcharges (array)
• Items (object)
  • maille: Maille pour laquelle on souhaite surcharger certaines propriétés. Must be one of: ['commune', 'epci', 'département', 'région', 'pays'].
  • sql (string): Requête SQL de l’indicateur.