Sign in
Feedback

Read back a feedback submission and its review status

Returns the submission (id, type, query, notes, created_at) plus its corrections, each with a review status in the public vocabulary: pending_review, needs_information, accepted, accepted_with_changes, rejected, withdrawn, applied, reverted (accepted means a reviewer agreed; applied means the change is live in the index). Only the submitting user's keys can read a submission; unknown ids and other users' submissions both return 404 (never 403).

get/v1/feedback/{feedback_id}

Request

  • Base URL: https://api.arcmira.com
  • URL: https://api.arcmira.com/v1/feedback/{feedback_id}
  • Auth: HTTP bearer

Path parameters

feedback_idstring required

The feedback submission id POST /v1/feedback returned, fbk_ and digits.

Response

Success

feedback_idstring required

Id of the feedback record, fbk_ and digits.

typestring required

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

status'pending_review' | 'needs_information' | 'accepted' | 'accepted_with_changes' | 'rejected' | 'withdrawn' | 'applied' | 'reverted' 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).

queryobject required

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

notesstring nullable required

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

created_atstring nullable required

When the submission was created.

Changes

No recorded changes to this operation across all 1 revision of this API.