Skip to content

Commit b52fa40

Browse files
committed
add docs
1 parent f52ffd5 commit b52fa40

2 files changed

Lines changed: 5 additions & 0 deletions

File tree

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## API Enhancement
2+
API call to `/api/guestbooks/{dataverseAlias}/list` will now include `"usageCount":#` and `"responseCount":#` in the response.
3+
By adding the query param "ignoreStats=true" these values can be excluded for faster response.

doc/sphinx-guides/source/api/native-api.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1239,6 +1239,8 @@ The fully expanded example above (without environment variables) looks like this
12391239
12401240
curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" "https://demo.dataverse.org/api/guestbooks/root/list"
12411241
1242+
.. note:: By adding the query param "ignoreStats=true" `usageCount` and `responseCount` values can be excluded for faster response.
1243+
12421244
Get a Guestbook for a Dataverse Collection
12431245
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12441246

0 commit comments

Comments
 (0)