OTotterly
Brand Reports

List brand report annotations

Changed on

Returns every annotation on the brand report, notes and recommendation markers, most recently created first. Send startDate and endDate together to return only annotations dated in that range (inclusive), ordered by annotation date, latest first; a lone bound or a startDate after endDate 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.

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

Request

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

Path parameters

reportIdstring required

Brand report identifier.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Query parameters

startDatestring

Optional. First day to include (inclusive), YYYY-MM-DD. Send together with endDate.

Example:2025-04-01
endDatestring

Optional. Last day to include (inclusive), YYYY-MM-DD. Send together with startDate.

Example:2025-04-30

Response

The annotations on the brand report.

Example response

{
  "items": [
    {
      "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"
    }
  ],
  "paging": {
    "nextCursor": null,
    "hasMore": false
  }
}

Changes