Skip to main content
GET
/
v1
/
feedback
/
{feedback_id}
Read back a feedback submission and its review status
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcmira.com/v1/feedback/{feedback_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "https://api.arcmira.com/v1/feedback/{feedback_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
curl --request GET \
  --url https://api.arcmira.com/v1/feedback/{feedback_id} \
  --header 'Authorization: Bearer <token>'
{
  "feedback_id": 123,
  "type": "<string>",
  "query": {},
  "notes": "<string>",
  "created_at": "<string>",
  "corrections": [
    {
      "item_id": "<string>",
      "item_kind": "<string>",
      "issue_type": "<string>",
      "reason": "<string>",
      "suggested_change": {},
      "notes": "<string>",
      "resolution_note": "<string>",
      "created_at": "<string>"
    }
  ]
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>",
    "param": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Success

​
feedback_id
integer
required

Id of the feedback record.

​
type
string
required

The feedback type as submitted. Values: recommendations, channel_sponsors, mentions, entities_search, entities, channels, monitor_alert, appearances, search.

​
status
enum<string>
required

Submission-level rollup of the per-correction statuses. Review status in the public vocabulary. Values: pending_review (submitted; a reviewer has not finished with it), needs_information (a reviewer needs more detail from you; add context in a support thread quoting the feedback_id), accepted (the correction was accepted as submitted), accepted_with_changes (accepted, but the reviewer resolved it differently than proposed), rejected (reviewed and declined), withdrawn (withdrawn by the submitter before review), applied (the accepted change is live in the index; accepted does not imply applied), reverted (a previously applied change was rolled back).

Available options:
pending_review,
needs_information,
accepted,
accepted_with_changes,
rejected,
withdrawn,
applied,
reverted
​
query
object
required

The query object the feedback was attached to, as submitted.

​
notes
string | null
required

The top-level notes as submitted. Null when none were supplied.

​
created_at
string | null
required

When the submission was created.

​
corrections
object[]
required

Per-correction rows with their individual review statuses, in submission order.