MOmoda-dev

Get emotion detections

Returns multi-family user-emotion detections and their analyzed-trace denominator.

get/api/v1/data/emotions

Request

  • Base URL
    https://moda.dev
  • Auth
    API key in header x-api-key

Query parameters

days_backinteger
limitinteger
offsetinteger
family'frustration' | 'disapproval' | 'sadness' | 'confusion' | 'anxiety' | 'trust' | 'positive'

Optional emotion family filter.

user_idstring

Scope every figure (summary, breakdown, list, total) to one end user.

conversation_idstring

Scope every figure to one trace.

group_by'detection' | 'trace'

trace reads the dashboard's per-trace list: rows in traces, totals count traces (counting: per_trace). The default lists one row per trace and family (counting: per_detection).

searchstring

Trace ID or primary-cause substring. Needs group_by=trace.

status'all' | 'detected'

all: any detected family; detected: a negative-family detection. Needs group_by=trace.

elicitor'bot' | 'external' | 'self' | 'ambiguous'

Needs group_by=trace.

trajectory'none' | 'building' | 'peak' | 'resolved' | 'sustained'

Needs group_by=trace.

signalsstring

Comma-separated expressed signals; a trace matches when any is expressed. Needs group_by=trace.

sort'score' | 'risk_score' | 'detected_at' | 'message_count'

Needs group_by=trace.

order'asc' | 'desc'

Needs group_by=trace.

conversation_idsstring

Scope every figure to several traces: up to 50 trace IDs, comma-separated. Cannot be combined with conversation_id.

cohortstring

builtin:<key> or a saved cohort id: only traces of the cohort's members, summary included. Needs group_by=trace.

Response

Successful response.

object required

Emotion summary, detections, pagination information, and processing ({ enabled, setting: "signals.frustration" }) reporting whether the tenant's emotion/frustration analysis is switched on.

Changes

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