hog_flows

post/api/projects/{project_id}/hog_flows/{id}/batch_jobs/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/hog_flows/{id}/batch_jobs/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this hog flow.

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

idstring uuid required

ID of the batch run.

status'waiting' | 'queued' | 'active' | 'completed' | 'cancelled' | 'failed'
  • waiting - Waiting
  • queued - Queued
  • active - Active
  • completed - Completed
  • cancelled - Cancelled
  • failed - Failed
hog_flowstring uuid required

ID of the workflow this batch run belongs to.

filtersunknown required
variablesunknown
created_atstring date-time required

When the batch run was created.

updated_atstring date-time required

When the batch run was last updated.

Response

idstring uuid required

ID of the batch run.

status'waiting' | 'queued' | 'active' | 'completed' | 'cancelled' | 'failed'
  • waiting - Waiting
  • queued - Queued
  • active - Active
  • completed - Completed
  • cancelled - Cancelled
  • failed - Failed
hog_flowstring uuid required

ID of the workflow this batch run belongs to.

filtersunknown required
variablesunknown
created_atstring date-time required

When the batch run was created.

updated_atstring date-time required

When the batch run was last updated.

Changes

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