Analyser les données source¶
Vous trouverez ci-dessous la liste des champs disponibles dans le jeu de données du monitoring d'API.
Nom du champ |
Description du champ |
Facette |
|---|---|---|
timestamp |
Date/heure de l'évènement |
non |
user_ip_addr |
Adresse IP distante |
non |
hostname |
Nom d'hôte de la requête HTTP |
oui |
user_id |
Identifiant de l'utilisateur |
oui |
dataset_id |
Identifiant du jeu de données |
oui |
domain_id |
Identifiant du domaine |
oui |
api |
Nom de l'API (voir plus bas) |
oui |
api_type |
type d'API (ods_v1, ods_v2 ou odata) |
oui |
query_string |
"Query string" (paramètres) de la requête HTTP |
non |
custom_attributes |
En-têtes personnalisés de la requête HTTP (voir plus bas) |
oui |
format |
Format de la réponse HTTP |
oui |
size_res |
Taille de la réponse |
non |
nhits |
Nombre de résultats |
non |
exec_time |
Temps de traitement complet |
non |
request_aborted |
Si la requête a été interrompue |
oui |
facet |
Liste des facettes utilisées |
oui |
in_error |
Si la requête a généré une erreur |
oui |
error |
Message d'erreur |
non |
attachment_id |
Identifiant de l'attachement |
non |
image_id |
Identifiant de l'image |
non |
user_agent |
"User agent" de la requête HTTP |
non |
referer |
"Referer" (origine) de la requête HTTP |
non |
embed_type |
Type d'intégration (voir plus bas) |
non |
embed_referer |
"Referer" (origine) de l'embed |
non |
geo_coordinates |
Coordonnées géographiques (geoip sur le champ user_ip_addr) |
non |
query_field |
Liste des champs utilisés dans une requête textuelle |
non |
query_text |
Texte libre dans une requête textuelle |
non |
bot |
Si la requête provenait d'un robot |
oui |
noms d'API pour Opendatasoft APIv1¶
Le champ api pour Opendatasoft APIv1 (ods_v1) contient une des valeurs suivantes.
Nom de l'API |
Description | Template d'URL |
|---|---|---|
search_datasets |
Rechercher dans le catalogue |
api/datasets/1.0/search |
lookup_dataset |
Récuperer un jeu de données |
api/datasets/1.0/<dataset_id> |
download_dataset |
Télécharger les enregistrements du jeu de données 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 dataset |
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 de l'API (nb de téléchargements total = dowload_dataset + download_dataset_records) |
api/datasets/1.0/<dataset_id>/records/download/ |
analyze_records |
Analyser les enregistrements. Appelé par l'onglet analyse dans Explorer |
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 Explorer 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 dans Explorer pour les formes |
api/datasets/1.0/<dataset_id>/records/geopolygon/ |
get_geoshapes_preview |
Afficher l'aperçu d'une forme géo |
api/datasets/1.0/<dataset_id>/records/geopreview/ |
download_image |
Télécharger image. Appelé par l'onglet image dans Explorer |
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étadatas via l'API |
api/metadata/1.0/<template_type>/, api/metadata/1.0/<template_type>/<template_name>/ |
Remarque
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.
Les noms API pour l'API ODATA¶
Le champ api pour ODATA API contient une des valeurs suivantes.
Nom de l'API |
Description | Template d'URL |
|---|---|---|
odata_service_root_doc |
Racine de l'API ODATA |
api/odata/ |
odata_entity |
liste des enregistrements dans un dataset |
api/odata/<dataset_id>/ |
odata_property_value |
valeur texte d'un champ spécifique d'un enregistrement spécifique d'un jeux de données |
api/odata/<dataset_id>('<record_id>')/<field>/$value |
odata_entity_key_predicate |
enregistrement spécifique d'un dataset |
api/odata/<dataset_id>('<record_id>')/ |
record_with_id |
enregistrement spécifique d'un jeu de données (sans guillements dans l'appel API) |
api/odata/<dataset_id>(<record_id>)/ |
odata_metadata_doc |
Appel de métadatas |
api/odata/$metadata/ |
odata_record_count |
Nombre d'enregistrements dans un jeu de données |
api/odata/<dataset_id>/$count/ |
Les noms d'API pour Opendatasoft APIv2¶
Le champ api pour Opendatasoft APIv2 (ods_v2) contient une des valeurs suivantes.
Nom de l'API |
Description | Template d'URL |
|---|---|---|
api_root |
Appel à la racine de l'API V2 |
/v2 |
api_source |
Appel au chemin de la source (catalogue, monitoring, opendatasoft) |
/v2/<source> |
datasets_index |
Rechercher sur 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>/aggregates |
records_index |
Rechercher sur les enregistrements des jeux de données (peut être un export si le paramètre "export as" est utilisé) |
/v2/<source>/datasets/<dataset_id>/records |
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 metadatas |
/v2/<source>/metadata_templates |
metadata_template_type_lookup |
Récupérer le type de modèle de métadatas |
/v2/<source>/metadata_templates/<template_type> |
metadata_template_lookup |
Récupération du modèle de métadatas |
/v2/<source>/metadata_templates/<template_type>/<template_name> |
Un en-tête personnalisé ODS-API-Analytics-App peut être envoyé avec la requête HTTP. La valeur de l'en-tête est stockée et disponible via le champ custom_attributes.
Le champ embed_type décrit le type d'intégration à l'origine de la requête, si c'est le cas.
Type d'intégration |
Description |
|---|---|
cartograph |
Intégration de Cartographe |
chartbuilder |
Intégration d'un graphique avancé |
explore-analyze |
Intégration de l'onglet analyse de l'interface d'exploration |
explore-map |
Intégration de l'onglet carte de l'interface d'exploration |
explore-table |
Intégration de l'onglet tableau de l'interface d'exploration |
explore-images |
Intégration de l'onglet images de l'interface d'exploration |