Method: projects.locations.apps.evaluations.list

Lists all evaluations in the given app.

HTTP request

GET https://ces.googleapis.com/v1beta/{parent=projects/*/locations/*/apps/*}/evaluations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the app to list evaluations from.

Query parameters

Parameters
pageSize

integer

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken

string

Optional. The nextPageToken value returned from a previous list EvaluationService.ListEvaluations call.
filter
(deprecated)

string

Optional. Deprecated: Use evaluationFilter and evaluationRunFilter instead.
evaluationFilter

string

Optional. Filter to be applied on the evaluation when listing the evaluations. See https://google.aip.dev/160 for more details. Supported fields: evaluationDatasets
evaluationRunFilter

string

Optional. Filter string for fields on the associated EvaluationRun resources. See https://google.aip.dev/160 for more details. Supported fields: createTime, initiatedBy, appVersionDisplayName
orderBy

string

Optional. Field to sort by. Only "name" and "createTime", and "updateTime" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "updateTime" will be the default. See https://google.aip.dev/132#ordering for more details.
lastTenResults

boolean

Optional. Whether to include the last 10 evaluation results for each evaluation in the response.

Request body

The request body must be empty.

Response body

Response message for EvaluationService.ListEvaluations.

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

JSON representation 
{
  "evaluations": [
    {
      object (Evaluation)
    }
  ],
  "nextPageToken": string
}
Fields
evaluations[]

object (Evaluation)

The list of evaluations.
nextPageToken

string

A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • ces.evaluations.list

For more information, see the IAM documentation.