Merge pull request #6264 from IQSS/2291-search-date-range

document how to search date ranges via API #2291
IQSS · Oct 10, 2019 · 8991919 · 8991919
2 parents 67da504 + 21e7597
commit 8991919
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git 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
@@ -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] <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