Skip to main content

Insight

Resource Insight in pulumi-posthog.
3 min read

Resource Insight in pulumi-posthog.

Pulumi type: posthog:index/insight:Insight.

name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

Example#

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

Arguments#

PropertyTypeRequiredDescription
createInFolderstringnoFolder identifier used only during insight creation.
dashboardIdsnumber[]noList of dashboard ids which should contain the insight.
deletedbooleannoWhether the insight is deleted (soft delete)
derivedNamestringnoInsight derived name. This is auto-generated by PostHog when the name is not set.
descriptionstringnoInsight description.
namestringnoInsight name.
projectIdstringnoProject ID (environment) for this resource. Overrides the provider-level project_id.
queryJsonstringnoRaw JSON serialized query payload accepted by PostHog (for example an InsightVizNode with a TrendsQuery). Mutually exclusive with querySql; exactly one must be set.
querySqlstringnoRaw HogQL SQL for the insight (for example SELECT count() FROM events). The provider wraps it in a DataVisualizationNode/HogQLQuery query. Use file("queries/x.sql") to load from a .sql file. Mutually exclusive with queryJson; exactly one must be set. For chart or column display options, use queryJson instead.
tagsstring[]noList of tags to apply to the insight.

Outputs#

Computed outputs are produced by the provider. They are not constructor arguments.

PropertyTypeComputedDescription
createInFolderstringnoFolder identifier used only during insight creation.
dashboardIdsnumber[]noList of dashboard ids which should contain the insight.
deletedbooleannoWhether the insight is deleted (soft delete)
derivedNamestringnoInsight derived name. This is auto-generated by PostHog when the name is not set.
descriptionstringnoInsight description.
insightIdnumberyesNumeric ID of the insight.
namestringnoInsight name.
projectIdstringnoProject ID (environment) for this resource. Overrides the provider-level project_id.
queryJsonstringnoRaw JSON serialized query payload accepted by PostHog (for example an InsightVizNode with a TrendsQuery). Mutually exclusive with querySql; exactly one must be set.
querySqlstringnoRaw HogQL SQL for the insight (for example SELECT count() FROM events). The provider wraps it in a DataVisualizationNode/HogQLQuery query. Use file("queries/x.sql") to load from a .sql file. Mutually exclusive with queryJson; exactly one must be set. For chart or column display options, use queryJson instead.
shortIdstringyesShort ID of the insight (the value shown in the insight's URL). Use this with the posthog.Insight data source to look up the insight.
tagsstring[]noList of tags to apply to the insight.