Skip to content

Commit 6758480

Browse files
committed
Add facet parameter info
1 parent 7d5c1b4 commit 6758480

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

funder_kpi_api.md

+7
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
- v14: 2014-02-14, new `has-funder` filter.
2020
- v15: 2014-02-27, new `/licenses` route
2121
- v16: 2014-05-19, new `/journals` route, new CrossMark (updates and update policy) filters, new `sort` and `order` parameters
22+
- v17: 2014-05-19, new `facet` query parameter
2223

2324
## Background
2425

@@ -155,6 +156,7 @@ Parameters can be used to query, filter and control the results returned by the
155156
| `sample={#}` | return random N results |
156157
| `sort={#}` | sort results by a certain field |
157158
| `order={#}` | set the sort order to `asc` or `desc` |
159+
| `facet=t` | enable facet information in responses |
158160

159161
Multiple filters can be specified by separating name:value pairs with a comma:
160162

@@ -202,6 +204,11 @@ An example that sorts results in order of publication, beginning with the least
202204

203205
http://api.crossref.org/works?query=josiah+carberry&sort=published&order=asc
204206

207+
## Facet Counts
208+
209+
Facet counts can be retrieved by enabling faceting; `facet=t` (or `1`, `true`). Facet counts
210+
give counts per field value for an entire result set.
211+
205212
## Filter Names
206213

207214
Filters allow you to narrow queries. All filter results are lists. The following filters are supported:

0 commit comments

Comments
 (0)