Full name: projects.locations.instances.searchEntities
Identifies the entity type and retrieves relevant data associated with a specified indicator.
HTTP request
GET https://chronicle.googleapis.com/v1alpha/{instance}:searchEntities
Path parameters
Parameters
instance
string
Required. The ID of the Instance to search entities for. Format: projects/{project}/locations/{location}/instances/{instance}
Query parameters
Parameters
indicator
string
Required. Value of indicator tied to an entity.
pageSize
integer
The maximum number of Entities to return. The service may return fewer than this value. If unspecified, at most 1000 entities will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
string
A page token, received from a previous SummarizeEntityRequest call. Provide this to retrieve the subsequent page.
Request body
The request body must be empty.
Response body
Response message for search entities.
If successful, the response body contains data with the following structure:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-14 UTC."],[[["\u003cp\u003eThis endpoint, \u003ccode\u003eprojects.locations.instances.searchEntities\u003c/code\u003e, retrieves data for entities associated with a specified indicator within a given instance.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGET\u003c/code\u003e request requires a specified \u003ccode\u003einstance\u003c/code\u003e path parameter, as well as an \u003ccode\u003eindicator\u003c/code\u003e query parameter to identify the entity to search.\u003c/p\u003e\n"],["\u003cp\u003eOptional query parameters include \u003ccode\u003epageSize\u003c/code\u003e to set the maximum number of entities returned (up to 1000) and \u003ccode\u003epageToken\u003c/code\u003e for pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe response body will contain a list of entities in JSON format and a \u003ccode\u003enext_page_token\u003c/code\u003e for retrieving subsequent pages if present.\u003c/p\u003e\n"],["\u003cp\u003eAccessing this endpoint requires the \u003ccode\u003echronicle.entities.searchEntities\u003c/code\u003e IAM permission on the \u003ccode\u003einstance\u003c/code\u003e resource and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,[]]