today

List today's ranked items

The items behind today's briefing, with the facts and the reason for each, without the written text.

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

Request

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

local_daystring date required

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

more_reports_countinteger required

Other open reports for the person not in the list.

Changes

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