FishOutFishOut

Teach a correction on a mention

POST/orgs/{organizationId}/projects/{projectId}/mentions/{mentionId}/feedback

Teach a correction on a mention within the selected project. Kinds: not_relevant archives the mention; relevant lifts it out of Filtered; add_label/remove_label take a label id in value; set_sentiment takes a sentiment. The mention changes immediately and recent corrections are sent to future triage as examples. Uses the app's permissions and entitlements.

Authorization

AuthorizationBearer <token>

Scoped FishOut API key. Never send credentials in query parameters.

In: header

Path Parameters

organizationId*string
Length1 <= length
projectId*string
Length1 <= length
mentionId*string
Length1 <= length <= 200

Header Parameters

Idempotency-Key*string

Reuse for retries of the same action for 24 hours. A changed body returns 409.

Length8 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/orgs/string/projects/string/mentions/string/feedback" \  -H "Idempotency-Key: stringst" \  -H "Content-Type: application/json" \  -d '{    "kind": "not_relevant"  }'
{  "data": {    "feedback": {      "id": "string",      "projectId": "string",      "mentionId": "string",      "userId": "string",      "kind": "not_relevant",      "value": "string",      "createdAt": "2019-08-24T14:15:22Z",      "excerpt": "string",      "property1": "string",      "property2": "string"    },    "mention": {      "id": "string",      "projectId": "string",      "platform": "reddit",      "source": {        "kind": "string",        "name": "string",        "url": "string",        "property1": "string",        "property2": "string"      },      "author": {        "handle": "string",        "displayName": "string",        "profileUrl": "string",        "avatarUrl": "string",        "followers": 0,        "property1": "string",        "property2": "string"      },      "title": "string",      "parent": {        "title": "string",        "url": "string",        "property1": "string",        "property2": "string"      },      "content": "string",      "url": "string",      "createdAt": "2019-08-24T14:15:22Z",      "fetchedAt": "2019-08-24T14:15:22Z",      "triageStatus": "pending",      "relevance": 0,      "relevanceReason": "relevant",      "subject": "brand",      "why": [        "matches_brief"      ],      "labels": [        "string"      ],      "aiLabels": [        "string"      ],      "manualLabels": [        "string"      ],      "removedLabels": [        "string"      ],      "sentiment": "positive",      "replyCall": "reply_now",      "replyHint": "answer",      "matchedKeywordIds": [        "string"      ],      "engagement": {        "likes": 0,        "replies": 0,        "reposts": 0,        "views": 0,        "property1": "string",        "property2": "string"      },      "threadContext": [        {          "author": {            "handle": "string",            "displayName": "string",            "profileUrl": "string",            "avatarUrl": "string",            "followers": 0,            "property1": "string",            "property2": "string"          },          "content": "string",          "createdAt": "2019-08-24T14:15:22Z",          "isRoot": true,          "isMatch": true,          "property1": "string",          "property2": "string"        }      ],      "language": "string",      "status": "new",      "assigneeId": "string",      "snoozedUntil": "2019-08-24T14:15:22Z",      "readAt": "2019-08-24T14:15:22Z",      "property1": "string",      "property2": "string"    },    "property1": "string",    "property2": "string"  },  "meta": {    "requestId": "string",    "replayed": true  }}

Turn a built-in label on or off PATCH

Turn a built-in label on or off within the selected project. Off removes the label from future triage; labels already applied stay. Returns every label. Uses the app's permissions and entitlements.

List what was taught GET

List what was taught within the selected project. Uses the app's permissions and entitlements.