OTotterly
Brand Reports

Add prompts to a brand report

Changed on

Adds prompts that already exist in the report workspace to the brand report, exactly like ticking the report in the UI. It does not create prompts — use POST /v1/workspaces/{id}/prompts for that. Prompt IDs already assigned to the report are returned in alreadyAssigned and left unchanged; unknown prompt IDs are rejected with a 400 naming them. The report is recalculated for the added prompts asynchronously, so their data appears with a delay. A prompt that was previously removed from this report is reprocessed for the most recent 7 days of citation history only.

post/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 that already exist in the report workspace — look them up with GET /v1/workspaces/{id}/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 assigned to the brand report. Recalculation completes asynchronously.

reportIdstring required
promptIdsstring[] required

The prompt IDs the request asked to assign.

addedstring[] required

Prompt IDs newly assigned to the report by this request.

alreadyAssignedstring[] required

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

Example response

{
  "reportId": "01HXBR1DGM5XY8Z2N3KQ7VAW4P",
  "promptIds": [
    "01HXP1DRTM5G8Z2N3KQ7VAW4PA",
    "01HXP2DRTM5G8Z2N3KQ7VAW4PB"
  ],
  "added": [
    "01HXP1DRTM5G8Z2N3KQ7VAW4PA"
  ],
  "alreadyAssigned": [
    "01HXP2DRTM5G8Z2N3KQ7VAW4PB"
  ]
}

Changes