provider hog_flows GET /api/projects/{project_id}/hog_flows/{id}/assets/
@utdk/posthog /api/projects/{project_id}/hog_flows/{id}/assets/
hog_flows_assets_retrieve
action_id query
Only return assets sent by this email step (action node id) — used to drill in from a step's metric.
string
after query
Start of the time range, matched on sent time. Relative ('-30d', '-24h') or ISO 8601. Defaults to -30d (the retention window) — bounds the ClickHouse partition scan.
string
before query
End of the time range, matched on sent time. Same format as 'after'. Defaults to now.
string
distinct_id query
Only return assets sent to this distinct_id.
string
id path required
A UUID string identifying this hog flow.
string
invocation_id query
Only return the asset for this specific workflow run — used to deep-link from a single log entry to the email it sent. Returns 0 rows when the send had no captured asset (text-only, kill-switch off, or standalone email).
string
limit query
Maximum number of assets to return (1-500, default 50).
integer
offset query
Number of assets to skip, for pagination.
integer
parent_run_id query
Only return assets for this batch run (HogFlowBatchJob id). Pass an empty string to return only event-triggered (non-batch) assets; omit to return all.
string
project_id path required
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
string
search query
Case-insensitive substring match on recipient email or subject.
string

Try it

Authentication
Configure credentials for PostHog API
hogFlowsAssetsRetrieve
GET/api/projects/{project_id}/hog_flows/{id}/assets/

Parameters

required

A UUID string identifying this hog flow.

required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Only return assets sent by this email step (action node id) — used to drill in from a step's metric.

Start of the time range, matched on sent time. Relative ('-30d', '-24h') or ISO 8601. Defaults to -30d (the retention window) — bounds the ClickHouse partition scan.

End of the time range, matched on sent time. Same format as 'after'. Defaults to now.

Only return assets sent to this distinct_id.

Only return the asset for this specific workflow run — used to deep-link from a single log entry to the email it sent. Returns 0 rows when the send had no captured asset (text-only, kill-switch off, or standalone email).

Maximum number of assets to return (1-500, default 50).

Number of assets to skip, for pagination.

Only return assets for this batch run (HogFlowBatchJob id). Pass an empty string to return only event-triggered (non-batch) assets; omit to return all.

Case-insensitive substring match on recipient email or subject.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.hogFlowsAssetsRetrieve({
  "after": "-30d",
  "limit": 50,
  "offset": 0
})