Search Entity Events with Cursor
Learn about searching for entity events with a cursor-based approach.
The Search Entity Events with Cursor operation allows you to retrieve entity event records in a strictly defined order using a cursor-based approach. It behaves similarly to cursors in relational databases. The first request returns a cursor value, which you include in subsequent requests to fetch the next portion of results. Each response continues where the last one left off, ensuring no duplication across the dataset.
This API endpoint doesn't check for long-term storage so it won't return any data older than 4 months.
Request:
| Parameter | Required | Details | Example | |
|---|---|---|---|---|
| Headers | Authorization
| Yes | This represents the information about authentication access token in the format of "Bearer <accessToken>" (see details in Authentication API ). | |
| Query | filter
| No | This enables events filtering by a condition. Format for the filter query parameter is, filter=({Condition Type}[AND/OR {Condition Type}]*)To know more about the conditions, see Filtering Entities. Note: Consider the following points:
|
|
| Query | types | No | This indicates a comma-separated list of event types using which events must be filtered. The possible values for the eventType field are as follows:
| types=CREATED,UPDATED |
| Query | options | No | An option for the endpoint to return:
| options=resolveMergedEntities |
| Query | offset | No | Zero-based index of the first event to return in the result set. For example, if the result set includes 1000 events and you set offset=100 and max=200, the operation returns events 101 through 300.Ignored if you specify a cursor value in the request body. | offset=100 |
| Query | max | No | This indicates the maximum number of events to be retrieved. Note: You can specify a maximum value of 2000 for this parameter . | max=200 |
| Request body | Cursor definition | Yes for all requests except the first one. | This indicates the JSON object that defines the cursor value and must have one JSON attribute cursor with the sub-JSON structure having one string attribute value. |
|
Response:
Indicates a JSON object with the cursor specification and the response part.
First request
Here is a cursor-based request example:
First Response
The response includes a cursor value to use in a subsequent request to continue retrieving the result set.