How can I include facets in API requests?

If you are using the DataCite REST API /dois endpoint for querying DOI metadata or harvesting DOI metadata records, you can choose whether to include facets in the response.

Facets are aggregations about the results, e.g., resourceTypes, created date, and affiliations. To optimize querying, facets are not included by default.

To retrieve facets, requests must include the URL parameter disable-facets=false

For example, this query retrieves DOIs with the resourceTypeGeneral:Software and includes facets in the results:

https://api.datacite.org/dois?resource-type-id=software&disable-facets=false

Use the facets to see aggregated information, e.g., the top ten DataCite Members or Consortium Organizations publishing the most software DOIs:

Facet included in the REST API Results — Facet in the REST API Results

Note: The meta attribute of the DataCite REST API /dois endpoint previously displayed facets by default.

Learn more about these changes