hog_flows

post/api/projects/{project_id}/hog_flows/user_blast_radius/

Request

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

filtersobject required

Property filters to apply

group_type_indexinteger nullable

Group type index for group-based targeting

sends_emailboolean

Whether the workflow contains an email step. The tiered audience limit only applies to email sends; SMS, push, and webhook batches keep the flat limit. Defaults to true.

Response

affectedinteger required

Number of users matching the filters

totalinteger required

Total number of users

limitinteger required

Maximum allowed audience size for batch triggers for this team.

confirm_tokenstring required

Proof this audience was previewed: pass it to the batch dispatch (confirm_token) after echoing 'affected' to the user. Signs these exact filters; expires in 15 minutes.

Changes

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