Method: instances.summarizeEntitiesFromQuery

Full name: projects.locations.instances.summarizeEntitiesFromQuery

Parses the query and identifies the entities contained within the search query.

HTTP request


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
query

string

Required. Query to summarize entities for.
timeRange

object (Interval)

Required. Query time range used to summarize entities [inclusive start time, exclusive end time).

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:

JSON representation 
{
  "entitySummaries": [
    {
      object (EntitySummary)
    }
  ]
}
Fields
entitySummaries[]

object (EntitySummary)

A list of entity summaries, each summarizing an entity from given query.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the instance resource:

  • chronicle.entities.summarizeFromQuery

For more information, see the IAM documentation.

EntitySummary

EntitySummary represents entity evolution over a period of time.

JSON representation 
{
  "entity": [
    {
      object (Entity)
    }
  ],
  "topLevelDomain": {
    object (Entity)
  }
}
Fields
entity[]

object (Entity)

List of entities that contain entity summary over a time range.
topLevelDomain

object (Entity)

Top level domain entity.