Skip to Content
annotyDocs
annotyDocs
annoty.appDashboardGetting started

Share with reviewers

Proxy or embed?ProxyEmbedScreenshotsToolbar position

Coding agents

Coding agents (MCP)Send to agent

Integrations

SlackWebhooksDiscordEmailZapiern8n

Reference

GlossaryPlans and billingGet help and send feedback
REST API
List a project's feedback sessions GETCreate a feedback session POSTList the organization's feedback sessions GETGet a feedback session GETUpdate a feedback session PATCHDelete a feedback session DELETEList where a feedback session was opened GET
REST APIFeedback sessions

List where a feedback session was opened

Delete a feedback session DELETE

Deletes its comments too, and disconnects open widgets. Only your organization can reuse its proxy link's slug for the next 60 days. Requires `feedbackSession:delete`.

List a feedback session's comments GET

Threads, newest (highest pin number) first, each with its replies. Requires `comment:read`.

GET
/v1/feedback-sessions/{feedbackSessionId}/sites

Every site a widget opened this feedback session on, its proxy link included, most recently opened first. Only pages with the embed link or the embed key count: the embed script does nothing without one. Requires feedbackSession:read.

Authorization

apiKey
headerAuthorizationBearer <token>

An organization API key from the dashboard (Settings → API keys), e.g. Authorization: Bearer annoty_.... x-api-key: annoty_... also works. While the organization has no subscription or trial, every request with a key except GET /v1/organization fails with 402 SUBSCRIPTION_REQUIRED.

Path Parameters

feedbackSessionId*string

Response Body

The sites

application/json
  1. response
  1. response
  2. …
data*array<>
Example Request
curl -X GET 'https://api.annoty.app/v1/feedback-sessions/string/sites'
Example Response
{
  "data": [
    {
      "origin": "string",
      "method": "proxy",
      "firstOpenedAt": "2019-08-24T14:15:22Z",
      "lastOpenedAt": "2019-08-24T14:15:22Z"
    }
  ]
}