OTotterly
Brand Reports

Add a note to a brand report

Changed on

Adds a note on a day of the brand report, authored by the API key user. Only notes can be created: recommendation markers are added from the recommendations page in the app, and a type other than note or a recommendationId is a 400. Annotations may not show in the dashboard until annotations are enabled there for your account; they are stored and returned by the API either way.

post/v1/reports/brand/{reportId}/annotations

Request

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

Path parameters

reportIdstring required

Brand report identifier.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Request body

datestring required

Day to mark, YYYY-MM-DD.

textstring required

Note text, 1 to 1000 characters after trimming.

type'note'

Optional. Only note is accepted.

Example request

{
  "date": "2025-04-10",
  "text": "Launched spring running campaign"
}

Response

The created note.

idstring required

Annotation identifier.

brandReportIdstring required

Brand report the annotation belongs to.

datestring required

Marked calendar day, YYYY-MM-DD.

type'note' | 'recommendation' required

note for a free-text note; recommendation for a recommendation marked as done in the app. Only notes can be created or edited through the API.

textstring required

Annotation text.

recommendationIdstring

Recommendation the annotation marks. Present only when type is recommendation.

createdBystring required

Opaque identifier of the user who created the annotation.

createdDatestring required

Creation timestamp (ISO 8601).

updatedDatestring required

Last update timestamp (ISO 8601).

Example response

{
  "id": "01HXAN7K2YV9D3M8N0G6Q5R4S3",
  "brandReportId": "01HXBR1DGM5XY8Z2N3KQ7VAW4P",
  "date": "2025-04-10",
  "type": "note",
  "text": "Launched spring running campaign",
  "createdBy": "4f7a1c2e9b8d4e6f",
  "createdDate": "2025-04-10T09:15:00.000Z",
  "updatedDate": "2025-04-10T09:15:00.000Z"
}

Changes