{ "opencollection": "1.0.0", "info": { "name": "PostHog actions hog_functions API", "version": "1.0.0" }, "items": [ { "info": { "name": "hog_functions", "type": "folder" }, "items": [ { "info": { "name": "environments_hog_functions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/", "params": [ { "name": "created_at", "value": "", "type": "query" }, { "name": "created_by", "value": "", "type": "query" }, { "name": "enabled", "value": "", "type": "query" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "search", "value": "", "type": "query", "description": "A search term." }, { "name": "type", "value": "", "type": "query", "description": "Multiple values may be separated by commas." }, { "name": "updated_at", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." } ] }, "docs": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true" }, { "info": { "name": "environments_hog_functions_enable_backfills_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/enable_backfills/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_hog_functions_invocations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/invocations/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/logs/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return entries after this ISO 8601 timestamp." }, { "name": "before", "value": "", "type": "query", "description": "Only return entries before this ISO 8601 timestamp." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter logs to a specific execution instance." }, { "name": "level", "value": "", "type": "query", "description": "Comma-separated log levels to include, e.g. 'WARN,ERROR'. Valid levels: DEBUG, LOG, INFO, WARN, ERROR." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to return (1-500, default 50)." }, { "name": "search", "value": "", "type": "query", "description": "Case-insensitive substring search across log messages." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_metrics_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/metrics/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Start of the time range. Accepts relative formats like '-7d', '-24h' or ISO 8601 timestamps. Defaults to '-7d'." }, { "name": "before", "value": "", "type": "query", "description": "End of the time range. Same format as 'after'. Defaults to now." }, { "name": "breakdown_by", "value": "", "type": "query", "description": "Group the series by metric 'name' or 'kind'. Defaults to 'kind'.\n\n* `name` - name\n* `kind` - kind" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter metrics to a specific execution instance." }, { "name": "interval", "value": "", "type": "query", "description": "Time bucket size for the series. One of: hour, day, week. Defaults to 'day'.\n\n* `hour` - hour\n* `day` - day\n* `week` - week" }, { "name": "kind", "value": "", "type": "query", "description": "Comma-separated metric kinds to filter by, e.g. 'success,failure'." }, { "name": "name", "value": "", "type": "query", "description": "Comma-separated metric names to filter by." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_metrics_totals_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/metrics/totals/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Start of the time range. Accepts relative formats like '-7d', '-24h' or ISO 8601 timestamps. Defaults to '-7d'." }, { "name": "before", "value": "", "type": "query", "description": "End of the time range. Same format as 'after'. Defaults to now." }, { "name": "breakdown_by", "value": "", "type": "query", "description": "Group the series by metric 'name' or 'kind'. Defaults to 'kind'.\n\n* `name` - name\n* `kind` - kind" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter metrics to a specific execution instance." }, { "name": "interval", "value": "", "type": "query", "description": "Time bucket size for the series. One of: hour, day, week. Defaults to 'day'.\n\n* `hour` - hour\n* `day` - day\n* `week` - week" }, { "name": "kind", "value": "", "type": "query", "description": "Comma-separated metric kinds to filter by, e.g. 'success,failure'." }, { "name": "name", "value": "", "type": "query", "description": "Comma-separated metric names to filter by." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_icon_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/icon/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] } }, { "info": { "name": "environments_hog_functions_icons_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/icons/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] } }, { "info": { "name": "environments_hog_functions_rearrange_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/rearrange/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update the execution order of multiple HogFunctions." }, { "info": { "name": "hog_functions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/", "params": [ { "name": "created_at", "value": "", "type": "query" }, { "name": "created_by", "value": "", "type": "query" }, { "name": "enabled", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." }, { "name": "type", "value": "", "type": "query", "description": "Multiple values may be separated by commas." }, { "name": "updated_at", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "hog_functions_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "hog_functions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "hog_functions_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "hog_functions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "hog_functions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ] }, "docs": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true" }, { "info": { "name": "hog_functions_enable_backfills_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/enable_backfills/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "hog_functions_invocations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/invocations/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "hog_functions_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/logs/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return entries after this ISO 8601 timestamp." }, { "name": "before", "value": "", "type": "query", "description": "Only return entries before this ISO 8601 timestamp." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter logs to a specific execution instance." }, { "name": "level", "value": "", "type": "query", "description": "Comma-separated log levels to include, e.g. 'WARN,ERROR'. Valid levels: DEBUG, LOG, INFO, WARN, ERROR." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to return (1-500, default 50)." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "search", "value": "", "type": "query", "description": "Case-insensitive substring search across log messages." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "hog_functions_metrics_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/metrics/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Start of the time range. Accepts relative formats like '-7d', '-24h' or ISO 8601 timestamps. Defaults to '-7d'." }, { "name": "before", "value": "", "type": "query", "description": "End of the time range. Same format as 'after'. Defaults to now." }, { "name": "breakdown_by", "value": "", "type": "query", "description": "Group the series by metric 'name' or 'kind'. Defaults to 'kind'.\n\n* `name` - name\n* `kind` - kind" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter metrics to a specific execution instance." }, { "name": "interval", "value": "", "type": "query", "description": "Time bucket size for the series. One of: hour, day, week. Defaults to 'day'.\n\n* `hour` - hour\n* `day` - day\n* `week` - week" }, { "name": "kind", "value": "", "type": "query", "description": "Comma-separated metric kinds to filter by, e.g. 'success,failure'." }, { "name": "name", "value": "", "type": "query", "description": "Comma-separated metric names to filter by." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "hog_functions_metrics_totals_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/metrics/totals/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Start of the time range. Accepts relative formats like '-7d', '-24h' or ISO 8601 timestamps. Defaults to '-7d'." }, { "name": "before", "value": "", "type": "query", "description": "End of the time range. Same format as 'after'. Defaults to now." }, { "name": "breakdown_by", "value": "", "type": "query", "description": "Group the series by metric 'name' or 'kind'. Defaults to 'kind'.\n\n* `name` - name\n* `kind` - kind" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter metrics to a specific execution instance." }, { "name": "interval", "value": "", "type": "query", "description": "Time bucket size for the series. One of: hour, day, week. Defaults to 'day'.\n\n* `hour` - hour\n* `day` - day\n* `week` - week" }, { "name": "kind", "value": "", "type": "query", "description": "Comma-separated metric kinds to filter by, e.g. 'success,failure'." }, { "name": "name", "value": "", "type": "query", "description": "Comma-separated metric names to filter by." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "hog_functions_icon_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/icon/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ] } }, { "info": { "name": "hog_functions_icons_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/icons/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ] } }, { "info": { "name": "hog_functions_rearrange_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/rearrange/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update the execution order of multiple HogFunctions." } ] } ], "bundled": true }