---
title: "POST /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:sample"
method: POST
path: "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:sample"
tags: ["projects"]
---

# POST /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:sample

`POST /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:sample`

## Request

- Base URL: `https://contactcenterinsights.googleapis.com`
- URL: `https://contactcenterinsights.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:sample`
- Auth: OAuth 2 and OAuth 2
  - Implicit: `https://accounts.google.com/o/oauth2/auth`
  - Scopes: `https://www.googleapis.com/auth/cloud-platform`
  - Authorization code: `https://accounts.google.com/o/oauth2/auth`
  - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform`

Samples conversations based on user configuration and handles the sampled conversations for different use cases.

## Path parameters

- `projectsId` string, required
- `locationsId` string, required
- `datasetsId` string, required

## Request body

- GoogleCloudContactcenterinsightsV1SampleConversationsRequest: The request to sample conversations to a dataset.
  - `destinationDataset` GoogleCloudContactcenterinsightsV1Dataset: Dataset resource represents a collection of conversations that may be bounded (Static Dataset, e.g. golden dataset for training), or unbounded (Dynamic Dataset, e.g. live traffic, or agent training traffic)
    - `createTime` string, google-datetime: Output only. Dataset create time.
    - `description` string: Dataset description.
    - `displayName` string: Display name for the dataaset
    - `name` string: Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}
    - `satisfiesPzi` boolean: Output only. Whether this resource is zone isolated.
    - `satisfiesPzs` boolean: Output only. Whether this resource is zone separated.
    - `ttl` string, google-duration: Optional. Option TTL for the dataset.
    - `type` 'TYPE_UNSPECIFIED' | 'EVAL' | 'LIVE': Dataset usage type.
    - `updateTime` string, google-datetime: Output only. Dataset update time.
  - `parent` string: Required. The parent resource of the dataset.
  - `sampleRule` GoogleCloudContactcenterinsightsV1SampleRule: Message for sampling conversations.
    - `conversationFilter` string: To specify the filter for the conversions that should apply this sample rule. An empty filter means this sample rule applies to all conversations.
    - `dimension` string: Optional. Group by dimension to sample the conversation. If no dimension is provided, the sampling will be applied to the project level. Current supported dimensions is 'quality_metadata.agent_info.agent_id'.
    - `samplePercentage` number, double: Percentage of conversations that we should sample based on the dimension between [0, 100].
    - `sampleRow` string, int64: Number of the conversations that we should sample based on the dimension.

## Response `200`

Successful response

- GoogleLongrunningOperation: This resource represents a long-running operation that is the result of a network API call.
  - `done` boolean: If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  - `error` GoogleRpcStatus: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
    - `code` integer: The status code, which should be an enum value of google.rpc.Code.
    - `details` object[]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
    - `message` string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  - `metadata` object: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
  - `name` string: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  - `response` object: The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

---

[API](https://skmtc.dev/google/apis/contactcenterinsights.md) - [All operations](https://skmtc.dev/google/apis/contactcenterinsights/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/contactcenterinsights/revisions/895c3ce55ea0?raw)