data.gouv.fr harvester

Edited

This page is about harvesting data from data.gouv.fr to an Huwise platform.

To learn how to harvest data from Huwise to data.gouv.fr please visit the article Reference your datasets on data.gouv.fr.

This harvester is not available by default. Please contact Huwise for its activation.

Parameters

Name

Description

Examples

Organization ID (organization_id)

The identifier of the organization you want to harvest.

You can find the identifier for a specific organization as follows:

  1. Go to https://www.data.gouv.fr/en/organizations/

  2. Search for an organization

  3. Click on the desired result to open it

  4. On the desired organization page, you'll find the ID under the "Informations techniques" section

534fff75a3a7292c64a77de4 is the identifier for etalab

Filter parameter name (filter_name)

The name of the parameter you want to pass to the data.gouv.fr API to filter the request that will be performed:

  • tag is used to filter datasets associated with a specific keyword

  • license is used to filter datasets published under a specific license

  • temporal_coverage is used to filter datasets with data covering a specific period

  • geozone is used to filter datasets with data covering a specific geographical area

  • granularity is used to filter datasets with a specific territorial coverage granularity

  • format is used to filter datasets published under a specific format

temporal_coverage

Filter parameter value (filter_value)

The value of the filter parameter.

The value for some filter parameters has a very specific syntax. When performing a search on data.gouv.fr, the URL is of the form data.gouv.fr/en/datasets/?[filter_name]=[filter_value]. You can retrieve the values from the URL to set your harvester.

2020-01-01-2020-12-31 is the value for temporal_coverage if you want to filter datasets covering the period starting from 01 January 2020 to 31 December 2020

Generate attachment (attachment)

Select this checkbox to attach resources as attachments instead of using them as sources.

Metadata

The harvester fills in the following metadata for each dataset it imports from data.gouv.fr.

These mappings are fixed and can't be changed. Technical IDs are provided for those working with the APIs.

data.gouv.fr source

data.gouv.fr source in the API

Huwise metadata

Huwise field ID in the API

The dataset's title

dataset.title

Title

default.title

The dataset's description

dataset.description

Description

default.description

The dataset's tags

dataset.tags

Keywords

default.keyword

The dataset's license. The code fr-lo becomes "Licence Ouverte (Etalab)"

dataset.license

License

default.license

The address of the dataset's page on data.gouv.fr

dataset.page

Reference

default.references

The name of the organization that publishes the dataset

dataset.organization.name

Creator

default.publisher