Method: projects.locations.studies.trials.list

Lists the Trials associated with a Study.

HTTP request

GET https://{service-endpoint}/v1beta1/{parent}/trials

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}

Query parameters

Parameters
pageToken

string

Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

pageSize

integer

Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default.

Request body

The request body must be empty.

Response body

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

Response message for VizierService.ListTrials.

JSON representation
{
  "trials": [
    {
      object (Trial)
    }
  ],
  "nextPageToken": string
}
Fields
trials[]

object (Trial)

The Trials associated with the Study.

nextPageToken

string

Pass this token as the pageToken field of the request for a subsequent call. 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.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.trials.list

For more information, see the IAM documentation.