Submit feedback and corrections for a prior API query

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({source_url: '<string>'})
};

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

import requests

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

payload = { "source_url": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

curl --request POST \
  --url https://api.arcmira.com/v1/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source_url": "<string>"
}
'

{
  "feedback_id": 123,
  "type": "<string>",
  "query": {},
  "applied": 123,
  "unchanged": 123,
  "failed": 123,
  "logged": 123,
  "corrections": [
    {
      "item_id": "<string>",
      "item_kind": "<string>",
      "previous_mention_class": "<string>",
      "new_mention_class": "<string>",
      "rows_affected": 123,
      "reason": "<string>",
      "message": "<string>",
      "recommendation": {
        "id": "<string>",
        "recommendation_id": 123,
        "mention_class": "<string>",
        "entity": {
          "id": "<string>",
          "name": "<string>",
          "type": "<string>"
        },
        "media": {
          "video_id": "<string>",
          "title": "<string>",
          "published_at": "<string>",
          "channel_id": "<string>",
          "source_channel": {
            "id": "<string>",
            "name": "<string>"
          }
        },
        "start_timestamp": "<string>",
        "end_timestamp": "<string>",
        "start_seconds": 123,
        "end_seconds": 123,
        "verbatim_quote": "<string>",
        "promo_code": "<string>",
        "offer": "<string>",
        "sentiment": 123,
        "sentiment_score": 123,
        "confidence": 123,
        "speaker_role": "<string>",
        "conflict_status": "<string>",
        "resolution": "<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>"
  }
}

Community Review

Submit feedback and corrections for a prior API query

Attach corrections to the exact query you ran: pass the feedback type, the query object you sent, and optional per-item corrections. Public submissions are recorded for human review (status "logged"); nothing is auto-applied. Read the review status back later via GET /v1/feedback/{feedback_id}. recommendations and channel_sponsors feedback types require the recommendations:read scope; every other type needs read. monitor_alert feedback targets fired alert rows: query carries monitor_id and/or tracker_id and/or alert_id, corrections target the alert row id, and every referenced alert row must belong to the caller (otherwise 404 alert_not_found). missed_alert corrections are expectations with no row to target: omit the correction id and put { source_url, approximate_timestamp_seconds?, entity_id? } in suggested_change. delivery_issue corrections may carry { channel } in suggested_change. Supports the Idempotency-Key header.

POST

feedback

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({source_url: '<string>'})
};

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

import requests

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

payload = { "source_url": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

curl --request POST \
  --url https://api.arcmira.com/v1/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source_url": "<string>"
}
'

{
  "feedback_id": 123,
  "type": "<string>",
  "query": {},
  "applied": 123,
  "unchanged": 123,
  "failed": 123,
  "logged": 123,
  "corrections": [
    {
      "item_id": "<string>",
      "item_kind": "<string>",
      "previous_mention_class": "<string>",
      "new_mention_class": "<string>",
      "rows_affected": 123,
      "reason": "<string>",
      "message": "<string>",
      "recommendation": {
        "id": "<string>",
        "recommendation_id": 123,
        "mention_class": "<string>",
        "entity": {
          "id": "<string>",
          "name": "<string>",
          "type": "<string>"
        },
        "media": {
          "video_id": "<string>",
          "title": "<string>",
          "published_at": "<string>",
          "channel_id": "<string>",
          "source_channel": {
            "id": "<string>",
            "name": "<string>"
          }
        },
        "start_timestamp": "<string>",
        "end_timestamp": "<string>",
        "start_seconds": 123,
        "end_seconds": 123,
        "verbatim_quote": "<string>",
        "promo_code": "<string>",
        "offer": "<string>",
        "sentiment": 123,
        "sentiment_score": 123,
        "confidence": 123,
        "speaker_role": "<string>",
        "conflict_status": "<string>",
        "resolution": "<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.

Query Parameters

type

enum<string>

required

The surface being reviewed. Values: recommendations (/v1/recommendations rows by com_* id; requires recommendations:read), channel_sponsors (sponsor entities on a channel; requires recommendations:read), mentions (/v1/mentions rows by men_* id), entities_search (/v1/entities/search hits), entities (/v1/entities/lookup and /v1/entities/{id} payloads), channels (/v1/channels/{slug} payloads), monitor_alert (fired alert rows from /v1/monitors/{id}/alerts or /v1/trackers/{id}/alerts; corrections target the alert row id), appearances (person appearance rows), search (rows from /v1/search or /v1/entities/search).

Available options:

recommendations,

channel_sponsors,

mentions,

entities_search,

entities,

channels,

monitor_alert,

appearances,

search

query

string

Minimum string length: 1

Body

application/json

type

enum<string>

Available options:

recommendations,

channel_sponsors,

mentions,

entities_search,

entities,

channels,

monitor_alert,

appearances,

search

query

object

The query object that produced the result you are reviewing, echoed back verbatim so reviewers can replay it. For monitor_alert feedback, carry monitor_id and/or tracker_id and/or alert_id.

Show child attributes

endpoint

string

Maximum string length: 500

method

enum<string>

Available options:

GET,

POST,

PATCH,

PUT,

DELETE

request_id

string

Maximum string length: 200

result_url

string

Maximum string length: 2000

source_url

string

Maximum string length: 2000

notes

string

Maximum string length: 4000

corrections

object[]

Maximum array length: 100

Show child attributes

Response

Success

feedback_id

integer

required

Id of the persisted feedback record. Read it back via GET /v1/feedback/{feedback_id}.

type

string

required

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

query

object

required

The query object the feedback is attached to, echoed back.

Show child attributes

applied

integer

required

Count of corrections applied automatically. CURRENTLY always 0: public submissions are logged for review, never auto-applied.

unchanged

integer

required

Count of corrections whose target already had the requested value. Currently always 0 for public submissions.

failed

integer

required

Count of corrections that could not be processed. Currently always 0 for public submissions.

logged

integer

required

Count of corrections recorded for human review.

corrections

object[]

required

Per-correction outcomes, in submission order.

Show child attributes

Withdraw your pending video merge Read back a feedback submission and its review status