Export feedback report

Request

Download a feedback report as CSV or JSON file. Response Content-Type is text/csv when format=csv and application/json when format=json.

Requires project.feedback.read permission.

Security

ApiKey

Path

orgIdstring^org_[0-9abcdefghjkmnpqrstvwxyz]{26}$required

Organization ID.

Example:org_01h1s5z6vf2mm1mz3hevnn9va7

projectIdstring^prj_[0-9abcdefghjkmnpqrstvwxyz]{26}$required

Project ID.

Example:prj_01hh1t9sa6gwfv5naz04gr7ehm

Query

formatstring

Export file format. Defaults to csv.

Default:"csv"

Enum:"csv""json"

Example:format=csv

afterstring

Cursor from `page.nextPage` in a **List all feedback** response. The export includes only the rows after this cursor.

Example:after=a25fgaksjf23la==

beforestring

Cursor from `page.previousPage` in a **List all feedback** response. The export includes only the rows before this cursor.

Example:before=bfg23aksjf23zb1==

limitinteger, [ 1 .. 10000 ]

Maximum number of feedback rows to include in the export (from the current sort order).

When omitted, the export includes up to 1000 rows. Request a larger export explicitly, up to the maximum.

Default:1000

Example:limit=10000

sortstring

Feedback report can be sorted by the following properties: - `id` - `createdAt` - `path` - `email` - `score` - `agent` - `targetFeature` To sort in descending order, prefix the field with `-` (for example `-createdAt`). To sort in ascending order, use the field name without a prefix (for example `createdAt`). By default, feedback report is sorted by `id` in descending order, which corresponds to the newest feedback first.

Default:"-id"

Example:sort=-id

filterstring

Filter feedback by: - `createdAt` - `email` - `path` - `location` - `comment` - `internalComment` - `agent` - `targetFeature` - `status` (one of `NEW`, `IN_REVIEW`, `RESOLVED`, `ARCHIVED`, `SPAM`) - `feedbackComponent` (one of `SENTIMENT`, `RATING`, `COMMENT`, `MOOD`, `PROBLEM`, `SCALE`) - `origin` (one of `FORM`, `API`, `MCP`) This field requires a special format. For more information, see [Filter results](#section/filter-results).

Example:filter=status:approved createdAt:30d

searchstring

Search feedback by query string. Feedback is searched by: - `email` - `path` - `location` - `comment` - `internalComment` - `agent` - `targetFeature`

Example:search=text-to-search

x-redocly-clientstring^[a-z0-9-]{1,64}/[\w.+-]{1,32}$

Identifies the calling client as <name>/<version>, for example reunite-ui/0.92.1. Used for API consumer observability. Requests without it are attributed as unknown.

Example:reunite-ui/0.92.1

curl -i -X GET \
  'https://redocly.com/_mock/docs/platform/customization/reunite-api/openapi/orgs/org_01h1s5z6vf2mm1mz3hevnn9va7/projects/prj_01hh1t9sa6gwfv5naz04gr7ehm/feedback-export?format=csv&after=a25fgaksjf23la%3D%3D&before=bfg23aksjf23zb1%3D%3D&limit=10000&sort=-id&filter=status%3Aapproved%20createdAt%3A30d&search=text-to-search' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-redocly-client: reunite-ui/0.92.1'

Responses

Export file. Media type depends on the format query parameter.

The response is sent as a download: Content-Disposition is attachment with a generated filename unless the server chooses otherwise.

Default filename pattern: feedback_export_{orgId}_{projectId}_{timestamp}.{format}, where {timestamp} is milliseconds since the Unix epoch and {format} is either csv or json.

Headers

Content-Dispositionstring

Attachment hint for browsers and HTTP clients. Includes the suggested filename in the filename parameter (quoted).

By default the filename follows feedback_export_{orgId}_{projectId}_{timestamp}.{format}, using the same orgId and projectId as in the path and a millisecond timestamp.

Example:"attachment; filename=\"feedback_export_org_01hh1t9sa6gwfv5naz04gr7ehm_prj_01hh1t9sa6gwfv5naz04gr7ehm_1715432100123.csv\""

Body

string, (binary)

Response

string