autoresearch
autoresearch

List available templates

Return all built-in autoresearch prediction templates. Each entry describes what the template predicts, its default horizon and prediction mode, and whether it requires you to supply a target_event. After choosing a template, call autoresearch-resolve-template-create to get a fully resolved pipeline config ready to pass to autoresearch-create.

get/api/projects/{project_id}/autoresearch/templates/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/autoresearch/templates/
  • 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/.

Response

key'likely_active_soon' | 'at_risk_of_inactivity' | 'return_after_first_use' | 'feature_adoption' | 'repeat_key_behavior' required
  • likely_active_soon - Likely Active Soon
  • at_risk_of_inactivity - At Risk Of Inactivity
  • return_after_first_use - Return After First Use
  • feature_adoption - Feature Adoption
  • repeat_key_behavior - Repeat Key Behavior
display_namestring required

Human-readable template name.

descriptionstring required

What this template predicts and who it is for.

default_horizon_daysinteger required

Default prediction horizon in days. Can be overridden when resolving.

requires_user_eventboolean required

If true, you must supply a target_event when resolving — the template does not auto-select one. Required for 'feature_adoption' and 'repeat_key_behavior'.

requires_activity_resolutionboolean required

If true, the target event is automatically resolved from your event schema ($pageview, $screen, or the highest-volume non-noisy event). You can override the resolved event when resolving the template.

notesstring required

Usage guidance and implementation notes.

Changes

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