PostHog product_analytics API is one of 139 APIs that PostHog publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Product Analytics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, and an AsyncAPI specification.
This API exposes
50 operations
across 32 paths,
and defines 357 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://app.posthog.com/api.
The identity and technical contract details declared by the specification.
FunnelCorrelationQuery
object
10 properties
2 required
RETENTION
object
3 properties
DataTableNode
object
38 properties
1 required
PropertyGroupFilter
object
2 properties
2 required
RevenueAnalyticsTopCustomersQuery
object
8 properties
2 required
HogQLVariable
object
4 properties
2 required
TrendsFilter
object
30 properties
ChartAxis
object
2 properties
1 required
HogQueryResponse
object
4 properties
1 required
SessionData
object
4 properties
4 required
PersonPropertyFilter
object
5 properties
2 required
ExperimentQueryResponse
object
16 properties
CompareFilter
object
2 properties
_InsightQuerySchema
The query definition for this insight. The kind field determines the query type: - InsightVizNode — product analytics (trends, funnels, retention, paths, stick…
PersonsArgMaxVersion
string
GroupsQuery
object
12 properties
1 required
UserBasic
object
9 properties
4 required
BounceRatePageViewMode
string
ExperimentRetentionMetric
object
19 properties
6 required
PatchedInsight
object
Simplified serializer to speed response times when loading large amounts of objects.
36 properties
Breakdown
object
5 properties
1 required
StickinessQuery
object
15 properties
1 required
NonIntegratedConversionsTableQuery
object
23 properties
1 required
QueryTiming
object
2 properties
2 required
ExperimentFunnelsQuery
object
10 properties
1 required
MultipleVariantHandling
string
BoxPlotDatum
object
10 properties
8 required
EventOddsRatioSerialized
object
5 properties
5 required
InlineCohortCalculation
string
MaterializedColumnsOptimizationMode
string
CohortPropertyFilter
object
6 properties
1 required
DataTableNodeViewPropsContextType
string
CustomChannelOperator
string
FunnelsQueryResponse
object
7 properties
1 required
LLMTracePerson
object
4 properties
4 required
WebStatsTableQueryResponse
object
14 properties
1 required
LifecycleQueryResponse
object
7 properties
1 required
TraceQuery
object
8 properties
1 required
HogQLMetadataResponse
object
8 properties
3 required
LogPropertyFilter
object
5 properties
3 required
WebStatsTableQuery
object
26 properties
2 required
WebVitalsQuery
object
20 properties
2 required
SessionAttributionGroupBy
string
FunnelPathsFilter
object
3 properties
1 required
SamplingRate
object
2 properties
1 required
CustomChannelRule
object
4 properties
4 required
ExperimentMeanMetric
object
17 properties
1 required
SpanPropertyFilterType
string
TracesQuery
object
16 properties
PrecomputationMode
string
ErrorTrackingIssueStatus
string
LLMTrace
object
20 properties
4 required
RevenueAnalyticsOverviewQueryResponse
object
7 properties
1 required
WebExternalClicksTableQueryResponse
object
13 properties
1 required
RevenueExampleDataWarehouseTablesQueryResponse
object
12 properties
1 required
Response13
object
8 properties
1 required
QueryStatus
object
16 properties
2 required
InsightActorsQuery
object
13 properties
1 required
Response4
object
11 properties
1 required
Response9
object
12 properties
1 required
ExperimentEventExposureConfig
object
5 properties
2 required
SpanPropertyFilter
object
5 properties
3 required
TraceQueryResponse
object
11 properties
1 required
SessionAttributionExplorerQueryResponse
object
12 properties
1 required
Response10
object
12 properties
4 required
PropertyGroupFilterValue
object
2 properties
2 required
FirstEvent
object
4 properties
4 required
Response20
object
13 properties
1 required
Response11
object
8 properties
1 required
RevenueExampleEventsQuery
object
7 properties
RevenueAnalyticsPropertyFilter
object
5 properties
2 required
PathCleaningFilter
object
3 properties
GroupPropertyFilter
object
7 properties
2 required
ConversionGoalFilter2
object
19 properties
4 required
WebOverviewItem
object
7 properties
2 required
ResultCustomizationByPosition
object
3 properties
FunnelsActorsQuery
object
11 properties
1 required
EventPropertyFilter
object
5 properties
1 required
ErrorTrackingIssueAssignee
object
2 properties
2 required
RevenueAnalyticsGrossRevenueQuery
object
9 properties
3 required
LifecycleQuery
object
15 properties
1 required
ErrorTrackingIssueAssigneeType
string
StickinessActorsQuery
object
11 properties
1 required
TableSettings
object
4 properties
MarketingAnalyticsOrderByEnum
string
Element
object
9 properties
ExperimentVariantTrendsBaseStats
object
4 properties
4 required
RevenueAnalyticsOverviewItem
object
2 properties
2 required
PathsLink
object
4 properties
4 required
RevenueAnalyticsMetricsQueryResponse
object
8 properties
1 required
IntegrationFilter
object
1 property
CalendarHeatmapMathType
string
ErrorTrackingPendingFingerprintIssueStateUpdate
object
10 properties
6 required
ExperimentFunnelMetric
object
15 properties
1 required
Response8
object
7 properties
1 required
RevenueAnalyticsMRRQueryResponse
object
8 properties
1 required
ClickhouseQueryProgress
object
5 properties
5 required
PaginatedElementList
object
4 properties
2 required
TrendsFormulaNode
object
2 properties
1 required
MarketingAnalyticsItem
object
7 properties
2 required
RevenueCurrencyPropertyConfig
object
2 properties
RetentionQueryResponse
object
7 properties
1 required
RetentionValue
object
3 properties
1 required
EventsQuery
object
21 properties
1 required
VizSpecificOptions
object
2 properties
ConversionGoalFilter1
object
21 properties
3 required
CustomChannelField
string
RoleAtOrganizationEnum
string
engineering - Engineering data - Data product - Product Management founder - Founder leadership - Leadership marketing - Marketing sales - Sales / Success othe…
HeatmapSettings
object
12 properties
Response24
object
11 properties
7 required
WebOverviewQuery
object
19 properties
1 required
SessionPropertyFilter
object
5 properties
2 required
ExperimentSignificanceCode
string
Response3
object
16 properties
1 required
ExperimentTrendsQuery
object
11 properties
1 required
PersonsNode
object
12 properties
WebVitalsPathBreakdownQuery
object
22 properties
4 required
ActionsPie
object
2 properties
EndpointsUsageOrderByDirection
string
WebVitalsPathBreakdownResult
object
3 properties
3 required
ErrorTrackingIssueAggregations
object
5 properties
4 required
DateRange
object
3 properties
Population
object
4 properties
4 required
ErrorTrackingExternalReference
object
3 properties
3 required
RevenueAnalyticsTopCustomersQueryResponse
object
8 properties
1 required
ExperimentVariantResultBayesian
object
17 properties
4 required
Response19
object
8 properties
1 required
SessionsV2JoinMode
string
DataWarehousePropertyFilter
object
5 properties
2 required
PaginatedInsightList
object
4 properties
2 required
DashboardTileBasic
object
3 properties
2 required
ExperimentFunnelsQueryResponse
object
10 properties
7 required
FunnelsFilter
object
21 properties
ActorsQueryResponse
object
13 properties
5 required
MultipleBreakdownType
string
ActionConversionGoal
object
1 property
1 required
Response6
object
13 properties
1 required
FunnelCorrelationResponse
object
12 properties
1 required
MarketingAnalyticsAggregatedQuery
object
22 properties
1 required
Response5
object
14 properties
1 required
ExperimentStatsValidationFailure
string
ResultCustomizationBy
string
RetentionDashboardDisplayType
string
PatchedElement
object
9 properties
CustomEventConversionGoal
object
1 property
1 required
SessionTableVersion
string
ExperimentQuery
object
9 properties
1 required
PersonsOnEventsMode
string
HogQLPropertyFilter
object
4 properties
1 required
ErrorTrackingCorrelatedIssue
object
13 properties
7 required
QueryLogTags
object
3 properties
SessionsQuery
object
19 properties
1 required
HeatmapGradientStop
object
2 properties
2 required
BreakdownAttributionType
string
ExperimentActorsQuery
object
12 properties
1 required
PathsFilter
object
16 properties
HogQuery
object
6 properties
YAxisSettings
object
4 properties
BreakdownFilter
object
9 properties
RevenueAnalyticsMRRQueryResultItem
object
5 properties
5 required
ResolvedDateRangeResponse
object
2 properties
2 required
Response21
object
11 properties
1 required
CustomChannelCondition
object
4 properties
3 required
DataTableNodeViewPropsContext
object
2 properties
1 required
Response23
object
10 properties
7 required
RevenueAnalyticsOverviewQuery
object
7 properties
1 required
ErrorTrackingExternalReferenceIntegration
object
3 properties
3 required
Response14
object
7 properties
1 required
StickinessCriteria
object
2 properties
2 required
RevenueAnalyticsGrossRevenueQueryResponse
object
8 properties
1 required
RetentionQuery
object
13 properties
1 required
LifecycleFilter
object
4 properties
RetentionEntity
object
11 properties
SessionAttributionExplorerQuery
object
9 properties
1 required
HogQLQueryModifiers
object
27 properties
LogEntryPropertyFilter
object
5 properties
2 required
RetentionResult
object
4 properties
3 required
WebGoalsQueryResponse
object
13 properties
1 required
Response2
object
13 properties
6 required
MaterializationMode
string
EventsNode
object
18 properties
TrendsQueryResponse
object
9 properties
1 required
RetentionFilter
object
20 properties
StickinessComputationMode
string
WebAnalyticsItemKind
string
ConditionalFormattingRule
object
7 properties
6 required
FunnelCorrelationResult
object
2 properties
2 required
EndpointsUsageTableQueryResponse
object
12 properties
1 required
HogQLNotice
object
4 properties
1 required
PathsQueryResponse
object
7 properties
1 required
HogQLFilters
object
3 properties
StickinessOperator
string
EmptyPropertyFilter
object
1 property
FunnelsDataWarehouseNode
object
21 properties
5 required
FunnelConversionWindowTimeUnit
string
ExperimentBreakdownResult
object
3 properties
3 required
ResultCustomizationByValue
object
3 properties
WebVitalsPathBreakdownResultItem
object
2 properties
2 required
EffectivePrivilegeLevelEnum
integer
InsightVizNode
object
16 properties
1 required
ErrorTrackingIssueCohort
object
2 properties
2 required
Response
object
13 properties
4 required
BulkUpdateTagsError
object
2 properties
2 required
WebGoalsQuery
object
20 properties
1 required
BulkUpdateTagsRequest
object
3 properties
3 required
DataWarehouseNode
object
21 properties
5 required
ErrorTrackingQuery
object
26 properties
3 required
ExperimentMetricGoal
string
WebAnalyticsSampling
object
2 properties
RevenueAnalyticsOverviewItemKey
string
WebOverviewQueryResponse
object
11 properties
1 required
ExperimentMetricMathType
string
ErrorTrackingIssue
object
15 properties
4 required
Response12
object
8 properties
1 required
Filters
object
2 properties
DataVisualizationNode
object
6 properties
1 required
Response22
object
11 properties
1 required
Settings
object
2 properties
Insight
object
Simplified serializer to speed response times when loading large amounts of objects.
36 properties
26 required
FunnelExclusionActionsNode
object
18 properties
3 required
FunnelCorrelationResultsType
string
WebExternalClicksTableQuery
object
21 properties
1 required
DetailedResultsAggregationType
string
MarketingAnalyticsDrillDownLevel
string
RevenueExampleEventsQueryResponse
object
12 properties
1 required
FilterLogicalOperator
string
RecordingPropertyFilter
object
5 properties
2 required
HogQLQueryResponse
object
16 properties
1 required
BulkUpdateTagsItem
object
2 properties
2 required
ExperimentRatioMetric
object
15 properties
2 required
Response25
object
11 properties
1 required
ErrorTrackingIssueFilter
object
5 properties
2 required
RevenueAnalyticsMRRQuery
object
9 properties
3 required
MeanRetentionCalculation
string
MarketingAnalyticsAggregatedQueryResponse
object
8 properties
1 required
ExperimentDataWarehouseNode
object
19 properties
4 required
EventDefinition
object
3 properties
3 required
GoalLine
object
6 properties
2 required
WebAnalyticsOrderByDirection
string
FunnelExclusionEventsNode
object
20 properties
2 required
ActionEnum
string
add - add remove - remove set - set
EndpointsUsageOrderByField
string
DataWarehousePersonPropertyFilter
object
5 properties
2 required
ChartSettings
object
17 properties
ChartSettingsDisplay
object
5 properties
AggregationAxisFormat
string
ChartSettingsFormatting
object
4 properties
ErrorTrackingIssueCorrelationQuery
object
6 properties
1 required
RetentionEntityKind
string
WebAnalyticsOrderByFields
string
EventsQueryResponse
object
13 properties
4 required
RevenueAnalyticsTopCustomersGroupBy
string
NonIntegratedConversionsTableQueryResponse
object
13 properties
1 required
EventsQueryActionStep
object
10 properties
WebVitalsPathBreakdownQueryResponse
object
7 properties
1 required
PathsQuery
object
13 properties
1 required
MarketingAnalyticsTableQueryResponse
object
13 properties
1 required
BulkUpdateTagsResponse
object
2 properties
2 required
WorkflowVariablePropertyFilter
object
5 properties
2 required
ConversionGoalFilter3
object
24 properties
8 required
FunnelStepReference
string
EventMetadataPropertyFilter
object
5 properties
2 required
StickinessFilter
object
9 properties
CountPerActorMathType
string
ExperimentStatsBaseValidated
object
13 properties
4 required
ErrorTrackingIssueCorrelationQueryResponse
object
11 properties
1 required
FunnelsQuery
object
15 properties
1 required
RevenueAnalyticsMetricsQuery
object
9 properties
3 required
RetentionReference
string
LogPropertyFilterType
string
ExperimentTrendsQueryResponse
object
11 properties
7 required
ErrorTrackingOrderBy
string
LifecycleDataWarehouseNode
object
20 properties
5 required
VolumeBucket
object
2 properties
2 required
PropertyGroupsMode
string
ExperimentVariantFunnelsBaseStats
object
3 properties
3 required
FlagPropertyFilter
object
5 properties
2 required
Response16
object
12 properties
1 required
SimpleIntervalType
string
WebVitalsPercentile
string
ElementPropertyFilter
object
5 properties
2 required
TrendsQuery
object
17 properties
1 required
FunnelCorrelationActorsQuery
object
10 properties
1 required
SessionsQueryResponse
object
12 properties
4 required
ErrorTrackingQueryResponse
object
11 properties
1 required
TracesQueryResponse
object
11 properties
1 required
LastEvent
object
4 properties
4 required
Response26
object
12 properties
1 required
ActionsNode
object
16 properties
1 required
Response1
object
13 properties
5 required
LLMTraceEvent
object
4 properties
4 required
GroupNode
object
19 properties
2 required
StickinessQueryResponse
object
7 properties
1 required
GroupsQueryResponse
object
13 properties
6 required
DataWarehouseEventsModifier
object
4 properties
4 required
RevenueExampleDataWarehouseTablesQuery
object
7 properties
RevenueAnalyticsBreakdown
object
2 properties
1 required
ActorsQuery
object
13 properties
Response18
object
13 properties
1 required
MarketingAnalyticsTableQuery
object
25 properties
1 required
FeaturePropertyFilter
object
5 properties
2 required
TaxonomicFilterGroupType
string
ExperimentVariantResultFrequentist
object
17 properties
4 required
Response15
object
8 properties
1 required
EndpointsUsageBreakdown
string
HogQLQuery
object
13 properties
1 required
AggregationPropertyType
string
MathGroupTypeIndex
number
EndpointsUsageTableQuery
object
12 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs PostHog publishes across the network.