today

Get today's briefing

Today's personal briefing: a short text about up to 5 items and the same items for the left bar. A new one is written every morning from 8:00 local time. Starts generating today's when there is none yet and returns it as 'collecting'. While a refresh is being written, the ready briefing is returned as 'writing', so it can stay on screen; poll again after a few seconds. 404 when the person gets no briefing: the flag is off, the organization has not approved AI data processing, or it is out of AI credits.

get/api/projects/{project_id}/today/briefing/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/today/briefing/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

timezonestring

IANA timezone of the person's browser, for example Europe/Prague. The briefing day starts at 8:00 in it. Defaults to the project timezone.

Response

idstring required

Briefing id.

local_daystring date required

The day this briefing is for, in the person's timezone.

headlinestring required

One sentence that counts what needs the person.

more_reports_countinteger required

Other open reports for the person, beyond the ones the briefing shows.

open_reports_countinteger required

Open reports in the whole project beyond the ones the briefing shows, whoever they are for.

status'collecting' | 'writing' | 'ready' | 'failed' required
  • collecting - COLLECTING
  • writing - WRITING
  • ready - READY
  • failed - FAILED
created_atstring date-time required
ready_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.