Sign in
analytics

Communications sent to each patient

Changed on

Patients with at least one email, push or Spoki message in the period, with the outcome of the emails. A coordinator sees the patients of their perimeter.

get/api/analytics/communications/tracking

Request

  • Base URL: https://api.corabea.it (the document declares no server; this is the origin it was published from)
  • URL: https://api.corabea.it/api/analytics/communications/tracking
  • Auth: HTTP bearer

Query parameters

from_datestring date nullable
to_datestring date nullable
target_statusstring nullable

Patient state, with or without the path suffix

searchstring nullable

Part of the name or of the email

only_unengagedboolean

Only patients with tracked emails and no open or click

include_remindersboolean

Count the fixed daily reminders too

sort_by'full_name' | 'status' | 'email' | 'push' | 'spoki' | 'last_sent_at' | 'last_interaction_at'
sort_dir'asc' | 'desc'
per_pageinteger
pageinteger

Response

Successful Response

generated_atstring date-time required
from_datestring date nullable
to_datestring date nullable
email_tracking_activeboolean required

Whether the emails sent now are tracked

spoki_tracking_activeboolean required

Whether Spoki reports what happens to its messages

push_tracking_activeboolean

Whether taps on push notifications are collected

totalinteger required
per_pageinteger required
pageinteger required

Changes

  • 56fb7cd45f64Revision changes
    • ○

      added the optional property /// to the response with the status

    • ○

      added the optional property /// to the response with the status

    • ○

      added the optional property /// to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the required property to the response with the status

  • 17eafc2c8d6aRevision changes
    • ○

      endpoint added