Method: watchlists.listEntities

Full name: projects.locations.instances.watchlists.listEntities

Lists all entities for the given watchlist.

HTTP request

GET https://chronicle.googleapis.com/v1alpha/{parent}:listEntities

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of watchlists. Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of entities to return. The service may return fewer than this value. If unspecified, at most 10,000 entities will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.
pageToken

string

Optional. A page token, received from a previous ListWatchlistEntities call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWatchlistEntities must match the call that provided the page token.
orderBy

string

Optional. Ordering of entities. Currently, only the following is supported: - risk_score.risk_score desc - risk_score.normalized_risk_score desc
Union parameter view. The oneof view field indicates the scope of field to populate for the Entity being returned. view can be only one of the following:
basicView

object (BasicView)

Optional. Include basic metadata about the entity.
timeDependentView

object (TimeDependentView)

Optional. Include time-dependent metadata about the entity beside BasicView.

Request body

The request body must be empty.

Response body

Response message for listing entities in watchlist.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "entities": [
    {
      object (Entity)
    }
  ],
  "next_page_token": string
}
Fields
entities[]

object (Entity)

Optional. The entities from the specified watchlist.
next_page_token

string

Optional. A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

BasicView

This type has no fields.

BasicView includes basic metadata about the entity.

TimeDependentView

TimeDependentView includes time-dependent metadata (e.g., risk score) about the entity beside BasicView.

JSON representation 
{
  "time_range": {
    object (Interval)
  }
}
Fields
time_range

object (Interval)

Required. Time range that is used to fetch time-dependent entity view.