Skip to main content
POST
Record a first-party suggested-question usage event

Authorizations

Authorization
string
header
required

A Modus personal access token (modus_<orgUuid>_<prefix>_<secret>) or an OAuth 2.1 access token, sent as Authorization: Bearer <token>.

Path Parameters

id
string
required

Stable suggestion id.

Example:

"7a3f9d2c-1111-4000-a000-000000000abc"

Body

application/json
eventType
enum<string>
required

First-party Home suggestion interaction.

Available options:
shown,
clicked,
dismissed,
submitted
Example:

"clicked"

source
enum<string>

Product surface that emitted the event.

Available options:
home
Example:

"home"

skillId
number

Selected Home scope id when known.

threadId
string

Conversation thread id when the event is tied to a chat.

metadata
object

Event metadata.

Response