Analysieren von Quelldaten¶
Nachfolgend sind die im API-Überwachungsdatensatz verfügbaren Felder aufgelistet.
Feldname |
Feldbeschreibung |
Facet |
|---|---|---|
timestamp |
Zeitstempel eines Ereignisses |
nein |
user_ip_addr |
Remote IP-Adresse |
nein |
hostname |
Hostname HTTP-Anforderung |
ja |
user_id |
Benutzerbezeichner |
ja |
dataset_id |
Datensatzbezeichner |
ja |
domain_id |
Domainbezeichner |
ja |
api |
API-Name (siehe weiter unten) |
ja |
api_type |
API-Typ (ods_v1, ods_v2 oder odata) |
ja |
query_string |
Anfragezeichenfolge HTTP-Anforderung |
nein |
custom_attributes |
Benutzerdefinierte HTTP-Anforderungs-Header (siehe weiter unten) |
ja |
format |
Format HTTP-Antwort |
ja |
size_res |
Antwortinhaltsgröße |
nein |
nhits |
Anzahl der Ergebnisse |
nein |
exec_time |
Vollständige Verarbeitungsdauer |
nein |
request_aborted |
Bei Abbruch der Anforderung |
ja |
facet |
Liste der angewandten Facets |
ja |
in_error |
Bei Generierung eines Fehlers durch die Verarbeitung der Anforderung |
ja |
error |
Fehlermeldung |
nein |
attachment_id |
Anhangbezeichner |
nein |
image_id |
Bildbezeichner |
nein |
user_agent |
Benutzeragent HTTP-Anforderung |
nein |
referer |
Referrer HTTP-Anforderung |
nein |
embed_type |
Einbettungstyp (siehe weiter unten) |
nein |
embed_referer |
Einbettung Referrer |
nein |
geo_coordinates |
Geokoordinaten (Geoip im Feld user_ip_addr) |
nein |
query_field |
Liste der in einer Volltextanfrage verwendeten Felder |
nein |
query_text |
Freier Text in einer Volltextanfrage |
nein |
bot |
Bei Verwendung der Anfrage durch einen Bot |
ja |
API-Namen für Opendatasoft-APIv1¶
Das Feld API für Opendatasoft-APIv1 (ods_v1) enthält einen der beiden folgenden Werte.
API-Name |
Beschreibung |
URL-Vorlage |
|---|---|---|
search_datasets |
Anfrage Katalogsuche |
api/datasets/1.0/search |
lookup_dataset |
Anfrage Datensatz nachschlagen |
api/datasets/1.0/<dataset_id> |
download_dataset |
Datensatzeinträge aus dem Register Exportieren herunterladen |
explore/dataset/<dataset_id>/download/ |
download_dataset_alternative_export |
Datensatz in einem alternativen Exportformat herunterladen |
api/datasets/1.0/<dataset_id>/alternative_exports/<export_id>/ |
download_dataset_attachment |
Datensatzanhang aus dem Informationsregister herunterladen |
api/datasets/1.0/<dataset_id>/attachments/<attachment_id>/ |
dataset_list_snapshots |
Datensatzmomentaufnahmen auflisten |
api/datasets/1.0/<dataset_id>/snapshots/ |
dataset_download_snapshot |
Eine Datensatzmomentaufnahme herunterladen |
api/datasets/1.0/<dataset_id>/snapshots/<snapshot_id>/ |
search_dataset_records |
Suchanfrage für Datensatzeinträge |
api/datasets/1.0/<dataset_id>/records/ |
lookup_record |
Anfrage Eintrag nachschlagen |
api/datasets/1.0/<dataset_id>/records/<record_id> |
download_dataset_records |
Datensatzeinträge von API herunterladen (Gesamtzählung Datensatzdownload = dowload_dataset + download_dataset_records) |
api/datasets/1.0/<dataset_id>/records/download/ |
analyze_records |
Anfrage Einträge analysieren. Aufruf über Register Analyse in Untersuchen |
api/datasets/1.0/<dataset_id>/records/analyze/ |
get_bbox_clusters |
Abfrage Begrenzungsrahmen. |
api/datasets/1.0/<dataset_id>/records/boundingbox/ |
get_geo_clusters |
Anfrage Geo-Cluster. Aufruf über Register Karte in Untersuchen für geo_point |
api/datasets/1.0/<dataset_id>/records/geocluster/ |
get_geo_clusters_polygon |
Anfrage Polygon Geo-Cluster. Aufruf über Register Karte in Untersuchen für Formen |
api/datasets/1.0/<dataset_id>/records/geopolygon/ |
get_geoshapes_preview |
Vorschau einer Geoform |
api/datasets/1.0/<dataset_id>/records/geopreview/ |
download_image |
Bild herunterladen. Aufruf über Register Bild in Untersuchen |
explore/dataset/<dataset_id>/images/<image_id>/download/ |
images |
Durch die API auf Bilder zugreifen |
api/datasets/1.0/<dataset_id>/images/<image_id>/, api/datasets/1.0/<dataset_id>/images/<image_id>/<thumbnail_size> |
files |
Durch die API auf Dateien zugreifen |
api/datasets/1.0/<dataset_id>/files/<file_id>/, api/datasets/1.0/<dataset_id>/files/<file_id>/<thumbnail_size> |
list_dataset_entry_points |
Verfügbare Einstiegspunkte für einen API-Proxy auflisten |
api/datasets/1.0/<dataset_id>/services/ |
metadata_templates |
Metadaten-Vorlagen über die API auflisten |
api/metadata/1.0/<template_type>/, api/metadata/1.0/<template_type>/<template_name>/ |
API-Namen für ODATA-API¶
Das Feld API für ODATA-API enthält einen der beiden folgenden Werte.
API-Name |
Beschreibung |
URL-Vorlage |
|---|---|---|
odata_service_root_doc |
Stamm ODATA-API |
api/odata/ |
odata_entity |
Liste der Einträge in einem Datensatz |
api/odata/<dataset_id>/ |
odata_property_value |
Nur-Textwert eines bestimmten Felds eines bestimmten Eintrags eines Datensatzes |
api/odata/<dataset_id>('<record_id>')/<field>/$value |
odata_entity_key_predicate |
bestimmter Eintrag eines Datensatzes |
api/odata/<dataset_id>('<record_id>')/ |
record_with_id |
bestimmter Eintrag eines Datensatzes (ohne Anführungszeichen in API-Aufruf) |
api/odata/<dataset_id>(<record_id>)/ |
odata_metadata_doc |
Metadatenaufruf |
api/odata/$metadata/ |
odata_record_count |
Anzahl an Einträgen in einem Datensatz |
api/odata/<dataset_id>/$count/ |
API-Namen für Opendatasoft-APIv2¶
Das Feld API für Opendatasoft-APIv2 (ods_v2) enthält einen der beiden folgenden Werte.
API-Name |
Beschreibung |
URL-Vorlage |
|---|---|---|
api_root |
Aufruf an API v2-Stamm |
/v2 |
api_source |
Aufruf an Quellpfad (Katalog, Überwachung, opendatasoft) |
/v2/<source> |
datasets_index |
Suche in Datensatzkatalog (kann bei Verwendung des Parameters |
/v2/<source>/datasets |
dataset_lookup |
Aufruf Datensatz nachschlagen |
/v2/<source>/datasets/<dataset_id> |
aggregate_datasets |
Aggregationsaufruf für Katalog |
/v2/<source>/aggregates |
records_index |
Suche in Datensatzeinträgen (kann bei Verwendung des Parameters |
/v2/<source>/datasets/<dataset_id>/records |
record_lookup |
Aufruf Eintrag nachschlagen |
/v2/<source>/datasets/<dataset_id>/records/<record_id> |
aggregate_records |
Aggregationsaufruf für Datensatzeinträge |
/v2/<source>/datasets/<dataset_id>/aggregates |
attachments_index |
Aufruf an Datensatzanhänge |
/v2/<source>/datasets/<dataset_id>/attachments |
attachment_lookup |
Aufruf an Anhangnachschlag |
/v2/<source>/datasets/<dataset_id>/attachments/<attachment_id> |
metadata_template_types_index |
Vorlagentypen Metadatenrückgabe |
/v2/<source>/metadata_templates |
metadata_template_type_lookup |
Metadatenvorlagentyp Nachschlagen |
/v2/<source>/metadata_templates/<template_type> |
metadata_template_lookup |
Metadatenvorlage Nachschlagen |
/v2/<source>/metadata_templates/<template_type>/<template_name> |
Mit der HTTP-Anforderung kann ein benutzerdefinierter Header ODS-API-Analytics-App gesendet werden. Der Header-Wert wird von unserer Überwachungsschicht verarbeitet und im Feld custom_attributes bereitgestellt.
Sofern relevant, beschreibt das Feld embed type den Typ der Einbettung, der die Anfrage generiert hat.
Einbettungstyp |
Beschreibung |
|---|---|
cartograph |
Einbettung Kartograf |
chartbuilder |
Einbettung erweitertes Diagramm |
explore-analyze |
Einbettung Register Analyse |
explore-map |
Einbettung Register Karte |
explore-table |
Einbettung Register Untersuchen |
explore-images |
Einbettung Register Bilder |