today

Get today's highlights

Changed on

The project's key metrics and up to 6 ranked items, each labeled risk or opportunity. Queries, rules and copy templates make every item; no AI is used. The highlights are computed in the background and stay fresh for 15 minutes per person, or 1 minute when a source failed. The call never waits: while they are computed, it returns computing with the last ready highlights of the day, so poll every 2 seconds until the status is ready or failed. 404 when the person does not have the new navigation. A scoped key needs query:read as well, because every highlight runs a query.

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

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/today/highlights/
  • 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/.

Response

status'computing' | 'ready' | 'failed' required
  • computing - Computing
  • ready - Ready
  • failed - Failed
generated_atstring date-time nullable required

When the content was computed. Null when no highlights were computed yet today.

daystring date required

The day the highlights are for, in the project's timezone.

refresh_atstring date-time required

Midnight at the end of day in the project's timezone, when the next day's highlights start. Load them again then.

Changes