- [HTTP request](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#body.HTTP_TEMPLATE)
- [Path parameters](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#body.PATH_PARAMETERS)
- [Request body](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#body.request_body)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#body.request_body.SCHEMA_REPRESENTATION)
- [Response body](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#body.response_body)
- [Authorization scopes](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#body.aspect)
- [CaseSummaryFeedbackMetadata](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#CaseSummaryFeedbackMetadata)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#CaseSummaryFeedbackMetadata.SCHEMA_REPRESENTATION)
- [CaseAssistantType](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#CaseAssistantType)
- [PlaybookGenerationFeedbackMetadata](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#PlaybookGenerationFeedbackMetadata)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#PlaybookGenerationFeedbackMetadata.SCHEMA_REPRESENTATION)
- [PlaybookAiType](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#PlaybookAiType)
- [PlaybookGenerationByAlertFeedbackMetadata](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#PlaybookGenerationByAlertFeedbackMetadata)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#PlaybookGenerationByAlertFeedbackMetadata.SCHEMA_REPRESENTATION)
- [ActionCodeGenerationFeedbackMetadata](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#ActionCodeGenerationFeedbackMetadata)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#ActionCodeGenerationFeedbackMetadata.SCHEMA_REPRESENTATION)
- [ActionGenerationContextAction](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#ActionGenerationContextAction)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#ActionGenerationContextAction.SCHEMA_REPRESENTATION)

**Full name**: projects.locations.instances.submitResponseFeedback

Submits user feedback for a specific platform interaction or feature. Use this method to capture ratings and comments about system performance, such as case summaries, playbook generation, or AI-assisted actions.

### HTTP request

`POST https://{endpoint}/v1beta/{instance}:submitResponseFeedback`

Where `{endpoint}` is one of the [supported service endpoints](https://docs.cloud.google.com/chronicle/docs/reference/rest#rest_endpoints).

### Path parameters

| Parameters ||
|---|---|
| `instance` | `string` Required. The name of the parent resource, which is the SecOps instance associated with the request. Format: projects/{project}/locations/{location}/instances/{instance} |

### Request body

The request body contains data with the following structure:

| JSON representation |
|---|
| ``` { "rating": integer, "comment": string, "productType": string, "productId": string, "productVersion": string, "flags": integer, "id": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "caseSummaryMetadata": { object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#CaseSummaryFeedbackMetadata`) }, "playbookGenerationMetadata": { object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#PlaybookGenerationFeedbackMetadata`) }, "playbookGenerationByAlertMetadata": { object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#PlaybookGenerationByAlertFeedbackMetadata`) }, "actionCodeGenerationMetadata": { object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#ActionCodeGenerationFeedbackMetadata`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `rating` | `integer` Required. The numerical rating provided by the user; The number should be between 1 to 5. |
| `comment` | `string` Optional. A user-provided comment offering additional feedback or details about the product. Maximum length: 500 characters. |
| `productType` | `string` Required. The type or category of the product being reviewed. Maximum length: 50 characters. Example: "CaseSummary_recommendationReasons". |
| `productId` | `string` Required. A unique identifier for the product being reviewed. Maximum length: 50 characters. Example: "2". |
| `productVersion` | `string` Required. The version of the product being reviewed. Maximum length: 20 characters. Example: "1.0.0". |
| `flags` | `integer` Optional. Flags or additional indicators associated with the feature feedback. |
| `id` | `string` Required. The feedback id to be submitted. This id is a GUID. Example: "123e4567-e89b-12d3-a456-426614174000". |
| Metadata containing additional contextual information about the feedback. Metadata must conform to one of the predefined metadata types, such as: - CaseSummaryFeedbackMetadata - PlaybookGenerationFeedbackMetadata - PlaybookGenerationByAlertFeedbackMetadata These types define specific fields that are validated according to their own rules. Example for CaseSummaryFeedbackMetadata: { "deviceProducts": \["Product1", "Product2"\], "deviceRuleGenerators": \["RuleGen1"\], "deviceVendors": \["Vendor1"\] } Example for PlaybookGenerationFeedbackMetadata: { "prompt": "Generate a new playbook", "type": "Generate" } The metadata field is optional but must adhere to one of the predefined metadata types. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `caseSummaryMetadata` | ``object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#CaseSummaryFeedbackMetadata`)`` Optional. Metadata specific to case summary feedback. |
| `playbookGenerationMetadata` | ``object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#PlaybookGenerationFeedbackMetadata`)`` Optional. Metadata specific to playbook generation feedback. |
| `playbookGenerationByAlertMetadata` | ``object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#PlaybookGenerationByAlertFeedbackMetadata`)`` Optional. Feedback metadata specific to playbook generation by alert. |
| `actionCodeGenerationMetadata` | ``object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#ActionCodeGenerationFeedbackMetadata`)`` Optional. Feedback metadata specific to action code generation. |
| End of mutually exclusive fields. ||

### Response body

If successful, the response body is an empty JSON object.

### Authorization scopes

Requires one of the following OAuth scopes:

- `https://www.googleapis.com/auth/cloud-platform`
- `
  https://www.googleapis.com/auth/chronicle`

For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp).

## CaseSummaryFeedbackMetadata

Contains metadata specific to case summary feedback.

| JSON representation |
|---|
| ``` { "caseAssistantType": enum (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#CaseAssistantType`), "deviceProducts": [ string ], "deviceRuleGenerators": [ string ], "deviceVendors": [ string ], "type": string, "version": integer } ``` |

| Fields ||
|---|---|
| `caseAssistantType` | ``enum (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#CaseAssistantType`)`` Required. Type of the assistant for the case summary. |
| `deviceProducts[]` | `string` Optional. List of device products associated with the case summary feedback. |
| `deviceRuleGenerators[]` | `string` Optional. List of device rule generators associated with the case summary feedback. |
| `deviceVendors[]` | `string` Optional. List of device vendors associated with the case summary feedback. |
| `type` | `string` Required. The type of the metadata. Will always be "CaseSummaryFeedbackMetadata". |
| `version` | `integer` Optional. The version of the case summary feedback format. |

## CaseAssistantType

Enum to define the types of case assistants for case summary feedback.

| Enums ||
|---|---|
| `CASE_ASSISTANT_TYPE_UNSPECIFIED` | Unspecified case assistant type. |
| `THREAT_SUMMARY` | Represents the threat summary. |
| `RECOMMENDATION_REASONS` | Represents the reasons for a recommendation. |
| `RECOMMENDATION_NEXT_STEPS` | Represents the next steps in a recommendation. |

## PlaybookGenerationFeedbackMetadata

Contains metadata specific to playbook generation feedback.

| JSON representation |
|---|
| ``` { "playbookAiType": enum (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#PlaybookAiType`), "prompt": string, "type": string } ``` |

| Fields ||
|---|---|
| `playbookAiType` | ``enum (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#PlaybookAiType`)`` Required. Type of AI action for the playbook generation (e.g., Generate, Edit). |
| `prompt` | `string` Required. The prompt used for generating or editing the playbook. |
| `type` | `string` Required. The type of the metadata. Will always be "PlaybookGenerationFeedbackMetadata". |

## PlaybookAiType

Enum to define the types of playbook AI actions.

| Enums ||
|---|---|
| `PLAYBOOK_AI_TYPE_UNSPECIFIED` | Unspecified Playbook AI type. |
| `GENERATE` | Represents generating a new playbook. |
| `EDIT` | Represents editing an existing playbook. |

## PlaybookGenerationByAlertFeedbackMetadata

Contains feedback metadata specific to playbook generation by alert.

| JSON representation |
|---|
| ``` { "type": string, "playbookId": string, "originalPlaybookId": string, "alertId": string, "caseId": string, "reasons": [ string ], "scope": string, "stepId": string } ``` |

| Fields ||
|---|---|
| `type` | `string` Required. The type of the metadata. Will always be "PlaybookGenerationByAlertFeedbackMetadata". |
| `playbookId` | `string` Required. The identifier of the generated playbook. |
| `originalPlaybookId` | `string` Optional. The identifier of the original playbook if this is an edit. |
| `alertId` | `string` Required. The identifier of the alert that triggered the playbook generation. |
| `caseId` | `string` Required. The identifier of the case associated with the alert. |
| `reasons[]` | `string` Optional. Reasons for the feedback. |
| `scope` | `string` Required. The scope of the feedback (e.g., playbook, step). |
| `stepId` | `string` Optional. The identifier of the step if the feedback is for a specific step. |

## ActionCodeGenerationFeedbackMetadata

Contains feedback metadata specific to action code generation.

| JSON representation |
|---|
| ``` { "type": string, "integrationId": string, "prompt": string, "generationId": string, "soarVersion": string, "integrationVersion": string, "promptVersion": string, "contextActions": [ { object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#ActionGenerationContextAction`) } ] } ``` |

| Fields ||
|---|---|
| `type` | `string` Required. The type of the metadata. Will always be "ActionCodeGenerationFeedbackMetadata". |
| `integrationId` | `string` Required. The identifier of the integration. |
| `prompt` | `string` Required. The prompt used for generating or editing the playbook. |
| `generationId` | `string` Required. The identifier of the generated action. |
| `soarVersion` | `string` Required. The version of the product. Maximum length: 20 characters. Example: "1.0.0". |
| `integrationVersion` | `string` Required. The version of the integration where the action is generated. Maximum length: 20 characters. Example: "1.0". |
| `promptVersion` | `string` Required. The version of the integration where the action is generated. Maximum length: 20 characters. Example: "v1". |
| `contextActions[]` | ``object (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances/submitResponseFeedback#ActionGenerationContextAction`)`` Required. The context actions that are used to generate the action. |

## ActionGenerationContextAction

Contains metadata specific to context action.

| JSON representation |
|---|
| ``` { "name": string, "isCustom": boolean } ``` |

| Fields ||
|---|---|
| `name` | `string` Required. The name of the action. |
| `isCustom` | `boolean` Required. Whether the action is custom. |