Delete item
delete_itemDelete one competitor, segment, prompt, page, or report for good: pass exactly one of its IDs. It cannot be restored. Deleting a segment deletes its prompts and their answers; deleting a prompt deletes its answers. To stop tracking but keep the history, pause it with save_competitor, save_segment or save_prompt; to only kill a report's link, use revoke_report. Free, and frees the plan capacity the item used.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| brand | Yes | Brand or study: its ID from list_brands, or its exact name. A partial name is refused. | |
| page_id | No | A Content Studio page, from list_pages. | |
| segment | No | A segment ID or name, from get_brand_settings. | |
| prompt_id | No | A prompt, from list_prompts. | |
| report_id | No | A report, from list_reports. | |
| competitor_id | No | A competitor, from get_brand_settings. | |
| idempotency_key | Yes | A unique key for this intended action. Reuse it with identical arguments when retrying: the write is not made again, and the reply is the first call's resource as saved (replayed: true) with current status; read tools show the resource's current state. Use a new key for another action. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| generated_at | Yes | RFC 3339 time the response was made. | |
| schema_version | Yes |