hog_functions
hog_functions

get/api/projects/{project_id}/hog_functions/{id}/metrics/totals/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/hog_functions/{id}/metrics/totals/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this hog function.

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.

Response

totalsobject required

Changes

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