Feedback API Reference

GET

List feedback events

GET /external/v1/studies/feedback

Read optional post-study ratings and participant identity from Study completions and Live Interview Pulse submissions. Responses without a rating are omitted. Use GET /external/v1/studies/:id/responses for research answers, including responses that skipped the rating. Existing keys with studies:read receive the same name, email, and company display as the Study UI automatically; no new key, additional scope, or include flag is required. participant is null when identity is unknown. Saved identity is also available on historical responses. submittedAt is the rating event time; source identifies the submission path. The feedback subject is separate from the Study’s current accepted context. For a stable synchronization run, hold submittedTo fixed, follow X-Has-More, and advance offset by X-Limit. submittedFrom is inclusive; submittedTo is exclusive.

Requirements

API scopes required:

studies:read

Request

Parameters

Name	Type	Description
metric	string	Stable metric key.
subjectType	string	Immutable subject type.
subjectId	uuid	Immutable subject id.
submittedFrom	ISO timestamp	Inclusive rating event timestamp.
submittedTo	ISO timestamp	Exclusive rating event timestamp.
initiativeId	uuid	Current accepted Initiative context.
ideaId	uuid	Current accepted Idea context.
accountId	uuid	Exact Account filter.
limit	number	1–100 results.
offset	number	Number of results to skip.

Responses

200

Success

Each participant contains nullable id, name, email, accountId, accountName, and account, plus type: public_user, portal_user, or discovery_user. id identifies a linked portal or discovery user; it is not a People/Contact ID. Participants known only through saved response details have id: null even when their name and email are available. The outer id is the group Pulse submission ID when present, otherwise the response ID. Group Pulse identity and account attribution come from the attendee’s saved submission, without falling back to the interview owner. For other feedback, account reflects the response’s linked Account. accountName falls back to captured company text when no Account is linked; account and accountId then remain null. Research answers, notes, transcripts, and clicks are excluded.

Schema

Array<FeedbackEvent>

Example Response

200 OK

json

[
  {
    "id": "response-uuid",
    "rating": 5,
    "metric": "initiative_direction",
    "subject": {
      "type": "initiative",
      "id": "initiative-uuid"
    },
    "comment": "Keep this direction.",
    "submittedAt": "2026-07-14T10:00:00Z",
    "source": "live_interview",
    "accountId": "account-uuid",
    "participant": {
      "id": null,
      "name": "Dana Ruiz",
      "email": "dana@example.com",
      "type": "public_user",
      "accountId": "account-uuid",
      "accountName": "Northstar Dental",
      "account": {
        "id": "account-uuid",
        "name": "Northstar Dental"
      }
    },
    "study": {
      "id": "study-uuid",
      "publicId": "STUDY-8",
      "name": "Scheduler direction check",
      "status": "active",
      "type": "heatmap_interaction",
      "phase": "validation",
      "appPath": "/studies/STUDY-8"
    },
    "initiativeIds": [
      "initiative-uuid"
    ],
    "ideaIds": []
  }
]

GET

Summarize feedback

GET /external/v1/feedback/summary

Return one reproducible metric-and-subject rollup over rating event time. Average, rating sum, rated count, observable eligible interactions, coverage, distribution, source paths, comparison, Studies, and comments remain distinct. A copied Pulse link is not counted as delivered feedback; a submitted Live Interview Pulse is both rated and observable. Comment accounts include an id only; resolve names with accounts:read.