Method: projects.locations.agents.testCases.list

Fetches a list of test cases for a given agent.

HTTP request

GET https://dialogflow.googleapis.com/v3/{parent=projects/*/locations/*/agents/*}/testCases

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The agent to list all pages for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.testcases.list

Query parameters

Parameters
pageSize

integer

The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500.

pageToken

string

The nextPageToken value returned from a previous list request.

view

enum (TestCaseView)

Specifies whether response should include all fields or just the metadata.

Request body

The request body must be empty.

Response body

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

The response message for TestCases.ListTestCases.

JSON representation
{
  "testCases": [
    {
      object (TestCase)
    }
  ],
  "nextPageToken": string
}
Fields
testCases[]

object (TestCase)

The list of test cases. There will be a maximum number of items returned based on the pageSize field in the request.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

TestCaseView

Specifies how much test case information to include in the response.

Enums
TEST_CASE_VIEW_UNSPECIFIED The default / unset value. The API will default to the BASIC view.
BASIC Include basic metadata about the test case, but not the conversation turns. This is the default value.
FULL Include everything.