SCscrunchai
signals

Set Signal Reaction

Changed on

Set (or replace) the calling user's reaction on a signal. Reactions are keyed on the signal's stable identity (fingerprint, subject_kind, competitor_id, alert_type and scope_qualifier), so a reaction survives the nightly re-detection of the same underlying issue.

The reaction is attributed to the caller's user: the signed-in user for a user token (JWT), or the key's creator for an API key. Tokens with no user receive 403.

put/{brand_id}/signals/{signal_id}/reaction

Request

  • Base URL
    https://api.scrunchai.com/v1
  • Auth
    HTTP bearer

Path parameters

brand_idinteger required
signal_idinteger required

Request body

reaction'useful' | 'not_useful' | 'dismissed' | 'actioned' required

Reaction to set: useful, not_useful, dismissed, or actioned.

reasonstring nullable

Optional free-text reason accompanying the reaction.

Response

Successful Response

user_idinteger required

ID of the user the reaction belongs to.

insight_idinteger required

Signal ID the reaction was last set on.

fingerprintstring required

Stable signal identity the reaction follows across re-detections.

subject_kind'brand' | 'competitor' required

Subject of the signal the reaction is on: brand or competitor.

competitor_idinteger nullable

Competitor ID of the signal the reaction is on; null for brand.

alert_type'level_change' | 'trend' | 'level' required

Detection kind of the signal the reaction is on.

scope_qualifierstring required

Scope variant of the signal the reaction is on.

reaction'useful' | 'not_useful' | 'dismissed' | 'actioned' required

The reaction value.

reasonstring nullable

Free-text reason, when provided.

surface'in_app' | 'email' | 'slack' | 'api' required

Where the reaction was set: in_app, email, slack, or api.

created_atstring date-time required

When the reaction was first set (UTC).

updated_atstring date-time required

When the reaction was last changed (UTC).

Changes

  • 9b86067d188aRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status