Détails sur les champs spécifiques du jeu de données ods-api-monitoring

Vous pouvez utiliser les jeux de données disponibles sur vos pages Statistiques pour surveiller et analyser l'utilisation de vos espaces de travail et de vos jeux de données. Voir Introduction à l'utilisation des statistiques de vos espaces de travail pour des informations plus générales sur les ensembles de données disponibles et sur l'endroit où les trouver.

Cette page détaille certaines valeurs de champs spécifiques que vous êtes susceptible d'utiliser pour analyser vos données. Pour un exemple d'utilisation courante de l'utilsations de ces statistiques, voir cette page.

Valeurs des champs dans le jeu de données ods-api-monitoring

Dans le jeu de données ods-api-monitoring, deux colonnes—"api_type" et "api"—enregistrent des valeurs qui peuvent vous aider à analyser comment vos données sont utilisées.

Sous "api_type", vous pouvez trouver les types d'API suivants, qui correspondent aux API que vous pouvez utiliser avec Opendatsoft : ods_v1, ods_v2, ods_v2.0, ods_v2.1, odata, wfs, csw, et tpf.

Valeurs correspondant au type d'API ods_v1

Ce sont les valeurs sous le champ "api", et qui correspondent au "api_type" ods_v1. Le type ods_v1 correspond à notre Search API v1, qui peut être utilisée par nos widgets ou bien appelée directement.

Nom de l'API	La description	Modèle d'URL
`search_datasets`	Rechercher dans le catalogue	api/datasets/1.0/recherche
`lookup_dataset`	Récuperer un jeu de données	api/datasets/1.0/<dataset_id>
`download_dataset`	Télécharger les enregistrements de jeu de données à partir de l'onglet Export	explore/dataset/<dataset_id>/download/
`download_dataset_alternative_export`	Télécharger le jeu de données dans un autre format d'export	api/datasets/1.0/<dataset_id>/alternative_exports/<export_id>/
`download_dataset_attachment`	Télécharger les pièces jointes d'un jeu de données de l'onglet informations	api/datasets/1.0/<dataset_id>/attachments/<attachment_id>/
`dataset_list_snapshots`	Lister les captures d'un jeu de données	api/datasets/1.0/<dataset_id>/snapshots/
`dataset_download_snapshot`	Télécharger une capture de jeu de données	api/datasets/1.0/<dataset_id>/snapshots/<snapshot_id>/
`search_dataset_records`	Rechercher dans les enregistrements dans le jeu de données	api/datasets/1.0/<dataset_id>/records/
`lookup_record`	Récupérer un enregistrement identifié	api/datasets/1.0/<dataset_id>/records/<record_id>
`download_dataset_records`	Télécharger les enregistrements du jeu de données à partir de l'API (nombre total de téléchargements du jeu de données = `dowload_dataset` + `download_dataset_records` + `download_dataset_alternative_export` )	api/datasets/1.0/<dataset_id>/records/download/
`analyze_records`	Requête d'analyse des enregistrements. Appelé par l'onglet Analyse pour ce jeu de données lorsqu'un utilisateur le manipule.	api/datasets/1.0/<dataset_id>/records/analyze/
`get_bbox_clusters`	Limites de la boîte d'encombrement	api/datasets/1.0/<dataset_id>/records/boundingbox/
`get_geo_clusters`	Cluster géographique. Appelé par l'onglet Carte dans votre portail pour un point géographique	api/datasets/1.0/<dataset_id>/records/geocluster/
`get_geo_clusters_polygon`	Polygone de clusters géographiques. Appelé par l'onglet Carte de votre portail pour les formes	api/datasets/1.0/<dataset_id>/records/geopolygon/
`get_geoshapes_preview`	Prévisualiser une géoforme	api/datasets/1.0/<dataset_id>/records/geopreview/
`download_image`	Télécharger l'image. Appelé par l'onglet Images de ce jeu de données dans votre portail	explore/dataset/<dataset_id>/images/<image_id>/download/
`images`	Accéder aux images via l'API	api/datasets/1.0/<dataset_id>/images/<image_id>/, api/datasets/1.0/<dataset_id>/images/<image_id>/<thumbnail_size>
`files`	Accéder aux fichiers via l'API	api/datasets/1.0/<dataset_id>/files/<file_id>/, api/datasets/1.0/<dataset_id>/files/<file_id>/<thumbnail_size>
`list_dataset_entry_points`	Lister les points d'entrée disponibles pour un proxy d'API	api/datasets/1.0/<dataset_id>/services/
`metadata_templates`	Lister les modèles de métadonnées via l'API	api/metadata/1.0/<template_type>/, api/metadata/1.0/<template_type>/<template_name>/
`feed_dataset`	Accéder aux API feeds (Atom, RSS)	explore/dataset/<dataset_id>/<feed_type>/
`get_clusters_envelopes`	Visualisations de cartes	api/datasets/1.0/<dataset_id>/records/clusters_envelopes/
`apiproxy_dataset_metadata`	Requêtes sur API proxy pour requêter les metadatas des datasets	service/<dataset_id>/

Les pièces jointes font référence aux documents joints disponibles dans l'onglet Informations. Les champs de fichiers font référence aux fichiers (par exemple des images) dans les enregistrements du jeu de données. Ces deux types d'éléments sont comptabilisés séparément dans le monitoring.

Valeurs correspondant aux types d'API ods_v2, ods_v2.0, et ods_v2.1

Ce sont les valeurs sous le champ "api", et qui correspondent aux valeurs "api_type" ods_v1, ods_v2.0, et ods_v2.1. Ces valeurs correspondent à notre API Explore v2, qui est utilisée pour interagir avec les portails Opendatasoft.

Nom de l'API	La description	Modèle d'URL
`api_root`	Appel à la racine de l'API v2	/v2
`api_source`	Appel au chemin source (catalogue, monitoring, opendatasoft)	/v2/<source>
`datasets_index`	Recherche dans le catalogue des jeux de données (peut être un export si le paramètre `export_as` est utilisé)	/v2/<source>/datasets
`dataset_lookup`	Récupération des informations d'un dataset identifié	/v2/<source>/datasets/<dataset_id>
`aggregate_datasets`	Aggrégation du catalogue	/v2/<source>/agrégats
`records_index`	Rechercher sur les enregistrements de jeu de données (peut être un export si le paramètre "export as" est utilisé)	/v2/<source>/datasets/<dataset_id>/enregistrements
`record_lookup`	Récupération d'un enregistrement identifié	/v2/<source>/datasets/<dataset_id>/records/<record_id>
`aggregate_records`	Aggrégation sur les enregistrements d'un jeu de données	/v2/<source>/datasets/<dataset_id>/aggregates
`attachments_index`	Appel des pièces jointes du jeu de données	/v2/<source>/datasets/<dataset_id>/attachments
`attachment_lookup`	Appel de récupération d'une pièce jointe	/v2/<source>/datasets/<dataset_id>/attachments/<attachment_id>
`metadata_template_types_index`	Renvoyer les types de modèles de métadonnées	/v2/<source>/metadata_templates
`metadata_template_type_lookup`	Récupérer le type de modèle de métadonnées	/v2/<source>/metadata_templates/<template_type>
`metadata_template_lookup`	Récupération du modèle de métadonnées	/v2/<source>/metadata_templates/<template_type>/<template_name>
`remote_redirect`	Appels qui solicitent la fédération. Ils sont générés lorsque le jeu de données fédéré transfert les appels d'API vers le jeu de donnée source.	remote/<path>
`export_dataset`	Export des enregistrements d'un dataset. Équivalent à `download_dataset` en APIv1	/v2/<source>/datasets/<dataset_id>/exports/<export_format>/
`export_catalog`	Export calalog	/v2/<source>/exports/<export_format>/
`records_facets`	Appels qui sollicitent les facets sur les enregistrements	/v2/<source>/datasets/<dataset_id>/facets/
`export_dataset_root`	Récupération des exports disponibles pour un dataset	/v2/<source>/datasets/<dataset_id>/exports/
`export_catalog_root`	Récupération des exports disponibles	/v2/<source>/exports/

Valeurs correspondant au type d'API odata

Ce sont les valeurs sous le champ "api", et qui correspondent au "api_type" odata. Celles-ci correspondent à notre API Explore v2, qui est utilisée pour interagir avec les portails Opendatasoft.

Nom de l'API	Description	Modèle d'URL
`odata_service_root_doc`	Racine de l'API ODATA	api/odata/
`odata_entity`	Liste des enregistrements dans un jeu de données	api/odata/<dataset_id>/
`odata_property_value`	Valeur texte d'un champ spécifique d'un enregistrement spécifique d'un jeu de données	api/odata/<dataset_id>('<record_id>')/<field>/$value
`odata_entity_key_predicate`	Enregistrement spécifique d'un jeu de données	api/odata/<dataset_id>('<record_id>')/
`record_with_id`	Enregistrement spécifique d'un jeu de données (sans guillemet dans l'appel API)	api/odata/<dataset_id>(<record_id>)/
`odata_metadata_doc`	Appel de métadonnées	api/odata/$metadata/
`odata_record_count`	Nombre d'enregistrements dans un jeu de données	api/odata/<dataset_id>/$count/

Valeurs sous la colonne custom_attributes

Un en-tête personnalisé « ODS-API-Statistiques-App » peut être envoyé avec la requête HTTP. La valeur d'en-tête est traitée par notre couche de surveillance et mise à disposition dans le champ « custom_attributes ».

Le champ "type d'embed" décrit le type d'embed qui a généré la requête, le cas échéant.

Type d'intégration	Description
`APP/cartograph`	Cartographie intégrée
`APP/chartbuilder`	Intégration avancée de graphiques
`explore-analyze`	Intégration de l'onglet Analyse
`explore-map`	Intégration de l'onglet Carte
`explore-table`	Intégration de l'onglet Tableau
`explore-images`	Onglet Images intégré

Valeurs sous la colonne "error"

Ce sont les valeurs sous le champ "error" dans l'ensemble de données ods-api-monitoring.

Ces valeurs indiquent différentes erreurs qui peuvent se produire lors des requêtes API à la plateforme, par exemple lorsque vous interrogez un champ inexistant dans un jeu de données ou qu'il manque un paramètre dans la requête.

Error (cliquez sur chacun pour voir un exemple)	Description
`ODSQLSyntaxError`	Une erreur de syntaxe dans le langage ODSQL (un mot clé inexistant, une virgule mal placée, etc.).
`InvalidRESTParameterError` Exemple 1, exemple 2	Un paramètre de la requête contient une erreur.
`UnknownDatasetError`	Une erreur de l'API v1 lorsqu'un jeu de données n'existe pas.
`NotFoundResource`	Une erreur de l'API v2.x lorsqu'un jeu de données n'existe pas.
`IncompatibleTypesInComparisonFilter`	Une erreur dans une clause WHERE, lorsque les deux éléments comparés ne sont pas du même type. Le cas le plus fréquent concerne les dates, où une chaîne est passée sans le mot-clé date qui la précède.
`InvalidQueryError`	Une erreur de l'API v1 lorsqu'une erreur est détectée sur la requête.
`ODSQLError`	Erreur qui se produit lorsque la requête ODSQL n'est pas correctement formée.
`InvalidExportFormat`	Une erreur lors de l'utilisation export de point de terminaison et le format demandé n'existe pas.
`UnknownSortField`	Une erreur de l'API v1 lorsqu'un champ est inconnu dans la clause de tri.
`MissingParameterError`	Erreur utilisée dans certains cas dans l'API v2.1, comme pour les facettes. Correspond à un paramètre manquant dans la requête REST.