insights

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

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

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/insights/generate_metadata/
  • Auth: HTTP bearer

Path parameters

project_idstring required

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

Query parameters

format'csv' | 'json'

Request body

idinteger required
short_idstring required
namestring nullable
derived_namestring nullable
orderinteger nullable
deletedboolean
dashboardsinteger[] 
    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.
    This field is omitted from session-authenticated responses unless `include_dashboards=true`
    is passed. Once opt-in enforcement is enabled, API-token callers (personal API keys, OAuth)
    must opt in the same way. Do not rely on it being present.
last_refreshstring date-time nullable required
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_agestring date-time nullable required

The target age of the cached results for this insight.

next_allowed_client_refreshstring date-time nullable required
The earliest possible datetime at which we'll allow the cached results for this insight to be refreshed
by querying the database.
resultunknown required
hasMoreboolean nullable required
columnsstring[] nullable required
created_atstring date-time nullable required
descriptionstring nullable
updated_atstring date-time required
favoritedboolean
last_modified_atstring date-time required
is_sampleboolean required
effective_restriction_level21 | 37 required
  • 21 - Everyone in the project can edit
  • 37 - Only those invited to this dashboard can edit
effective_privilege_level21 | 37 required
  • 21 - Can view dashboard
  • 37 - Can edit dashboard
user_access_levelstring nullable required

The effective access level the user has for this object

timezonestring nullable required

The timezone this chart is displayed in.

is_cachedboolean required
query_statusunknown required
hogqlstring nullable required
query_scanunknown required
_create_in_folderstring
last_viewed_atstring date-time nullable required

Response

No response body

Changes

No recorded changes to this operation across all 1 revision of this API.