Source Data analyseren¶
Onderaan vindt u de lijst met beschikbare velden in de API opvolgingsdataset.
Veldnaam |
Veldomschrijving |
Facet |
|---|---|---|
timestamp |
Tijdstempel van het evenement |
nee |
user_ip_addr |
IP adres op afstand |
nee |
hostname |
Naam van de host van het HTTP-verzoek |
ja |
user_id |
Identifier van de gebruiker |
ja |
dataset_id |
Identifier van de dataset |
ja |
domain_id |
Identifier van het domein |
ja |
api |
Naam van de API (zie hieronder) |
ja |
api_type |
API type (ods_v1, ods_v2 of odata) |
ja |
query_string |
Opzoekstring van het HTTP-verzoek |
nee |
custom_attributes |
Aanpasbare header van het HTTP-verzoek (zie hieronder) |
ja |
format |
Formaat van de HTTP-respons |
ja |
size_res |
Grootte van de responsinhoud |
nee |
nhits |
Aantal resultaten |
nee |
exec_time |
Volledige verwerkingstijd |
nee |
request_aborted |
Wanneer het verzoek werd afgebroken |
ja |
facet |
Lijst met gebruikte facetten |
ja |
in_error |
Indien het verwerkingsverzoek een fout genereerde |
ja |
error |
Foutboodschap |
nee |
attachment_id |
Identifier van de bijlage |
nee |
image_id |
Identifier van de afbeelding |
nee |
user_agent |
Gebruikersagent van het HTTP-verzoek |
nee |
referer |
Referrer van het HTTP-verzoek |
nee |
embed_type |
Invoegtype (zie hieronder) |
nee |
embed_referer |
Invoeg referrer |
nee |
geo_coordinates |
Geografische coördinaten (geoip op veld user_ip_addr) |
nee |
query_field |
Lijst met velden die gebruikt worden in een zoekopdracht van een volledige tekst |
nee |
query_text |
Vrije tekst in een zoekopdracht van een volledige tekst |
nee |
bot |
Indien de zoekopdracht gebruikt werd door een bot |
ja |
API namen voor Opendatasoft APIv1¶
Het veld api voor Opendatasoft APIv1 (ods_v1) bevat één van de volgende waarden.
API-naam |
Omschrijving |
URL-template |
|---|---|---|
search_datasets |
Zoekopdracht in de zoekcatalogus |
api/datasets/1.0/search |
lookup_dataset |
Zoekopdracht in lookup-dataset |
api/datasets/1.0/<dataset_id> |
download_dataset |
Download dataset records vanuit het exporttabblad |
explore/dataset/<dataset_id>/download/ |
download_dataset_alternative_export |
Download dataset in een alternatief exportformaat |
api/datasets/1.0/<dataset_id>/alternative_exports/<export_id>/ |
download_dataset_attachment |
Download datasetbijlage vanuit het informatietabblad |
api/datasets/1.0/<dataset_id>/attachments/<attachment_id>/ |
dataset_list_snapshots |
Lijst dataset snapshots |
api/datasets/1.0/<dataset_id>/snapshots/ |
dataset_download_snapshot |
Download een dataset snapshot |
api/datasets/1.0/<dataset_id>/snapshots/<snapshot_id>/ |
search_dataset_records |
Zoek zoekopdracht op datasetrecords |
api/datasets/1.0/<dataset_id>/records/ |
lookup_record |
Zoekopdracht lookup-record |
api/datasets/1.0/<dataset_id>/records/<record_id> |
download_dataset_records |
Download datasetrecords uit API (totale telling datasetdownloads = dowload_dataset + download_dataset_records) |
api/datasets/1.0/<dataset_id>/records/download/ |
analyze_records |
Analyseer zoekopdracht records. Opgeroepen door tabblad "analyse" in explore |
api/datasets/1.0/<dataset_id>/records/analyze/ |
get_bbox_clusters |
Zoekopdracht bounding box. |
api/datasets/1.0/<dataset_id>/records/boundingbox/ |
get_geo_clusters |
Zoekopdracht geo cluster. Opgeroepen door tabblad "kaart" in explore voor geo_point |
api/datasets/1.0/<dataset_id>/records/geocluster/ |
get_geo_clusters_polygon |
Zoekopdracht geo clusters veelhoek. Opgeroepen door tabblad "kaart" in explore voor vormen |
api/datasets/1.0/<dataset_id>/records/geopolygon/ |
get_geoshapes_preview |
Preview een geoshape |
api/datasets/1.0/<dataset_id>/records/geopreview/ |
download_image |
Download afbeelding. Opgeroepen door tabblad "afbeelding" in explore |
explore/dataset/<dataset_id>/images/<image_id>/download/ |
images |
Toegang afbeeldingen via de API |
api/datasets/1.0/<dataset_id>/images/<image_id>/, api/datasets/1.0/<dataset_id>/images/<image_id>/<thumbnail_size> |
files |
Toegang bestanden via de 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 |
Lijst beschikbare ingangspunten voor een API Proxy |
api/datasets/1.0/<dataset_id>/services/ |
metadata_templates |
Lijst metadata templates via de API |
api/metadata/1.0/<template_type>/, api/metadata/1.0/<template_type>/<template_name>/ |
API-namen voor ODATA API¶
Het veld api voor ODATA API bevat één van de volgende waarden.
API-naam |
Omschrijving |
URL-template |
|---|---|---|
odata_service_root_doc |
Root ODATA API | api/odata/ |
odata_entity |
lijst van records in een dataset |
api/odata/<dataset_id>/ |
odata_property_value |
gewone tekstwaarde van een specifiek veld van een specifiek record uit een dataset |
api/odata/<dataset_id>('<record_id>')/<field>/$value |
odata_entity_key_predicate |
specifiek record uit een dataset |
api/odata/<dataset_id>('<record_id>')/ |
record_with_id |
specifiek record uit een dataset (zonder aanhalingsteken in API call) |
api/odata/<dataset_id>(<record_id>)/ |
odata_metadata_doc |
metadata call | api/odata/$metadata/ |
odata_record_count |
aantal records in een dataset |
api/odata/<dataset_id>/$count/ |
API-namen voor Opendatasoft APIv2¶
Het veld api voor Opendatasoft APIv2 (ods_v2) bevat één van de volgende waarden.
API-naam |
Omschrijving |
URL-template |
|---|---|---|
api_root |
Call naar API v2 root |
/v2 |
api_source |
Call naar bronpad (catalogus, opvolging, opendatasoft) |
/v2/<source> |
datasets_index |
Zoekopdracht op catalogus van datasets (kan een export zijn indien de parameter |
/v2/<source>/datasets |
dataset_lookup |
Dataset lookup call | /v2/<source>/datasets/<dataset_id> |
aggregate_datasets |
Aggregatie-call op catalogus |
/v2/<source>/aggregates |
records_index |
Zoekopdracht op datasetrecords (kan een export zijn indien de parameter |
/v2/<source>/datasets/<dataset_id>/records |
record_lookup |
Record lookup call | /v2/<source>/datasets/<dataset_id>/records/<record_id> |
aggregate_records |
Aggregatie-call op datasetrecords |
/v2/<source>/datasets/<dataset_id>/aggregates |
attachments_index |
Call naar datasetbijlagen |
/v2/<source>/datasets/<dataset_id>/attachments |
attachment_lookup |
Call naar bijlage-lookup |
/v2/<source>/datasets/<dataset_id>/attachments/<attachment_id> |
metadata_template_types_index |
Leveren metadata template types op |
/v2/<source>/metadata_templates |
metadata_template_type_lookup |
Metadata template type lookup | /v2/<source>/metadata_templates/<template_type> |
metadata_template_lookup |
Metadata template lookup | /v2/<source>/metadata_templates/<template_type>/<template_name> |
Een aanpasbare header ODS-API-Analytics-App kan worden gestuurd samen met het HTTP-verzoek. De waarde van de header wordt verwerkt door onze opvolgingslaag en beschikbaar gesteld in het veld custom_attributes.
Het veld invoegtype omschrijft het type embed dat de zoekopdracht genereerde, wanneer relevant.
Invoegtype |
Omschrijving |
|---|---|
cartograph |
Cartograaf embed |
chartbuilder |
Geavanceerde grafiek embed |
explore-analyze |
Analyseer tabblad embed |
explore-map |
Kaart tabblad embed |
explore-table |
Explore tabblad embed |
explore-images |
Afbeeldingen tabblad embed |