How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PostHog query API

The query API from PostHog — 14 operation(s) for query.

PostHog query 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 Query. 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 16 operations across 14 paths, and defines 578 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.

16 operations 14 paths 578 schemas 2 DELETE6 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.posthog.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

PostHog query API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PersonalAPIKeyAuth).

Paths & Operations 16

Across 14 paths, the API surfaces 16 operations — 2 DELETE, 6 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

query 16
POST
/api/environments/{environment_id}/query/deprecated
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["coalescedresponse"] for followers. This mixin r…
environments_query_create 1 param body → 200
GET
/api/environments/{environment_id}/query/{id}/deprecated
(Experimental)
environments_query_retrieve 2 params → 200
DELETE
/api/environments/{environment_id}/query/{id}/deprecated
(Experimental)
environments_query_destroy 2 params → 204
GET
/api/environments/{environment_id}/query/{id}/log/deprecated
Get query log details from querylogarchive table for a specific queryid, the query must have been issued in last 24 hours.
environments_query_log_retrieve 2 params → 200
POST
/api/environments/{environment_id}/query/{query_kind}/deprecated
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["coalescedresponse"] for followers. This mixin r…
environments_query_create_with_kind 2 params → 200
POST
/api/environments/{environment_id}/query/check_auth_for_async/deprecated
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["coalescedresponse"] for followers. This mixin r…
environments_query_check_auth_for_async_create 1 param → 200
GET
/api/environments/{environment_id}/query/draft_sql/deprecated
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["coalescedresponse"] for followers. This mixin r…
environments_query_draft_sql_retrieve 1 param → 200
POST
/api/environments/{environment_id}/query/upgrade/deprecated
Upgrades a query without executing it. Returns a query with all nodes migrated to the latest version.
environments_query_upgrade_create 1 param body → 200
POST
/api/projects/{project_id}/query/
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["coalescedresponse"] for followers. This mixin r…
query_create 1 param body → 200
GET
/api/projects/{project_id}/query/{id}/
(Experimental)
query_retrieve 2 params → 200
DELETE
/api/projects/{project_id}/query/{id}/
(Experimental)
query_destroy 2 params → 204
GET
/api/projects/{project_id}/query/{id}/log/
Get query log details from querylogarchive table for a specific queryid, the query must have been issued in last 24 hours.
query_log_retrieve 2 params → 200
POST
/api/projects/{project_id}/query/{query_kind}/
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["coalescedresponse"] for followers. This mixin r…
query_create_with_kind 2 params → 200
POST
/api/projects/{project_id}/query/check_auth_for_async/
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["coalescedresponse"] for followers. This mixin r…
query_check_auth_for_async_create 1 param → 200
GET
/api/projects/{project_id}/query/draft_sql/
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["coalescedresponse"] for followers. This mixin r…
query_draft_sql_retrieve 1 param → 200
POST
/api/projects/{project_id}/query/upgrade/
Upgrades a query without executing it. Returns a query with all nodes migrated to the latest version.
query_upgrade_create 1 param body → 200

Schemas 578

The contract defines 578 schemas that model the data the API accepts and returns. The most detailed are SavedInsightNode (44 properties), DataTableNode (38 properties), TrendsFilter (30 properties), SessionRecordingType (30 properties). Each schema is shown below with its type and property counts.

FunnelCorrelationQuery
object
10 properties 2 required
QueryResponseAlternative3
object
13 properties 5 required
QueryResponseAlternative22
object
10 properties 1 required
MaterializationType
QueryResponseAlternative8
object
16 properties 1 required
RETENTION
object
3 properties
QueryResponseAlternative86
object
7 properties 1 required
DataTableNode
object
38 properties 1 required
PropertyGroupFilter
object
2 properties 2 required
QueryResponseAlternative47
object
7 properties 1 required
DatabaseSchemaEndpointTable
object
7 properties 4 required
RevenueAnalyticsTopCustomersQuery
object
8 properties 2 required
EmbeddedDocument
object
4 properties 4 required
QueryResponseAlternative48
object
12 properties 1 required
Integration
object
3 properties 3 required
HogQLVariable
object
4 properties 2 required
TrendsFilter
object
30 properties
ChartAxis
object
2 properties 1 required
QueryResponseAlternative91
object
7 properties 1 required
YAxisScaleType
string
SessionData
object
4 properties 4 required
HogQueryResponse
object
4 properties 1 required
PersonPropertyFilter
object
5 properties 2 required
ExperimentQueryResponse
object
16 properties
CompareFilter
object
2 properties
PersonsArgMaxVersion
string
BreakdownValue
object
2 properties 2 required
RetentionType
string
GroupsQuery
object
12 properties 1 required
DisplayType
string
BounceRatePageViewMode
string
QueryResponseAlternative15
object
10 properties 1 required
CalendarHeatmapQuery
object
15 properties 1 required
ExperimentRetentionMetric
object
19 properties 6 required
YAxisPosition
string
IntegrationKind
string
Breakdown
object
5 properties 1 required
StickinessQuery
object
15 properties 1 required
NonIntegratedConversionsTableQuery
object
23 properties 1 required
QueryResponseAlternative6
object
8 properties 1 required
QueryTiming
object
2 properties 2 required
ExperimentExposureTimeSeries
object
3 properties 3 required
LifecycleToggle
string
DurationType
string
SuggestedQuestionsQuery
object
5 properties
VectorSearchQueryResponse
object
7 properties 1 required
ExperimentFunnelsQuery
object
10 properties 1 required
ErrorTrackingSimilarIssuesQueryResponse
object
10 properties 1 required
QueryResponseAlternative68
object
7 properties 1 required
MultipleVariantHandling
string
BoxPlotDatum
object
10 properties 8 required
PropertyType
string
QueryResponseAlternative53
object
7 properties 1 required
DatabaseSchemaSystemTable
object
5 properties 3 required
QueryResponseAlternative78
object
11 properties 1 required
UsageMetricsQueryResponse
object
7 properties 1 required
EventOddsRatioSerialized
object
5 properties 5 required
TeamTaxonomyQueryResponse
object
10 properties 1 required
InlineCohortCalculation
string
MaterializedColumnsOptimizationMode
string
RefreshType
string
EventsHeatMapDataResult
object
3 properties 3 required
QueryResponseAlternative66
object
9 properties 1 required
UsageMetricsQuery
object
8 properties
HedgehogActorSkinOption
string
LimitContext
CohortPropertyFilter
object
6 properties 1 required
DataTableNodeViewPropsContextType
string
LogsQuery
object
17 properties 4 required
CustomChannelOperator
string
EventTaxonomyQueryResponse
object
10 properties 1 required
LLMTracePerson
object
4 properties 4 required
FunnelsQueryResponse
object
7 properties 1 required
QueryResponseAlternative81
object
10 properties 1 required
WebStatsTableQueryResponse
object
14 properties 1 required
ActorsPropertyTaxonomyResponse
object
2 properties 2 required
LifecycleQueryResponse
object
7 properties 1 required
TraceQuery
object
8 properties 1 required
HogQLMetadataResponse
object
8 properties 3 required
QueryResponseAlternative60
object
11 properties 1 required
LogPropertyFilter
object
5 properties 3 required
WebStatsTableQuery
object
26 properties 2 required
WebVitalsQuery
object
20 properties 2 required
EventsHeatMapColumnAggregationResult
object
2 properties 2 required
SessionAttributionGroupBy
string
FunnelPathsFilter
object
3 properties 1 required
SamplingRate
object
2 properties 1 required
PersonsJoinMode
string
CustomChannelRule
object
4 properties 4 required
ExperimentMeanMetric
object
17 properties 1 required
HogQLAutocomplete
object
13 properties 4 required
SpanPropertyFilterType
string
TracesQuery
object
16 properties
QueryResponseAlternative45
object
13 properties 1 required
PrecomputationMode
string
ErrorTrackingIssueStatus
string
LLMTrace
object
20 properties 4 required
RevenueAnalyticsOverviewQueryResponse
object
7 properties 1 required
WebExternalClicksTableQueryResponse
object
13 properties 1 required
ActorsPropertyTaxonomyQueryResponse
object
7 properties 1 required
WebTrendsQuery
object
22 properties 3 required
RevenueExampleDataWarehouseTablesQueryResponse
object
12 properties 1 required
EventType
object
11 properties 6 required
FunnelPathType
string
DatabaseSchemaMaterializedViewTable
object
8 properties 4 required
QueryResponseAlternative44
object
14 properties 1 required
Response13
object
8 properties 1 required
QueryResponseAlternative19
object
11 properties 7 required
QueryResponseAlternative31
object
8 properties 1 required
QueryStatus
object
16 properties 2 required
DatabaseSchemaQuery
object
6 properties
InsightActorsQuery
object
13 properties 1 required
Response4
object
11 properties 1 required
Response9
object
12 properties 1 required
MatchedRecordingEvent
object
2 properties 2 required
QueryResponseAlternative40
object
13 properties 5 required
ExperimentEventExposureConfig
object
5 properties 2 required
ExperimentExposureQuery
object
12 properties 2 required
SpanPropertyFilter
object
5 properties 3 required
QueryResponseAlternative10
object
3 properties 2 required
QueryResponseAlternative58
object
8 properties 1 required
TraceQueryResponse
object
11 properties 1 required
DistanceFunc
string
PropertyMathType
string
SessionAttributionExplorerQueryResponse
object
12 properties 1 required
QueryResponseAlternative35
object
8 properties 1 required
DatabaseSchemaViewTable
object
6 properties 4 required
Response10
object
12 properties 4 required
WebPageURLSearchQuery
object
22 properties 1 required
PropertyGroupFilterValue
object
2 properties 2 required
Metric
string
FirstEvent
object
4 properties 4 required
Response20
object
13 properties 1 required
WebAnalyticsExternalSummaryQuery
object
5 properties 2 required
ErrorTrackingBreakdownsQuery
object
10 properties 2 required
MatchedOn
string
Response11
object
8 properties 1 required
PropertyValueItem
object
2 properties
StartHandling
string
RevenueExampleEventsQuery
object
7 properties
RevenueAnalyticsPropertyFilter
object
5 properties 2 required
QueryResponseAlternative59
object
13 properties 1 required
PathCleaningFilter
object
3 properties
PropertyValuesQueryResponse
object
7 properties 1 required
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
UrlMatching
ErrorTrackingIssueAssignee
object
2 properties 2 required
EventPropertyFilter
object
5 properties 1 required
SessionRecordingExternalReference
object
6 properties 5 required
AggregationType
string
LifecycleQuery
object
15 properties 1 required
LogsOrderBy
string
RevenueAnalyticsGrossRevenueQuery
object
9 properties 3 required
ErrorTrackingIssueAssigneeType
string
SessionsTimelineQuery
object
8 properties
StickinessActorsQuery
object
11 properties 1 required
QueryResponseAlternative42
object
16 properties 1 required
TraceNeighborsQueryResponse
object
5 properties
QueryResponseAlternative69
object
7 properties 1 required
TableSettings
object
4 properties
OrderDirection2
string
MarketingAnalyticsOrderByEnum
string
UsageMetricDisplay
string
Key10
string
DatabaseSchemaSource
object
6 properties 4 required
ExperimentVariantTrendsBaseStats
object
4 properties 4 required
RevenueAnalyticsOverviewItem
object
2 properties 2 required
PersonType
object
8 properties 2 required
HogQLAutocompleteResponse
object
3 properties 2 required
DashboardFilter
object
5 properties
PathsLink
object
4 properties 4 required
RevenueAnalyticsMetricsQueryResponse
object
8 properties 1 required
IntegrationFilter
object
1 property
CalendarHeatmapMathType
string
HedgehogActorAccessoryOption
string
ErrorTrackingPendingFingerprintIssueStateUpdate
object
10 properties 6 required
LogAttributesQuery
object
14 properties 1 required
QueryResponseAlternative63
object
11 properties 7 required
StatusItem
object
2 properties 2 required
ExperimentFunnelMetric
object
15 properties 1 required
TeamTaxonomyQuery
object
7 properties
Response8
object
7 properties 1 required
RevenueAnalyticsMRRQueryResponse
object
8 properties 1 required
ClickhouseQueryProgress
object
5 properties 5 required
QueryUpgradeResponse
object
1 property 1 required
TrendsFormulaNode
object
2 properties 1 required
MarketingAnalyticsItem
object
7 properties 2 required
CorrelationType
string
RevenueCurrencyPropertyConfig
object
2 properties
Scale
string
RetentionQueryResponse
object
7 properties 1 required
TraceSpansQuery
object
16 properties 1 required
ErrorTrackingBreakdownsQueryResponse
object
7 properties 1 required
RetentionValue
object
3 properties 1 required
QueryResponseAlternative73
object
2 properties 2 required
ExperimentHoldoutType
object
7 properties 2 required
CurrencyCode
string
EventsQuery
object
21 properties 1 required
VizSpecificOptions
object
2 properties
ConversionGoalFilter1
object
21 properties 3 required
CustomChannelField
string
BreakdownItem
object
2 properties 2 required
QueryResponseAlternative64
object
11 properties 1 required
QueryResponseAlternative82
object
7 properties 1 required
QueryResponseAlternative41
object
13 properties 6 required
HeatmapSettings
object
12 properties
WebOverviewQuery
object
19 properties 1 required
Response24
object
11 properties 7 required
HedgehogActorColorOption
string
SessionPropertyFilter
object
5 properties 2 required
QueryResponseAlternative
BiasRisk
object
1 property 1 required
EndpointsUsageTableQuery
object
12 properties 1 required
SavedInsightNode
object
44 properties 1 required
ExperimentSignificanceCode
string
PageURL
object
1 property 1 required
Response3
object
16 properties 1 required
ExperimentTrendsQuery
object
11 properties 1 required
PersonsNode
object
12 properties
WebVitalsPathBreakdownQuery
object
22 properties 4 required
MinimalHedgehogConfig
object
4 properties 1 required
QueryResponseAlternative72
object
12 properties 1 required
TextMatching
ActionsPie
object
2 properties
EndpointsUsageOrderByDirection
string
WebVitalsPathBreakdownResult
object
3 properties 3 required
EndpointsUsageOverviewQuery
object
9 properties
QueryResponseAlternative25
object
13 properties 1 required
PropertyValuesQuery
object
10 properties 2 required
StepOrderValue
string
SnapshotSource
string
EntityType
string
ErrorTrackingIssueAggregations
object
5 properties 4 required
SimilarIssue
object
7 properties 6 required
DateRange
object
3 properties
QueryResponseAlternative80
object
10 properties 1 required
Population
object
4 properties 4 required
UsageMetric
object
10 properties 7 required
ErrorTrackingExternalReference
object
3 properties 3 required
TimelineEntry
object
3 properties 1 required
RevenueAnalyticsTopCustomersQueryResponse
object
8 properties 1 required
ExperimentVariantResultBayesian
object
17 properties 4 required
Response19
object
8 properties 1 required
DocumentSimilarityQueryResponse
object
10 properties 1 required
SessionsV2JoinMode
string
QueryResponseAlternative23
object
11 properties 1 required
WebNotableChangeItem
object
7 properties 7 required
WebTrendsMetric
string
QueryResponseAlternative14
object
11 properties 1 required
IntervalType
string
Style
string
RecordingsQuery
object
25 properties
ElementType
object
9 properties 2 required
QueryResponseAlternative38
object
13 properties 1 required
DataWarehousePropertyFilter
object
5 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
BreakdownType
string
QueryResponseAlternative83
object
11 properties 1 required
QueryResponseAlternative9
object
8 properties 3 required
IntervalItem
object
2 properties 2 required
PropertyOperator
string
FunnelCorrelationResponse
object
12 properties 1 required
EndpointsUsageOverviewItemKey
string
MarketingAnalyticsAggregatedQuery
object
22 properties 1 required
QueryResponseAlternative70
object
7 properties 1 required
ExperimentStatsValidationFailure
string
QueryUpgradeRequest
object
1 property 1 required
QueryResponseAlternative18
object
10 properties 7 required
Response5
object
14 properties 1 required
ResultCustomizationBy
string
DatabaseSchemaField
object
8 properties 4 required
RetentionDashboardDisplayType
string
QueryResponseAlternative28
object
9 properties 1 required
ErrorTrackingSimilarIssuesQuery
object
12 properties 1 required
ExperimentExposureCriteria
object
3 properties
CustomEventConversionGoal
object
1 property 1 required
SessionTableVersion
string
RecordingOrderDirection
string
ExperimentQuery
object
9 properties 1 required
PersonsOnEventsMode
string
HogQLPropertyFilter
object
4 properties 1 required
ErrorTrackingCorrelatedIssue
object
13 properties 7 required
QueryResponseAlternative5
object
7 properties
LogsSparklineBreakdownBy
string
EmbeddingDistance
object
3 properties 2 required
LogValuesQuery
object
14 properties 2 required
QueryLogTags
object
3 properties
FunnelLayout
string
AutocompleteCompletionItem
object
5 properties 3 required
SessionsQuery
object
19 properties 1 required
QueryResponseAlternative65
object
12 properties 1 required
HeatmapGradientStop
object
2 properties 2 required
CalendarHeatmapFilter
object
1 property
BreakdownAttributionType
string
ExperimentActorsQuery
object
12 properties 1 required
PathsFilter
object
16 properties
HogQuery
object
6 properties
YAxisSettings
object
4 properties
DatabaseSchemaManagedViewTable
object
8 properties 5 required
SuggestedQuestionsQueryResponse
object
1 property 1 required
BreakdownFilter
object
9 properties
RevenueAnalyticsMRRQueryResultItem
object
5 properties 5 required
OrderDirection1
string
ResolvedDateRangeResponse
object
2 properties 2 required
Response21
object
11 properties 1 required
CustomChannelCondition
object
4 properties 3 required
QueryResponseAlternative24
object
14 properties 1 required
EventTaxonomyItem
object
3 properties 3 required
QueryResponseAlternative52
object
8 properties 1 required
DataTableNodeViewPropsContext
object
2 properties 1 required
Response23
object
10 properties 7 required
GradientScaleMode
string
RevenueAnalyticsOverviewQuery
object
7 properties 1 required
ErrorTrackingExternalReferenceIntegration
object
3 properties 3 required
RevenueAnalyticsGrossRevenueQueryResponse
object
8 properties 1 required
StickinessCriteria
object
2 properties 2 required
Response14
object
7 properties 1 required
FeatureFlagGroupType
object
7 properties
DatabaseSchemaDataWarehouseTable
object
9 properties 5 required
RetentionQuery
object
13 properties 1 required
LifecycleFilter
object
4 properties
DataColorToken
string
RetentionEntity
object
11 properties
SessionAttributionExplorerQuery
object
9 properties 1 required
HogQLQueryModifiers
object
27 properties
LogEntryPropertyFilter
object
5 properties 2 required
InsightActorsQueryOptions
object
4 properties 1 required
RetentionResult
object
4 properties 3 required
QueryIndexUsage
string
EventsHeatMapStructuredResult
object
4 properties 4 required
WebGoalsQueryResponse
object
13 properties 1 required
Response2
object
13 properties 6 required
UserBasicType
object
9 properties 5 required
MultipleBreakdownOptions
object
1 property 1 required
MaterializationMode
string
QueryResponseAlternative29
object
3 properties 2 required
EventsNode
object
18 properties
TrendsQueryResponse
object
9 properties 1 required
EmbeddingRecord
object
6 properties 6 required
RetentionFilter
object
20 properties
Series
object
2 properties 2 required
QueryResponseAlternative20
object
16 properties
StickinessComputationMode
string
WebAnalyticsItemKind
string
HeatmapSortOrder
string
ConditionalFormattingRule
object
7 properties 6 required
EndpointsUsageOverviewQueryResponse
object
7 properties 1 required
FunnelCorrelationResult
object
2 properties 2 required
EndpointsUsageTableQueryResponse
object
12 properties 1 required
DatabaseSchemaSchema
object
6 properties 4 required
AutocompleteCompletionItemKind
string
HogQLNotice
object
4 properties 1 required
QueryResponseAlternative27
object
7 properties 1 required
PathsQueryResponse
object
7 properties 1 required
HogQLFilters
object
3 properties
SessionRecordingType
object
30 properties 7 required
DatabaseSerializedFieldType
string
StickinessOperator
string
EventsHeatMapRowAggregationResult
object
2 properties 2 required
EmptyPropertyFilter
object
1 property
FunnelsDataWarehouseNode
object
21 properties 5 required
FunnelConversionWindowTimeUnit
string
EndpointsUsageOverviewItem
object
4 properties 1 required
ExperimentBreakdownResult
object
3 properties 3 required
ResultCustomizationByValue
object
3 properties
WebVitalsPathBreakdownResultItem
object
2 properties 2 required
QueryResponseAlternative75
object
12 properties 1 required
BaseMathType
string
InsightVizNode
object
16 properties 1 required
ErrorTrackingIssueCohort
object
2 properties 2 required
Response
object
13 properties 4 required
WebGoalsQuery
object
20 properties 1 required
WebAnalyticsExternalSummaryQueryResponse
object
3 properties 2 required
OrderBy
string
DataWarehouseNode
object
21 properties 5 required
QueryResponseAlternative49
object
12 properties 4 required
ColorMode
string
QueryResponseAlternative17
object
11 properties 1 required
DatabaseSchemaManagedViewTableKind
string
WebStatsBreakdown
string
QueryResponseAlternative50
object
8 properties 1 required
QueryResponseAlternative85
object
5 properties
QueryResponseAlternative1
object
13 properties 4 required
SummaryOutcome
object
2 properties
TraceNeighborsQuery
object
11 properties 2 required
ErrorTrackingQuery
object
26 properties 3 required
ExperimentMetricGoal
string
PathType
string
WebAnalyticsSampling
object
2 properties
RevenueAnalyticsOverviewItemKey
string
WebOverviewQueryResponse
object
11 properties 1 required
QueryResponseAlternative39
object
13 properties 4 required
ExperimentMetricMathType
string
Metrics
object
6 properties
ErrorTrackingIssue
object
15 properties 4 required
RecordingsQueryResponse
object
9 properties 2 required
Filters
object
2 properties
Response12
object
8 properties 1 required
AIEventType
string
DataVisualizationNode
object
6 properties 1 required
ActorsPropertyTaxonomyQuery
object
8 properties 1 required
Response22
object
11 properties 1 required
TraceSpansQueryResponse
object
11 properties 1 required
Settings
object
2 properties
FunnelVizType
string
ChartDisplayType
string
FunnelExclusionActionsNode
object
18 properties 3 required
QueryResponseAlternative30
object
9 properties 1 required
QueryResponseAlternative62
object
10 properties 7 required
FunnelCorrelationResultsType
string
ExternalQueryError
object
2 properties 2 required
QueryResponseAlternative51
object
8 properties 1 required
WebExternalClicksTableQuery
object
21 properties 1 required
QueryResponseAlternative2
object
12 properties 4 required
DetailedResultsAggregationType
string
MarketingAnalyticsDrillDownLevel
string
CompareItem
object
2 properties 2 required
RecordingOrder
string
RevenueExampleEventsQueryResponse
object
12 properties 1 required
FilterLogicalOperator
string
QueryResponseAlternative36
object
13 properties 1 required
RecordingPropertyFilter
object
5 properties 2 required
HogQLQueryResponse
object
16 properties 1 required
QueryResponseAlternative37
object
8 properties 1 required
QueryResponseAlternative77
object
7 properties 1 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
Person
object
3 properties 2 required
MarketingAnalyticsAggregatedQueryResponse
object
8 properties 1 required
DatabaseSchemaPostHogTable
object
5 properties 3 required
ExperimentDataWarehouseNode
object
19 properties 4 required
EventDefinition
object
3 properties 3 required
GoalLine
object
6 properties 2 required
FunnelExclusionEventsNode
object
20 properties 2 required
WebAnalyticsOrderByDirection
string
EndpointsUsageOrderByField
string
LogValueResult
object
2 properties 2 required
DataWarehousePersonPropertyFilter
object
5 properties 2 required
ChartSettings
object
17 properties
ChartSettingsDisplay
object
5 properties
AggregationAxisFormat
string
LogSeverityLevel
string
ChartSettingsFormatting
object
4 properties
SampleRatioMismatch
object
2 properties 2 required
SessionsTimelineQueryResponse
object
8 properties 1 required
ErrorTrackingIssueCorrelationQuery
object
6 properties 1 required
EndpointsUsageTrendsQueryResponse
object
7 properties 1 required
DayItem
object
2 properties 2 required
LogAttributesQueryResponse
object
8 properties 2 required
QueryStatusResponse
object
1 property 1 required
RetentionEntityKind
string
QueryResponseAlternative11
object
12 properties 1 required
WebAnalyticsOrderByFields
string
QueryResponseAlternative88
object
7 properties 1 required
QueryResponseAlternative16
object
7 properties 1 required
TeamTaxonomyItem
object
2 properties 2 required
EventsQueryResponse
object
13 properties 4 required
RevenueAnalyticsTopCustomersGroupBy
string
HogQLMetadata
object
13 properties 2 required
NonIntegratedConversionsTableQueryResponse
object
13 properties 1 required
EventsQueryActionStep
object
10 properties
WebVitalsPathBreakdownQueryResponse
object
7 properties 1 required
FunnelMathType
string
PathsQuery
object
13 properties 1 required
QueryResponseAlternative79
object
1 property 1 required
QueryRequest
object
8 properties 1 required
MarketingAnalyticsTableQueryResponse
object
13 properties 1 required
WorkflowVariablePropertyFilter
object
5 properties 2 required
ConversionGoalFilter3
object
24 properties 8 required
FunnelStepReference
string
WebTrendsQueryResponse
object
18 properties 1 required
EventMetadataPropertyFilter
object
5 properties 2 required
LogValuesQueryResponse
object
7 properties 1 required
WebVitalsMetric
string
DatabaseSchemaQueryResponse
object
2 properties 2 required
RetentionPeriod
string
QueryResponseAlternative34
object
7 properties 1 required
HogLanguage
string
StickinessFilter
object
9 properties
QueryResponseAlternative32
object
8 properties 1 required
CountPerActorMathType
string
ExperimentStatsBaseValidated
object
13 properties 4 required
VectorSearchResponseItem
object
2 properties 2 required
ErrorTrackingIssueCorrelationQueryResponse
object
11 properties 1 required
FunnelsQuery
object
15 properties 1 required
QueryResponseAlternative90
object
7 properties 1 required
RevenueAnalyticsMetricsQuery
object
9 properties 3 required
QueryResponseAlternative43
object
11 properties 1 required
ExternalQueryStatus
string
QueryResponseAlternative21
object
6 properties 3 required
RetentionReference
string
LogPropertyFilterType
string
QueryResponseAlternative55
object
12 properties 1 required
DatabaseSchemaBatchExportTable
object
5 properties 3 required
ExperimentTrendsQueryResponse
object
11 properties 7 required
QueryResponseAlternative87
object
7 properties 1 required
WebTrendsItem
object
2 properties 2 required
ErrorTrackingOrderBy
string
QueryResponseAlternative54
object
8 properties 1 required
LifecycleDataWarehouseNode
object
20 properties 5 required
VolumeBucket
object
2 properties 2 required
WebNotableChangesQuery
object
20 properties 1 required
PropertyGroupsMode
string
ExperimentVariantFunnelsBaseStats
object
3 properties 3 required
FlagPropertyFilter
object
5 properties 2 required
LogAttributeResult
object
4 properties 3 required
Response16
object
12 properties 1 required
SimpleIntervalType
string
WebVitalsPercentile
string
ElementPropertyFilter
object
5 properties 2 required
CalendarHeatmapResponse
object
8 properties 1 required
HrefMatching
TrendsQuery
object
17 properties 1 required
FunnelCorrelationActorsQuery
object
10 properties 1 required
VectorSearchQuery
object
7 properties 1 required
QueryResponseAlternative67
object
7 properties 1 required
SessionsQueryResponse
object
12 properties 4 required
ErrorTrackingQueryResponse
object
11 properties 1 required
QueryResponseAlternative76
object
8 properties 2 required
Compare
string
DataWarehouseViewLink
object
8 properties 1 required
TracesQueryResponse
object
11 properties 1 required
LastEvent
object
4 properties 4 required
EventTaxonomyQuery
object
11 properties
ExperimentExposureQueryResponse
object
6 properties 3 required
Response26
object
12 properties 1 required
ActionsNode
object
16 properties 1 required
LogsQueryResponse
object
12 properties 1 required
QueryResponseAlternative7
object
4 properties 1 required
Response1
object
13 properties 5 required
WebNotableChangesQueryResponse
object
9 properties 1 required
LLMTraceEvent
object
4 properties 4 required
GroupNode
object
19 properties 2 required
Results
object
2 properties 2 required
StickinessQueryResponse
object
7 properties 1 required
DocumentSimilarityQuery
object
17 properties 9 required
Position
string
GroupsQueryResponse
object
13 properties 6 required
EndpointsUsageTrendsQuery
object
12 properties 1 required
DataWarehouseEventsModifier
object
4 properties 4 required
RevenueExampleDataWarehouseTablesQuery
object
7 properties
RevenueAnalyticsBreakdown
object
2 properties 1 required
MatchedRecording
object
2 properties 1 required
EmbeddingModelName
string
QueryResponseAlternative57
object
13 properties 1 required
ActorsQuery
object
13 properties
InCohortVia
string
QueryResponseAlternative4
object
13 properties 6 required
ExternalQueryErrorCode
string
Response18
object
13 properties 1 required
UsageMetricFormat
string
MarketingAnalyticsTableQuery
object
25 properties 1 required
QueryResponseAlternative74
object
9 properties 2 required
InsightActorsQueryOptionsResponse
object
7 properties
QueryResponseAlternative89
object
12 properties 1 required
WebPageURLSearchQueryResponse
object
9 properties 1 required
TimeWindowMode
string
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
QueryResponseAlternative33
object
8 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posthog-query-api-openapi.yml Raw ↑

Other APIs PostHog publishes across the network.

PostHog Capture API
PostHog Query API
PostHog Persons API
PostHog Feature Flags API
PostHog Experiments API
PostHog Insights API
PostHog Cohorts API
PostHog Annotations API
PostHog actions API
PostHog activity_log API
PostHog activity_logs API
PostHog advanced_activity_logs API
Where this information came from

This is an independent, third-party profile of PostHog query API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.