Skip to main content

Start screentime

POST 
/screentime/start

Marks the start of active screentime on this product. While screentime is active, k-ID delivers real-time webhooks - Screentime.BreakReminder, Screentime.LimitWarning, and Screentime.LimitReached - that fire at the moment a threshold is crossed, not only when usage ends.

Status semantics:

  • accepted - screentime was started, or a retried call against an already-active session was absorbed idempotently.
  • replaced - a different id was sent while screentime was already active for this sessionId; the prior screentime was automatically ended and its duration counted toward today's screentime usage. Use this to recover when the prior screentime was never explicitly ended (e.g. after an app or device restart).

Only one active screentime is supported per sessionId at a time. Calls must be made in real time - the timestamp value cannot be more than 5 minutes in the past.

Request​

Responses​

Screentime start accepted or replaced.