insightsGenerateMetadataCreate · PostHog API

provider insights POST /api/projects/{project_id}/insights/generate_metadata/

@utdk/posthog /api/projects/{project_id}/insights/generate_metadata/

insights_generate_metadata_create

Generate an AI-suggested name and description for an insight based on its query configuration.

format query: enum: csv, json
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

insightsGenerateMetadataCreate

POST/api/projects/{project_id}/insights/generate_metadata/

Generate an AI-suggested name and description for an insight based on its query configuration.

Parameters

project_idrequired

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

format

Input

idrequired

short_idrequired

name

derived_name

query

order

deleted

false

dashboards

DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.

dashboard_tilesrequired

A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.

last_refreshrequired

The datetime this insight's results were generated. If added to one or more dashboards the insight can be refreshed separately on each. Returns the appropriate last_refresh datetime for the context the insight is viewed in (see from_dashboard query parameter).

cache_target_agerequired

The target age of the cached results for this insight.

next_allowed_client_refreshrequired

The earliest possible datetime at which we'll allow the cached results for this insight to be refreshed by querying the database.

resultrequired

hasMorerequired

columnsrequired

created_atrequired

created_byrequired

description

updated_atrequired

tags

favorited

false

last_modified_atrequired

last_modified_byrequired

is_samplerequired

false

effective_restriction_levelrequired

effective_privilege_levelrequired

user_access_levelrequired

The effective access level the user has for this object

timezonerequired

The timezone this chart is displayed in.

is_cachedrequired

false

query_statusrequired

hogqlrequired

typesrequired

resolved_date_rangerequired

_create_in_folder

alertsrequired

last_viewed_atrequired

search_match_typerequired

How this row matched the `search` query parameter: `exact` (the term is a case-insensitive substring of a searched field) or `similar` (a fuzzy trigram match, returned only when no exact match exists). Null when the list is not filtered by `search`.

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