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

Updated info on sorting by date #60

Merged
merged 1 commit into from
Feb 21, 2020
Merged
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
9 changes: 6 additions & 3 deletions Search_API.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -267,15 +267,17 @@
"Filters the list of search results. The syntax is the same as that for the `q` parameter. Adding search parameters via the `fq` parameter can speed up search results, as it searches only the results returned by the search entered via the `q` parameter, not the entire index. This parameter may be used more than once in a single search URL.\n",
"\n",
"#### sort\n",
"The sorting field and direction to be used when returning results. The format requires both the field to sort on (see [the list below](#fields) and the direction, either `asc` or `desc` (ascending or descending). For example, an appropriately formatted sort parameter is `sort=citation_count+desc`. The default sort method is the relevancy score as calculated by the search engine. Other useful fields to sort on may be `pubdate`, `read_count`, `first_author`, or `bibcode`."
"The sorting field and direction to be used when returning results. The format requires both the field to sort on (see [the list below](#fields) and the direction, either `asc` or `desc` (ascending or descending). For example, an appropriately formatted sort parameter is `sort=citation_count+desc`. The default sort method is the relevancy score as calculated by the search engine. Other useful fields to sort on may be `date`, `read_count`, `first_author`, or `bibcode`."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Fields\n",
"This is a non-exhaustive list of fields available for searching via the API. A more comprehensive list is available in our [help pages](https://adsabs.github.io/help/search/comprehensive-solr-term-list). These fields can be used with the `fl` and `sort` parameters.\n",
"This is a non-exhaustive list of fields available for searching via the API. A more comprehensive list is available in our [help pages](https://adsabs.github.io/help/search/comprehensive-solr-term-list). These fields can be used with the `fl` and `sort` parameters. \n",
"\n",
"Note: some fields, such as body, can be searched but not returned via `fl` or sorted on. Also, multivalued fields, such as author, cannot be used for sorting.\n",
"\n",
"* `abstract` - the abstract of the record\n",
"* `ack` - the acknowledgements section of an article\n",
Expand All @@ -291,6 +293,7 @@
"* `citation_count` - number of citations the item has received\n",
"* `copyright` - the copyright applied to the article\n",
"* `data` - the list of sources that have data related to this bibcode\n",
"* `date` - the machine-readable version of `pubdate`, useful for sorting\n",
"* `database` - database the record is associated with (astronomy, physics, or general). By default, all three databases are searched; to limit to astronomy articles, add `fq=database:astronomy` to the URL\n",
"* `doi`- the digital object identifier of the article\n",
"* `doctype` - the type of document it is (see [here](https://adsabs.github.io/help/search/search-syntax) for a list of doctypes)\n",
Expand All @@ -308,7 +311,7 @@
"* `page` - starting page\n",
"* `property` - an array of miscellaneous flags associated with the record (see [here](https://adsabs.github.io/help/search/search-syntax) for a list of properties\n",
"* `pub` - the canonical name of the publication the record appeared in\n",
"* `pubdate` - publication date in the form YYYY-MM-DD (DD value will always be \"00\")\n",
"* `pubdate` - publication date in the form YYYY-MM-DD (DD value will always be \"00\"). This field is stored as a human-readable string, so is useful for being returned via `fl`, but not for sorting (see `date`)\n",
"* `read_count` - number of times the record has been viewed within in a 90-day windows (ads and arxiv)\n",
"* `title` - the title of the record\n",
"* `vizier` - the subject tags given to the article by VizieR\n",
Expand Down