You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`filter={filter_name}:{value}`| filter results by specific fields |
184
185
|`rows={#}`| results per per page |
185
-
|`offset={#}`| result offset |
186
+
|`offset={#}`(mak 10k)| result offset (user `cursor` for larger `/works` result sets) |
186
187
|`sample={#}`| return random N results |
187
188
|`sort={#}`| sort results by a certain field |
188
189
|`order={#}`| set the sort order to `asc` or `desc`|
189
190
|`facet=t`| enable facet information in responses |
191
+
|`cursor={#}`| deep page through `/works` result sets |
190
192
191
193
Multiple filters can be specified by separating name:value pairs with a comma:
192
194
@@ -351,7 +353,7 @@ every time there is a change to metadata requiring a reindex.
351
353
352
354
## Result controls
353
355
354
-
You can control the delivery and selection results using the `rows`, `offset` and `sample` parameters.
356
+
You can control the delivery and selection results using the `rows`, `offset` and `sample` parameters. If you are expecting results beyond 10K, then use a `cursor` to deep page through the results.
355
357
356
358
### Rows
357
359
@@ -371,6 +373,8 @@ The number of returned items is controlled by the `rows` parameter, but you can
Offsets for `/works` are limited to 10K. Use `cursor` (see below) for larger `/works` results sets.
377
+
374
378
### Deep Paging with Cursors
375
379
376
380
Using large `offset` values can result in extremely long response times. Offsets in the 100,000s and beyond will likely cause a timeout before the API is able to respond. An alternative to paging through very large result sets (like a corpus used for text and data mining) it to use the API's exposure of Solr's deep paging cursors. Any combination of query, filters and facets may be used with deep paging cursors. While `rows` may be specified along with `cursor`, `offset` and `sample` cannot be used. To use deep paging make a query as normal, but include the `cursor` parameter with a value of `*`. In this example we will page through all `journal-article` works from member `311`:
0 commit comments