Detail about specific fields in the ods-api-monitoring dataset
You can use the datasets available on your Analytics pages to monitor and analyze how your workspaces and your datasets are used. See Monitoring your workspaces for more general information about the available datasets and where to find them.
This page details some of the specific field values you're likely to use to analyze your data. For an example of one common usage, see this page.
Field values in the ods-api-monitoring dataset
In the ods-api-monitoring dataset, two columns—"api_type" and "api"—record values that can help you analyze how your data is being used.
Under "api_type" you can find the following API types, which correspond to the APIs you can use with Opendatsoft: ods_v1, ods_v2, ods_v2.0, ods_v2.1, odata, wfs, csw, and tpf.
Values corresponding to the ods_v1 API type
These are the values under the "api" field, and that correspond to the "api_type" ods_v1. The ods_v1 type corresponds to our Search API v1, which can be used by our widgets or else called directly.
Value in the "api" field | Description | URL template |
| Search catalog query | api/datasets/1.0/search |
| Lookup dataset query | api/datasets/1.0/<dataset_id> |
| Download dataset records from the export tab | explore/dataset/<dataset_id>/download/ |
| Download dataset in an alternative export format | api/datasets/1.0/<dataset_id>/alternative_exports/<export_id>/ |
| Download dataset attachment from the information tab | api/datasets/1.0/<dataset_id>/attachments/<attachment_id>/ |
| List dataset snapshots | api/datasets/1.0/<dataset_id>/snapshots/ |
| Download a dataset snapshot | api/datasets/1.0/<dataset_id>/snapshots/<snapshot_id>/ |
| Search query on dataset records | api/datasets/1.0/<dataset_id>/records/ |
| Lookup record query | api/datasets/1.0/<dataset_id>/records/<record_id> |
| Download dataset records from API (total dataset download count = | api/datasets/1.0/<dataset_id>/records/download/ |
| Analyze records query. Called by Analyze tab in explore | api/datasets/1.0/<dataset_id>/records/analyze/ |
| Bounding box query. | api/datasets/1.0/<dataset_id>/records/boundingbox/ |
| Geo cluster query. Called by map tab in explore for geo_point | api/datasets/1.0/<dataset_id>/records/geocluster/ |
| Geo clusters polygon query. Called by map tab in explore for shapes | api/datasets/1.0/<dataset_id>/records/geopolygon/ |
| Preview a geoshape | api/datasets/1.0/<dataset_id>/records/geopreview/ |
| Download image. Called by image tab in explore | explore/dataset/<dataset_id>/images/<image_id>/download/ |
| Access images through the API | api/datasets/1.0/<dataset_id>/images/<image_id>/, api/datasets/1.0/<dataset_id>/images/<image_id>/<thumbnail_size> |
| Access files through the API | api/datasets/1.0/<dataset_id>/files/<file_id>/, api/datasets/1.0/<dataset_id>/files/<file_id>/<thumbnail_size> |
| List available entry points for an API Proxy | api/datasets/1.0/<dataset_id>/services/ |
| List metadata templates via the API | api/metadata/1.0/<template_type>/, api/metadata/1.0/<template_type>/<template_name>/ |
| API feeds (Atom, RSS) | explore/dataset/<dataset_id>/<feed_type>/ |
| Map visualisation calls | api/datasets/1.0/<dataset_id>/records/clusters_envelopes/ |
| Datasets metadatas query using API proxy | service/<dataset_id>/ |
Attachments refers to the attached documents available in the Information tab. File fields refers to the files (for example images) within the records of the dataset. Both are counted separately in the monitoring.
Values corresponding to the ods_v2, ods_v2.0, and ods_v2.1 API types
These are the values under the "api" field, and that correspond to the "api_type" values ods_v1, ods_v2.0, and ods_v2.1. These correspond to our Explore API v2, which is used to interact with Opendatasoft portals.
API name | Description | URL template |
| Call to API v2 root | /v2 |
| Call to source path (catalog, monitoring, opendatasoft) | /v2/<source> |
| Search on datasets catalog (can be an export if | /v2/<source>/datasets |
| Dataset lookup call | /v2/<source>/datasets/<dataset_id> |
| Aggregation call on catalog | /v2/<source>/aggregates |
| Search on dataset records (can be an export if | /v2/<source>/datasets/<dataset_id>/records |
| Record lookup call | /v2/<source>/datasets/<dataset_id>/records/<record_id> |
| Aggregation call on dataset records | /v2/<source>/datasets/<dataset_id>/aggregates |
| Call to dataset attachments | /v2/<source>/datasets/<dataset_id>/attachments |
| Call to attachment lookup | /v2/<source>/datasets/<dataset_id>/attachments/<attachment_id> |
| Return metadata template types | /v2/<source>/metadata_templates |
| Metadata template type lookup | /v2/<source>/metadata_templates/<template_type> |
| Metadata template lookup | /v2/<source>/metadata_templates/<template_type>/<template_name> |
| Calls that solicit federations. They are generated when federated dataset transfers API calls to the source dataset. | remote/<path> |
| Call to export dataset records. Equivalent to | /v2/<source>/datasets/<dataset_id>/exports/<export_format>/ |
| Call to export catalog | /v2/<source>/exports/<export_format>/ |
| Call to facets on records | /v2/<source>/datasets/<dataset_id>/facets/ |
| Call to the list of available dataset exports | /v2/<source>/datasets/<dataset_id>/exports/ |
| Call to the list of available exports | /v2/<source>/exports/ |
Values corresponding to the odata API type
These are the values under the "api" field, and that correspond to the "api_type" odata. These correspond to our Explore API v2, which is used to interact with Opendatasoft portals.
API name | Description | URL template |
| Root ODATA API | api/odata/ |
| List of records in a dataset | api/odata/<dataset_id>/ |
| Plain text value of a specific field of a specific record from a dataset | api/odata/<dataset_id>('<record_id>')/<field>/$value |
| Specific record from a dataset | api/odata/<dataset_id>('<record_id>')/ |
| Specific record from a dataset (without quote in API call) | api/odata/<dataset_id>(<record_id>)/ |
| Metadata call | api/odata/$metadata/ |
| Number of records in a dataset | api/odata/<dataset_id>/$count/ |
Values under the "custom_attributes" column
A custom header "ODS-API-Analytics-App" can be sent along with the HTTP request. The header value is processed by our monitoring layer and made available in the field "custom_attributes."
The "embed type" field describes the type of embed which generated the query, when relevant.
Embed type | Description |
| Cartograph embed |
| Advanced chart embed |
| Analyze tab embed |
| Map tab embed |
| Table tab embed |
| Images tab embed |
Values under the "error" column
These are the values under the "error" field In the ods-api-monitoring dataset.
These values indicate different errors that may occur when making API requests to the platform, such as when you query a non-existent field in a dataset or are missing a parameter in the query.
Error (click each to see an example) | Description |
| A syntax error in the ODSQL language (a non-existent keyword, a misplaced comma, etc.). |
| A parameter in the request contains an error. |
| An error from the API v1 for when a dataset does not exist. |
| An error from the API v2.x for when a dataset does not exist. |
| An error in a WHERE clause, when the two elements being compared are not of the same type. The most frequent case is for dates, where a string is passed without the date keyword preceding it. |
| An error from the API v1 for when an error is detected on the request. |
| An error that occurs when the ODSQL query is incorrectly formed. |
| An error when using endpoint exports and the requested format does not exist. |
| An error from the API v1 for when a field is unknown in the sort clause. |
| An error used in certain cases in API v2.1, such as for facets. Corresponds to a missing parameter in the REST query. |