diff --git a/assessment.html b/assessment.html index 67c55018241..f508fed0236 100644 --- a/assessment.html +++ b/assessment.html @@ -399,6 +399,10 @@
sent_by
to the Send Test request example"email": "hpotter@hogwarts.edu",
"greenhouse_profile_url": "https://app.greenhouse.io/people/17681532?application_id=26234709"
},
+ "sent_by": "test_sender@example.org",
"url": "https://app.greenhouse.io/integrations/testing_partners/take_home_tests/12345"
}
query parameter to receive a pit_id
with your results. To retrieve the next page of results, the pit_id
should be the value of your pit_id
header, and the next_search_after
should be the value of your search_after
header. Your query parameters should remain consistent with your original query. Audit log results with only one page will return null
results on the next page.
+Pagination on audit log API allows for retrieving the next page from your query results.
+
+
+- In the initial request:
-pit_id
. The ID from a specific point in time (PIT) in a fixed time dataset, created automatically when you run a query.
-search_after
. Use this parameter to retrieve audit log after a specific page in the search results when running a query with the pit_id
.
-size
. The size of the requested query. This parameter has a minimum value of 100
and a maximum value of 500
.
-
+ - Set the
paging
query parameter to true
to receive a paging
object with pit_id
and next_search_after
in the response
+- Use the
Size
header to specify the number of results you want to receive per page. The minimum value is 100
, and the maximum value is 500
+
+- In subsequent requests:
+
+
+- Ensure that the query parameters remain consistent with the initial request
+- Set the
Pit-Id
header to the paging.pit_id
value from the initial request
+- Set the
Search-After
header to the paging.next_search_after
value from each response progressively
+
+- The last page of results will return
null
for the paging.next_search_after
attribute, and an empty list of results
+
Audit log API requests are rate limited. Paginated requests are limited to 3 per 30 seconds, and overall requests are limited to 50 per 10 seconds. Exceeding the limit will result in throttling.
Validation
@@ -396,6 +407,10 @@ Audit Log Change Log
+September 10, 2023
+Fixed pagination docs to reflect proper use of headers/query params.
+
+
Dec 12, 2023
Fix bug with missing GET events in nav menu