pulse

post/api/projects/{project_id}/pulse/briefs/generate/

Request

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

Request body

config_idstring uuid nullable

Optional brief config to generate for. Omit for the zero-config default brief.

Response

idstring uuid required
configstring uuid nullable required

The brief config this brief was generated for, if any.

status'generating' | 'ready' | 'quiet' | 'failed' required
  • generating - Generating
  • ready - Ready
  • quiet - Quiet
  • failed - Failed
trigger'on_demand' | 'scheduled' required
  • on_demand - On Demand
  • scheduled - Scheduled
sources_usedstring[] required

Names of the brief sources that contributed items.

errorstring nullable required

Error detail when status is failed.

created_atstring date-time required
updated_atstring date-time nullable required

Changes

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