Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document how to search date ranges via API #2291 #6264

Merged
merged 1 commit into from
Oct 10, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions doc/sphinx-guides/source/api/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~

Expand Down
9 changes: 9 additions & 0 deletions doc/sphinx-guides/source/api/search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down