Desk

Get Desk Home Summary

Goal progress, streak, digest and tomorrow's preview, in one read.

since narrows the digest lookback in the app. It is not published: it defaults to the last 24 hours, is capped at seven days, and exposing it would publish a knob whose only effect is to skip a 60-second cache.

get/desk/home-summary

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/desk/home-summary
  • Auth: HTTP bearer

Query parameters

tz_offsetinteger

The rep's UTC offset in MINUTES (local = UTC + tz_offset). The desk day is the rep's LOCAL day; a wrong offset silently returns the wrong day rather than erroring.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataDeskPayload required

An open envelope for one desk object.

Open on purpose - see the module docstring. A rebuilder gets every field the desk returns, including ones added after this contract version.

Changes

No recorded changes to this operation across all 2 revisions of this API.