From 21e7597e34bf179fa2907adf0bc667a2e716369e Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Wed, 9 Oct 2019 10:57:50 -0400 Subject: [PATCH] document how to search date ranges via API #2291 --- doc/sphinx-guides/source/api/getting-started.rst | 7 +++++++ doc/sphinx-guides/source/api/search.rst | 9 +++++++++ 2 files changed, 16 insertions(+) diff --git a/doc/sphinx-guides/source/api/getting-started.rst b/doc/sphinx-guides/source/api/getting-started.rst index c0d6515dc64..3c9bfd9b137 100644 --- a/doc/sphinx-guides/source/api/getting-started.rst +++ b/doc/sphinx-guides/source/api/getting-started.rst @@ -94,6 +94,13 @@ A quick example search for the word "data" is https://demo.dataverse.org/api/sea See the :doc:`search` section for details. +Finding Recently Published Dataverses, Datasets, and Files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +See :ref:`search-date-range`. + +It's also possible to find recently published datasets via OAI-PMH. + Downloading Files ~~~~~~~~~~~~~~~~~ diff --git a/doc/sphinx-guides/source/api/search.rst b/doc/sphinx-guides/source/api/search.rst index ff2da576577..fdca7074261 100755 --- a/doc/sphinx-guides/source/api/search.rst +++ b/doc/sphinx-guides/source/api/search.rst @@ -222,6 +222,15 @@ In this example, ``show_relevance=true`` matches per field are shown. Available } } +.. _search-date-range: + +Date Range Search Example +------------------------- + +Below is an example of searching across a date range of dataverses, datasets, and files that were published in 2018. + +`https://demo.dataverse.org/api/search?q=*&per_page=1000&sort=date&order=asc&q=*&fq=dateSort:[2018-01-01T00\:00\:00Z+TO+2019-01-01T00\:00\:00Z] `_ + .. _iteration-example: Iteration