Update signal status

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/signals/{signal_id}/"

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

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

print(response.text)

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

fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/signals/{signal_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request PATCH \
  --url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/signals/{signal_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feedback": "<string>",
  "is_positive": true
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "given_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "[email protected]"
  },
  "status": "to_review",
  "feedback": "<string>",
  "context": {
    "additional_details": "<string>"
  },
  "is_positive": true,
  "user_message": "<string>",
  "conversation_title": "<string>",
  "suggested_action_type": "<string>",
  "suggested_action_data": {},
  "reviewed_at": "2023-11-07T05:31:56Z",
  "reviewed_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "[email protected]"
  },
  "query_id": 123,
  "source": "<string>"
}

{
  "error": "User not found"
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "User not found"
}

{
  "error": "Not found."
}

PATCH

projects

{project_id}

signals

{signal_id}

Update signal status

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/signals/{signal_id}/"

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

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

print(response.text)

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

fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/signals/{signal_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request PATCH \
  --url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/signals/{signal_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feedback": "<string>",
  "is_positive": true
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "given_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "[email protected]"
  },
  "status": "to_review",
  "feedback": "<string>",
  "context": {
    "additional_details": "<string>"
  },
  "is_positive": true,
  "user_message": "<string>",
  "conversation_title": "<string>",
  "suggested_action_type": "<string>",
  "suggested_action_data": {},
  "reviewed_at": "2023-11-07T05:31:56Z",
  "reviewed_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "[email protected]"
  },
  "query_id": 123,
  "source": "<string>"
}

{
  "error": "User not found"
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "User not found"
}

{
  "error": "Not found."
}

Authorizations

Authorization

string

header

required

Use Authorization: Bearer <token>. The token is either a user token / OAuth access token, or a service-account API key (cfk_...). A key is valid on every endpoint and acts as its service account, an organization member with per-store permissions. Refused keys answer 403 with Invalid API key., API key revoked., API key expired. or API key disabled..

Path Parameters

project_id

string<uuid>

required

UUID of the project

signal_id

string<uuid>

required

UUID of the signal

Body

application/json

status

enum<string>

to_review: Signal pending review (default). Setting this on a closed signal reopens it and clears reviewed_at/reviewed_by.
reviewed: Signal has been reviewed
dismissed: Signal closed without action (won't fix, or archived praise)

Available options:

to_review,

reviewed,

dismissed

feedback

string

Updated signal text

is_positive

boolean | null

Updated sentiment

Response

Signal updated successfully

string<uuid>

created_at

string<date-time>

updated_at

string<date-time>

given_by

object

User who submitted the signal

Show child attributes

status

enum<string>

to_review: Signal pending review (default). Setting this on a closed signal reopens it and clears reviewed_at/reviewed_by.
reviewed: Signal has been reviewed
dismissed: Signal closed without action (won't fix, or archived praise)

Available options:

to_review,

reviewed,

dismissed

feedback

string

Signal text comment

context

object

Free-form context, echoed back as submitted at creation

Show child attributes

is_positive

boolean | null

true: Positive signal
false: Negative signal
null: Neutral

user_message

string

The user message that was responded to (computed field)

conversation_title

string

Title of the conversation (computed field)

suggested_action_type

string | null

Auto-generated suggested action type

suggested_action_data

object

Auto-generated suggested action data

reviewed_at

string<date-time> | null

When the signal was closed. Cleared when a signal is reopened. Null for signals closed before this field existed.

reviewed_by

object | null

User who closed the signal (null when closed by an unattended agent)

Show child attributes

query_id

integer | null

The chat message this signal is about (computed from context)

source

string

Surface that raised the signal (computed from context): PlaygroundConversation, MCP, Manual, ObjectsExplorer, cross_store_conversation, or api when the caller named none.