feedback

11 endpoints at a glance

Method	Path	Summary
GET	/admin/feedback/	Admin List Feedback
GET	/admin/feedback/{thread_id}/	Admin Get Thread
POST	/admin/feedback/{thread_id}/reply	Admin Reply Thread
POST	/admin/feedback/{thread_id}/status	Admin Set Status
GET	/admin/feedback/stats/	Admin Feedback Stats
POST	/feedback/	Submit Feedback
GET	/feedback/mine/	List My Feedback
GET	/feedback/mine/{thread_id}/	Get My Thread
POST	/feedback/mine/{thread_id}/read	Mark My Thread Read
POST	/feedback/mine/{thread_id}/reply	Reply To My Thread
GET	/feedback/unread-count/	Feedback Unread Count

feedback

---

Submit Feedback

POST

/feedback/

Submit feedback. Anonymous is allowed but one-way (stored +
shown to admins, no reply path). Logged-in starts a two-way
thread. Rate-limited per username / client IP.

Parameters

Header Parameters

authorization

x-api-key

Request Body

application/json

{

  

"message": "string",

  

"subject": "string",

  

"page_url": "string",

  

"context": {

  

  

"additionalProperties": "string"

  

}

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/feedback/

Playground

Headers

authorization

x-api-key

Body

Samples

---

Feedback Unread Count

GET

/feedback/unread-count/

{count} of the caller's threads with an unread admin reply
— the feedback-button badge poll. 0 when anonymous (no
threads).

Parameters

Header Parameters

authorization

x-api-key

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/feedback/unread-count/

Playground

Headers

authorization

x-api-key

Samples

---

List My Feedback

GET

/feedback/mine/

The caller's own threads, newest-activity first.

Parameters

Header Parameters

authorization

x-api-key

Responses

Successful Response

Content-Type

application/json

[

  

{

  

  

"additionalProperties": "string"

  

}

]

GET

/feedback/mine/

Playground

Headers

authorization

x-api-key

Samples

---

Get My Thread

GET

/feedback/mine/{thread_id}/

One of the caller's threads (marks it user-read). 404 when it
isn't theirs / doesn't exist.

Parameters

Header Parameters

authorization

x-api-key

Path Parameters

thread_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/feedback/mine/{thread_id}/

Playground

Headers

authorization

x-api-key

Variables

Key

Value

thread_id*

Samples

---

Reply To My Thread

POST

/feedback/mine/{thread_id}/reply

Parameters

Header Parameters

authorization

x-api-key

Path Parameters

thread_id*

Type

string

Required

Request Body

application/json

{

  

"message": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/feedback/mine/{thread_id}/reply

Playground

Headers

authorization

x-api-key

Variables

Key

Value

thread_id*

Body

Samples

---

Mark My Thread Read

POST

/feedback/mine/{thread_id}/read

Parameters

Header Parameters

authorization

x-api-key

Path Parameters

thread_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/feedback/mine/{thread_id}/read

Playground

Headers

authorization

x-api-key

Variables

Key

Value

thread_id*

Samples

---

Admin List Feedback

GET

/admin/feedback/

Parameters

Header Parameters

authorization

x-api-key

Query Parameters

status

unread_only

Type

boolean

Default

false

q

limit

Type

integer

Default

100

skip

Type

integer

Default

0

Responses

Successful Response

Content-Type

application/json

[

  

{

  

  

"additionalProperties": "string"

  

}

]

GET

/admin/feedback/

Playground

Headers

authorization

x-api-key

Variables

Key

Value

status

unread_only

q

limit

skip

Samples

---

Admin Feedback Stats

GET

/admin/feedback/stats/

{by_status, total, admin_unread} — admin-nav badge +
panel header. Declared before /admin/feedback/{thread_id}/ so
stats isn't captured as a thread id.

Parameters

Header Parameters

authorization

x-api-key

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/admin/feedback/stats/

Playground

Headers

authorization

x-api-key

Samples

---

Admin Get Thread

GET

/admin/feedback/{thread_id}/

Full thread (marks it admin-read).

Parameters

Header Parameters

authorization

x-api-key

Path Parameters

thread_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/admin/feedback/{thread_id}/

Playground

Headers

authorization

x-api-key

Variables

Key

Value

thread_id*

Samples

---

Admin Reply Thread

POST

/admin/feedback/{thread_id}/reply

Reply as admin (→ status answered). 400 on an anonymous
thread (no reply path) or a missing one.

Parameters

Header Parameters

authorization

x-api-key

Path Parameters

thread_id*

Type

string

Required

Request Body

application/json

{

  

"message": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/admin/feedback/{thread_id}/reply

Playground

Headers

authorization

x-api-key

Variables

Key

Value

thread_id*

Body

Samples

---

Admin Set Status

POST

/admin/feedback/{thread_id}/status

Parameters

Header Parameters

authorization

x-api-key

Path Parameters

thread_id*

Type

string

Required

Request Body

application/json

{

  

"status": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/admin/feedback/{thread_id}/status

Playground

Headers

authorization

x-api-key

Variables

Key

Value

thread_id*

Body

Samples

---