hog_flows

One published version's series. Every hog flow metric is mirrored under hog_flow_version with the version appended to the id, which is what makes "before and after this change" answerable at all. The unversioned read keys batch and broadcast runs on the run instead, so it is not the sum of the versions.

get/api/projects/{project_id}/hog_flows/{id}/metrics/version/

Request

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

Query parameters

afterstring

Start of the time range. Accepts relative formats like '-7d', '-24h' or ISO 8601 timestamps. Defaults to '-7d'.

beforestring

End of the time range. Same format as 'after'. Defaults to now.

breakdown_by'name' | 'kind'

Group the series by metric 'name' or 'kind'. Defaults to 'kind'.

  • name - name
  • kind - kind
instance_idstring

Filter metrics to a specific execution instance.

interval'hour' | 'day' | 'week'

Time bucket size for the series. One of: hour, day, week. Defaults to 'day'.

  • hour - hour
  • day - day
  • week - week
kindstring

Comma-separated metric kinds to filter by, e.g. 'success,failure'.

namestring

Comma-separated metric names to filter by.

versioninteger required

Read one workflow version's series: every run of that version, keyed on the workflow. The unversioned read keys batch and broadcast runs on the run instead, so it is not the sum of the versions; compare versions with each other, not with it.

Response

labelsstring[] required

Changes

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