Engagement - Olira

Product and care engagement signals: check-ins, sessions, and interactions. Submit these via POST /v1/logs/batch or the SDK; see How logs work for submission fields and the difference between lifecycle-tracked and point-in-time log types. Type: user_login · Source: SDK / REST · Extensible Reserved for login events: app login; optional metadata. Payload

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.USER_LOGIN,
    patient_id="your-patient-id",
    payload={},
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "user_login",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "payload": {}
    }
  ]
}

Related types: Use user_logout for logout, content_interaction or feature_usage for content or feature interaction, task_outcome for task completion.

User logout

Type: user_logout · Source: SDK / REST · Extensible Reserved for logout events: app logout; optional metadata. Payload

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.USER_LOGOUT,
    patient_id="your-patient-id",
    payload={},
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "user_logout",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "payload": {}
    }
  ]
}

Related types: Use user_login for login. Not intended for other engagement (content_interaction, task_outcome, etc.).

Content interaction

Type: content_interaction · Source: SDK / REST · Extensible Reserved for user actions on content (view, bookmark, dismiss, etc.): content_type + action (viewed, bookmarked, dismissed, completed, shared, clicked); content_id, dwell_time_seconds optional. Payload

string

required

Client-defined (e.g. card, article, video, recipe).. Example: card, article, video

string

required

User action on the content item.. One of: viewed, bookmarked, dismissed, completed, shared, clicked

string

Identifier of the content item.

string

Display title of the content item.

string

Short preview or excerpt shown to the user.

integer

Time spent viewing. Populated for viewed actions.

string

Reason for the action. Relevant for dismissed actions.

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.CONTENT_INTERACTION,
    patient_id="your-patient-id",
    payload={
        "content_type": "card",
        "action": "viewed"
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "content_interaction",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "payload": {
        "content_type": "card",
        "action": "viewed"
    }
    }
  ]
}

Related types: Use notification_interaction for notification interaction, task_outcome for task completion, feature_usage for feature use.

Notification interaction

Type: notification_interaction · Source: SDK / REST · Extensible Reserved for push notification interactions: notification_type + action (opened, dismissed, snoozed); delivered_at, time_to_open_seconds optional. Payload

string

required

Client-defined (e.g. medication_reminder, symptom_checkin, lab_result).. Example: medication_reminder, symptom_checkin, lab_result

string

required

How the user interacted with the notification.. One of: opened, dismissed, snoozed

string

ISO 8601 UTC datetime when the notification was delivered.

integer

Seconds between delivery and opening. Populated for opened actions.

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.NOTIFICATION_INTERACTION,
    patient_id="your-patient-id",
    payload={
        "notification_type": "medication_reminder",
        "action": "opened"
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "notification_interaction",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "payload": {
        "notification_type": "medication_reminder",
        "action": "opened"
    }
    }
  ]
}

Related types: Use content_interaction for content interaction, task_outcome for task, interaction_feedback for in-app message feedback.

Task outcome

Type: task_outcome · Source: SDK / REST · Extensible Reserved for completion or skip of a discrete task or flow: task_type + action (completed/skipped); task_id, task_description, completion_time_seconds optional. Payload

string

required

Client-defined (e.g. checkin, questionnaire, onboarding_step, medication_log).. Example: checkin, questionnaire, onboarding_step

string

required

Whether the task was completed or skipped.. One of: completed, skipped

string

Reference to the specific task instance.

string

Human-readable description of the task.

integer

Time taken to complete the task in seconds.

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.TASK_OUTCOME,
    patient_id="your-patient-id",
    payload={
        "task_type": "checkin",
        "action": "completed"
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "task_outcome",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "payload": {
        "task_type": "checkin",
        "action": "completed"
    }
    }
  ]
}

Related types: Use questionnaire_response for questionnaire response content, content_interaction for content view, feature_usage for feature use.

Interaction feedback

Type: interaction_feedback · Source: SDK / REST · Extensible Reserved for explicit user feedback on a system-generated item: target_type (e.g. message, content) + feedback_type (e.g. thumbs_up, flagged); target_id optional. Payload

string

required

e.g. message, content or client-defined.. Example: message, content

string

Identifier of the item that received feedback.

string

required

e.g. thumbs_up, thumbs_down, bookmarked, flagged.. Example: thumbs_up, thumbs_down, flagged

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.INTERACTION_FEEDBACK,
    patient_id="your-patient-id",
    payload={
        "target_type": "message",
        "feedback_type": "thumbs_up"
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "interaction_feedback",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "payload": {
        "target_type": "message",
        "feedback_type": "thumbs_up"
    }
    }
  ]
}

Related types: Use content_interaction for content action like bookmark, task_outcome for task skip, notification_interaction for notification.

Feature usage

Type: feature_usage · Source: SDK / REST · Extensible Reserved for interaction with a named app feature: feature_name; session_id, dwell_time_seconds optional. Payload

string

required

Name of the app feature used. Client-defined string.

string

Session identifier linking multiple feature_usage events in one app session.

integer

Time spent in the feature in seconds.

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.FEATURE_USAGE,
    patient_id="your-patient-id",
    payload={
        "feature_name": "..."
    },
)

POST /v1/logs/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "logs": [
    {
      "log_type": "feature_usage",
      "patient_id": "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
      "timestamp": "2026-03-18T09:00:00Z",
      "payload": {
        "feature_name": "..."
    }
    }
  ]
}

Related types: Use content_interaction for content item action, task_outcome for task, user_login or user_logout for login/logout.

​User login

​User logout

​Content interaction

​Notification interaction

​Task outcome

​Interaction feedback

​Feature usage

User login

User logout

Content interaction

Notification interaction

Task outcome

Interaction feedback

Feature usage