provider marketing_analytics GET /api/projects/{project_id}/marketing_analytics/explain_conversion_goal/
@utdk/posthog /api/projects/{project_id}/marketing_analytics/explain_conversion_goal/
Explain a conversion goal
Break down a single conversion goal's events over a period by event name, utm_source, and matched integration, with a small sample of events. Read-only.
date_from query
ISO start; defaults to 30 days ago
stringnull
date_to query
ISO end; defaults to now
stringnull
goal_id query required
Id of the conversion goal to explain (from list_conversion_goals).
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

Try it

Authentication
Configure credentials for PostHog API
marketingAnalyticsExplainConversionGoalRetrieve
GET/api/projects/{project_id}/marketing_analytics/explain_conversion_goal/
Break down a single conversion goal's events over a period by event name, utm_source, and matched integration, with a small sample of events. Read-only.

Parameters

required

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

ISO start; defaults to 30 days ago

ISO end; defaults to now

required

Id of the conversion goal to explain (from list_conversion_goals).

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.marketingAnalyticsExplainConversionGoalRetrieve()