OTotterly
Brand Reports

Remove prompts from a brand report

Changed on

Unassigns prompts from the brand report and recalculates it without them (asynchronously). The prompt IDs travel in a JSON request body, which some HTTP clients drop on DELETE — send it explicitly. The prompts themselves are not deleted and stay in the workspace — use DELETE /v1/workspaces/{id}/prompts/{promptId} for that. Prompt IDs that are not assigned to the report are returned in notAssigned and left unchanged; unknown prompt IDs are rejected with a 400 naming them. This discards the citation data collected for those prompts in this report: re-adding one later reprocesses only the most recent 7 days of its citation history, so a remove-then-re-add round trip is not reversible.

delete/v1/reports/brand/{reportId}/prompts

Request

  • Base URL
    https://data.otterly.ai
  • Auth
    HTTP bearer

Path parameters

reportIdstring required

Brand report identifier.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Request body

promptIdsstring[] required

IDs of prompts to unassign from the report — look them up with GET /v1/reports/brand/{reportId}/prompts. Up to 1000 IDs per call. Duplicate IDs are removed, and the de-duplicated list comes back as promptIds in the response.

Example request

{
  "promptIds": [
    "01HXP1DRTM5G8Z2N3KQ7VAW4PA"
  ]
}

Response

The prompts unassigned from the brand report. Recalculation completes asynchronously.

reportIdstring required
promptIdsstring[] required

The prompt IDs the request asked to unassign.

removedstring[] required

Prompt IDs unassigned from the report by this request.

notAssignedstring[] required

Prompt IDs that were not assigned to the report, left unchanged.

Example response

{
  "reportId": "01HXBR1DGM5XY8Z2N3KQ7VAW4P",
  "promptIds": [
    "01HXP1DRTM5G8Z2N3KQ7VAW4PA",
    "01HXP2DRTM5G8Z2N3KQ7VAW4PB"
  ],
  "removed": [
    "01HXP1DRTM5G8Z2N3KQ7VAW4PA"
  ],
  "notAssigned": [
    "01HXP2DRTM5G8Z2N3KQ7VAW4PB"
  ]
}

Changes