PostHog integrationPostHog logo

PostHog integration for AI agents.

PostHog integration for AI agents with secure authentication and server-side credential injection. Open Connector runs the OAuth, seals the token in an encrypted vault, and serves PostHog tools to your agent over MCP or a typed API — credentials injected server-side, every call audited, nothing leaving your infrastructure. Open source (AGPL-3.0) and self-hostable.

View source on GitHubAll integrations →
What your agents can do

Real PostHog actions, managed and audited.

Your user connects PostHog once; your agent can then use the PostHog API to manage product analytics projects, events, cohorts, feature flags, dashboards, insights, experiments, annotations, and users — scoped to the OAuth permissions you grant and the tool allowlist you configure. Every action is least-privilege and written to a tamper-evident audit trail.

  1. 1

    Your user grants PostHog access once (OAuth) — the token lands in the vault.

  2. 2

    Your agent calls a tool over MCP or the typed API; Open Connector injects the credential server-side.

  3. 3

    Every routed call appends a hash-chained audit record — nothing leaves your infra.

Tools & triggers

Supported PostHog tools.

2,473 tools are generated from the published PostHog catalog. Descriptions are plain text; each action remains subject to its configured authentication and tool allowlist.

Showing 2,473 tools. All published catalog entries are included in this page's server-rendered HTML.

Account Notes List
Account Notes List
customer_analyticsaccount_notes
Account Relationship Definitions Create
Account Relationship Definitions Create
account_relationship_definitions
Account Relationship Definitions Destroy
Account Relationship Definitions Destroy
account_relationship_definitions
Account Relationship Definitions List
Account Relationship Definitions List
account_relationship_definitions
Account Relationship Definitions Partial Update
Account Relationship Definitions Partial Update
account_relationship_definitions
Account Relationship Definitions Retrieve
Account Relationship Definitions Retrieve
account_relationship_definitions
Account Relationship Definitions Update
Account Relationship Definitions Update
account_relationship_definitions
Accounts Create
Accounts Create
accounts
Accounts Custom Property Values Create
Accounts Custom Property Values Create
customer_analyticsaccounts
Accounts Custom Property Values List
Accounts Custom Property Values List
customer_analyticsaccounts
Accounts Destroy
Accounts Destroy
accounts
Accounts List
Accounts List
accounts
Accounts Notebooks Create
Accounts Notebooks Create
customer_analyticsaccounts
Accounts Notebooks Destroy
Accounts Notebooks Destroy
customer_analyticsaccounts
Accounts Notebooks List
Accounts Notebooks List
customer_analyticsaccounts
Accounts Notebooks Retrieve
Accounts Notebooks Retrieve
customer_analyticsaccounts
Accounts Partial Update
Accounts Partial Update
accounts
Accounts Relationships Create
Accounts Relationships Create
customer_analyticsaccounts
Accounts Relationships End Create
Accounts Relationships End Create
customer_analyticsaccounts
Accounts Relationships List
Accounts Relationships List
customer_analyticsaccounts
Accounts Retrieve
Accounts Retrieve
accounts
Accounts Update
Accounts Update
accounts
Actions Bulk Update Tags Create
Bulk update tags on multiple objects. PAT access: this action has no ``required_scopes=`` on the decorator — inheriting viewsets must add ``"bulk_update_tags"`` to their ``scope_object_write_actions`` list to accept personal API keys. Without that opt-in, ``APIScopePermission`` rejects PAT requests with "This action does not support personal API key access". Done per-viewset so granting ``<scope>:write`` for one resource doesn't leak access to sibling resources that share this mixin. Accepts: - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]} Actions: - "add": Add tags to existing tags on each object - "remove": Remove specific tags from each object - "set": Replace all tags on each object with the provided list
actions
Actions Create
Actions Create
actions
Actions Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
actions
Actions List
Actions List
actions
Actions Partial Update
Actions Partial Update
actions
Actions References List
Actions References List
actions
Actions Retrieve
Actions Retrieve
actions
Actions Update
Actions Update
actions
Activity Log List
Activity Log List
activity_logsactivity_log
Advanced Activity Logs Available Filters Retrieve
Advanced Activity Logs Available Filters Retrieve
advanced_activity_logs
Advanced Activity Logs Export Create
Advanced Activity Logs Export Create
advanced_activity_logs
Advanced Activity Logs List
Advanced Activity Logs List
advanced_activity_logs
Agent Applications Approvals Decide
Approve or reject a queued `agent`-type tool-approval request. This is the OWNER decision surface — the only PostHog-authoritative one: team admins decide here, in the console. `principal`-type approvals are decided by the session principal at the ingress decision API, not here. The runtime side runs the tool platform-side on approve and wakes the session with a synthetic tool_result either way.
agent_platformagent_applications
Agent Applications Approvals List
List approval-gated tool requests for this application. Team-admin only (per plan §6.1). Default returns all states — pass `?state=queued` for the inbox view.
agent_platformagent_applications
Agent Applications Approvals Retrieve
Single approval request — full proposed args, assistant snapshot, decision metadata, dispatch outcome. Team-admin only (plan §6.1).
agent_platformagent_applications
Agent Applications Create
Agent applications — the deployable unit of the platform. URLs: GET /api/projects/<team>/agent_applications/ list POST /api/projects/<team>/agent_applications/ create GET /api/projects/<team>/agent_applications/<id|slug>/ retrieve PATCH /api/projects/<team>/agent_applications/<id|slug>/ update DELETE /api/projects/<team>/agent_applications/<id|slug>/ archive POST /api/projects/<team>/agent_applications/<id|slug>/set_env/ bulk replace env GET /api/projects/<team>/agent_applications/<id|slug>/env_keys/ list set keys GET /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ is one key set? PUT /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ set one key DELETE /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ clear one key
agent_platformagent_applications
Agent Applications Destroy
Agent applications — the deployable unit of the platform. URLs: GET /api/projects/<team>/agent_applications/ list POST /api/projects/<team>/agent_applications/ create GET /api/projects/<team>/agent_applications/<id|slug>/ retrieve PATCH /api/projects/<team>/agent_applications/<id|slug>/ update DELETE /api/projects/<team>/agent_applications/<id|slug>/ archive POST /api/projects/<team>/agent_applications/<id|slug>/set_env/ bulk replace env GET /api/projects/<team>/agent_applications/<id|slug>/env_keys/ list set keys GET /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ is one key set? PUT /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ set one key DELETE /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ clear one key
agent_platformagent_applications
Agent Applications List
Agent applications — the deployable unit of the platform. URLs: GET /api/projects/<team>/agent_applications/ list POST /api/projects/<team>/agent_applications/ create GET /api/projects/<team>/agent_applications/<id|slug>/ retrieve PATCH /api/projects/<team>/agent_applications/<id|slug>/ update DELETE /api/projects/<team>/agent_applications/<id|slug>/ archive POST /api/projects/<team>/agent_applications/<id|slug>/set_env/ bulk replace env GET /api/projects/<team>/agent_applications/<id|slug>/env_keys/ list set keys GET /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ is one key set? PUT /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ set one key DELETE /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ clear one key
agent_platformagent_applications
Agent Applications Models
Served-model catalog — each model's id, provider, context window, and USD-per-million-token pricing — plus the curated auto-level → model map. Project-agnostic; sourced from the AI gateway catalog. Powers the config UI model browser and the agent builder's model-choosing skill.
agent_platformagent_applications
Agent Applications Partial Update
Agent applications — the deployable unit of the platform. URLs: GET /api/projects/<team>/agent_applications/ list POST /api/projects/<team>/agent_applications/ create GET /api/projects/<team>/agent_applications/<id|slug>/ retrieve PATCH /api/projects/<team>/agent_applications/<id|slug>/ update DELETE /api/projects/<team>/agent_applications/<id|slug>/ archive POST /api/projects/<team>/agent_applications/<id|slug>/set_env/ bulk replace env GET /api/projects/<team>/agent_applications/<id|slug>/env_keys/ list set keys GET /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ is one key set? PUT /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ set one key DELETE /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ clear one key
agent_platformagent_applications
Agent Applications Preview Proxy
Authoring-side proxy for invoking a *draft* (or any non-live) revision. Closes the anonymous-draft-invoke gap: the public ingress URL refuses non-live invokes that don't carry the `x-agent-preview-secret` header; this proxy attaches it after authenticating the Django caller. URL: `/api/projects/<team>/agent_applications/<app>/preview-proxy/<rest>` Auth: standard PAT / session — `agents:write` scope (POST run/send/cancel is a mutating invoke; the read-only `listen` GET is `agents:read`).
agent_platformagent_applications
Agent Applications Preview Proxy Get
GET passthrough for the preview-proxy — used for `/listen` SSE.
agent_platformagent_applications
Agent Applications Preview Token
GET sibling of `preview_token_mint`. Same body and response shape — exists because `EventSource` can't set headers, so SSE callers fetch the token via GET and then attach `?preview_token=` to the ingress URL. Behind the same URL (`url_path="preview-token"`) thanks to DRF's `@<action>.mapping.get`; DRF resolves it to a distinct `view.action`, but it is in `scope_object_write_actions` alongside the POST sibling — both return a usable credential, so both require `agents:write`.
agent_platformagent_applications
Agent Applications Preview Token Mint
Mint a short-lived JWT for talking to a non-live revision directly via the public ingress URL. The caller attaches it as the `x-agent-preview-token` header (or `?preview_token=` query param for `EventSource`). See `_mint_preview_jwt` for the payload + claim binding. The response also includes `endpoints`, `auth`, and `preview_proxy` blocks so the caller can wire a preview invocation without grepping the agent-ingress source for which path each trigger exposes or which header name carries the token. This is the "self-describing" half of preview-mode — every piece of info you need to hit ingress is in one response. POST is the canonical verb — minting credentials for downstream `run`/`send`/`cancel` is a write-class capability. A GET sibling exists at the same URL for `EventSource` callers (which can't set headers); it is also write-scoped, since it returns the same token.
agent_platformagent_applications
Agent Applications Retrieve
Agent applications — the deployable unit of the platform. URLs: GET /api/projects/<team>/agent_applications/ list POST /api/projects/<team>/agent_applications/ create GET /api/projects/<team>/agent_applications/<id|slug>/ retrieve PATCH /api/projects/<team>/agent_applications/<id|slug>/ update DELETE /api/projects/<team>/agent_applications/<id|slug>/ archive POST /api/projects/<team>/agent_applications/<id|slug>/set_env/ bulk replace env GET /api/projects/<team>/agent_applications/<id|slug>/env_keys/ list set keys GET /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ is one key set? PUT /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ set one key DELETE /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ clear one key
agent_platformagent_applications
Agent Applications Revisions Agent Md Update
Revisions of an agent. Created in `draft`, promoted through `ready → live` once the bundle has been uploaded + frozen. URLs (nested under an application): Model CRUD: GET .../revisions/ list POST .../revisions/ create draft GET .../revisions/<id>/ retrieve PATCH .../revisions/<id>/ update spec (draft only) Lifecycle: POST .../revisions/<id>/promote/ ready → live POST .../revisions/<id>/archive/ → archived POST .../revisions/<id>/freeze/ draft → ready (stamps sha256) POST .../revisions/<id>/clone_from/ copy bundle from another rev POST .../revisions/new_draft/ create draft + clone_from atomically Bundle authoring (proxied to the janitor): GET .../revisions/<id>/manifest/ list paths + sha256 GET .../revisions/<id>/file/?path=… read one file PUT .../revisions/<id>/file/?path=… write one file (draft) DELETE .../revisions/<id>/file/?path=… delete one file (draft) GET .../revisions/<id>/bundle/ bulk pull all files PUT .../revisions/<id>/bundle/ bulk push (replace|merge)
agent_platformagent_applications
Agent Applications Revisions Archive Create
Mark a revision archived. If it was the live one, clear the application's live_revision pointer (the app effectively has no deployable version until another revision is promoted).
agent_platformagent_applications
Agent Applications Revisions Bundle File Update
Update one `.md` file on a draft revision. `agent.md` writes go to the draft bundle. `skills/<id>/SKILL.md` writes are store-backed — skills are materialized from the skill store at freeze, so the edit publishes a new version of the referenced store skill and re-pins the draft's `skill_refs` entry to it. `<id>` must be a ref alias on this revision; add new skills via `bundle/import/` or `skill_refs`. Tool source / schema editing is out of scope here — use the per-tool endpoints. Returns the updated revision so the caller can refresh in one round-trip.
agent_platformagent_applications
Agent Applications Revisions Bundle Import Create
Bulk-merge a set of `.md` files into a draft revision. Sets `agent_md` on the draft bundle if present. `skills[]` are store-backed and merge by `id`: an id already referenced by the draft publishes a new version of its store skill; an unreferenced id attaches the store skill of that name (publishing the payload's body to it), or creates it when no such skill exists — and each ref is (re-)pinned to the published version. Skills not mentioned are left alone, so the import is safe to retry. Draft-only; non-draft revisions return 409 untouched.
agent_platformagent_applications
Agent Applications Revisions Bundle Retrieve
Read the full typed bundle: `{ agent_md, skills, tools, spec }`.
agent_platformagent_applications
Agent Applications Revisions Bundle Update
Full-replace the typed bundle. Anything not in the payload is deleted. Tool sources are AST-checked + esbuild-compiled by the janitor before any S3 writes.
agent_platformagent_applications
Agent Applications Revisions Clone From Create
Copy every file from `source_revision_id` into this revision.
agent_platformagent_applications
Agent Applications Revisions Create
Revisions of an agent. Created in `draft`, promoted through `ready → live` once the bundle has been uploaded + frozen. URLs (nested under an application): Model CRUD: GET .../revisions/ list POST .../revisions/ create draft GET .../revisions/<id>/ retrieve PATCH .../revisions/<id>/ update spec (draft only) Lifecycle: POST .../revisions/<id>/promote/ ready → live POST .../revisions/<id>/archive/ → archived POST .../revisions/<id>/freeze/ draft → ready (stamps sha256) POST .../revisions/<id>/clone_from/ copy bundle from another rev POST .../revisions/new_draft/ create draft + clone_from atomically Bundle authoring (proxied to the janitor): GET .../revisions/<id>/manifest/ list paths + sha256 GET .../revisions/<id>/file/?path=… read one file PUT .../revisions/<id>/file/?path=… write one file (draft) DELETE .../revisions/<id>/file/?path=… delete one file (draft) GET .../revisions/<id>/bundle/ bulk pull all files PUT .../revisions/<id>/bundle/ bulk push (replace|merge)
agent_platformagent_applications
Agent Applications Revisions Cron Fire Create
Fire one cron job out-of-band — the same execution path the scheduler walks, but on demand. Authoring UX: the user iterates on a cron prompt by clicking 'Fire now' rather than waiting for the next scheduled firing. Without this, 'did my prompt do the right thing?' is unanswerable until the cron actually fires. Idempotent via `request_id`: repeat clicks with the same id resolve to the same session id rather than firing N times.
agent_platformagent_applications
Agent Applications Revisions Destroy
Revisions of an agent. Created in `draft`, promoted through `ready → live` once the bundle has been uploaded + frozen. URLs (nested under an application): Model CRUD: GET .../revisions/ list POST .../revisions/ create draft GET .../revisions/<id>/ retrieve PATCH .../revisions/<id>/ update spec (draft only) Lifecycle: POST .../revisions/<id>/promote/ ready → live POST .../revisions/<id>/archive/ → archived POST .../revisions/<id>/freeze/ draft → ready (stamps sha256) POST .../revisions/<id>/clone_from/ copy bundle from another rev POST .../revisions/new_draft/ create draft + clone_from atomically Bundle authoring (proxied to the janitor): GET .../revisions/<id>/manifest/ list paths + sha256 GET .../revisions/<id>/file/?path=… read one file PUT .../revisions/<id>/file/?path=… write one file (draft) DELETE .../revisions/<id>/file/?path=… delete one file (draft) GET .../revisions/<id>/bundle/ bulk pull all files PUT .../revisions/<id>/bundle/ bulk push (replace|merge)
agent_platformagent_applications
Agent Applications Revisions Freeze Create
Freeze the bundle: draft → ready, stamps sha256 on the row. Django is a thin proxy here: resolve template refs into the bundle, ask the janitor to seal it (the janitor returns the sha + the spec it derived from the typed resources), then stamp the row. No `transaction.atomic()` — the janitor's freeze is idempotent (on retry it re-reads the existing `.frozen` marker + re-derives spec), so a partial failure here is recoverable by re-calling freeze, not by transactional rollback. Holding an atomic block across the janitor HTTP call previously deadlocked the agent_revision row against the janitor's spec write — that's moved off the janitor side as part of the same fix.
agent_platformagent_applications
Agent Applications Revisions List
Revisions of an agent. Created in `draft`, promoted through `ready → live` once the bundle has been uploaded + frozen. URLs (nested under an application): Model CRUD: GET .../revisions/ list POST .../revisions/ create draft GET .../revisions/<id>/ retrieve PATCH .../revisions/<id>/ update spec (draft only) Lifecycle: POST .../revisions/<id>/promote/ ready → live POST .../revisions/<id>/archive/ → archived POST .../revisions/<id>/freeze/ draft → ready (stamps sha256) POST .../revisions/<id>/clone_from/ copy bundle from another rev POST .../revisions/new_draft/ create draft + clone_from atomically Bundle authoring (proxied to the janitor): GET .../revisions/<id>/manifest/ list paths + sha256 GET .../revisions/<id>/file/?path=… read one file PUT .../revisions/<id>/file/?path=… write one file (draft) DELETE .../revisions/<id>/file/?path=… delete one file (draft) GET .../revisions/<id>/bundle/ bulk pull all files PUT .../revisions/<id>/bundle/ bulk push (replace|merge)
agent_platformagent_applications
Agent Applications Revisions Manifest Retrieve
List every file in this revision's bundle (path, size, sha256).
agent_platformagent_applications
Agent Applications Revisions New Draft Create
Create a fresh draft revision under `application_id` and seed it from `source_revision_id`. Saves the MCP one round-trip vs the explicit create + clone_from sequence.
agent_platformagent_applications
Agent Applications Revisions Partial Update
Revisions of an agent. Created in `draft`, promoted through `ready → live` once the bundle has been uploaded + frozen. URLs (nested under an application): Model CRUD: GET .../revisions/ list POST .../revisions/ create draft GET .../revisions/<id>/ retrieve PATCH .../revisions/<id>/ update spec (draft only) Lifecycle: POST .../revisions/<id>/promote/ ready → live POST .../revisions/<id>/archive/ → archived POST .../revisions/<id>/freeze/ draft → ready (stamps sha256) POST .../revisions/<id>/clone_from/ copy bundle from another rev POST .../revisions/new_draft/ create draft + clone_from atomically Bundle authoring (proxied to the janitor): GET .../revisions/<id>/manifest/ list paths + sha256 GET .../revisions/<id>/file/?path=… read one file PUT .../revisions/<id>/file/?path=… write one file (draft) DELETE .../revisions/<id>/file/?path=… delete one file (draft) GET .../revisions/<id>/bundle/ bulk pull all files PUT .../revisions/<id>/bundle/ bulk push (replace|merge)
agent_platformagent_applications
Agent Applications Revisions Promote Create
ready → live. Sets the parent application's live_revision.
agent_platformagent_applications
Agent Applications Revisions Retrieve
Revisions of an agent. Created in `draft`, promoted through `ready → live` once the bundle has been uploaded + frozen. URLs (nested under an application): Model CRUD: GET .../revisions/ list POST .../revisions/ create draft GET .../revisions/<id>/ retrieve PATCH .../revisions/<id>/ update spec (draft only) Lifecycle: POST .../revisions/<id>/promote/ ready → live POST .../revisions/<id>/archive/ → archived POST .../revisions/<id>/freeze/ draft → ready (stamps sha256) POST .../revisions/<id>/clone_from/ copy bundle from another rev POST .../revisions/new_draft/ create draft + clone_from atomically Bundle authoring (proxied to the janitor): GET .../revisions/<id>/manifest/ list paths + sha256 GET .../revisions/<id>/file/?path=… read one file PUT .../revisions/<id>/file/?path=… write one file (draft) DELETE .../revisions/<id>/file/?path=… delete one file (draft) GET .../revisions/<id>/bundle/ bulk pull all files PUT .../revisions/<id>/bundle/ bulk push (replace|merge)
agent_platformagent_applications
Agent Applications Revisions Set Env Create
Replace this revision's encrypted env block. The body is `{ "env": { "<KEY>": "<value>", ... } }`. The encrypted text is stored on `AgentRevision.encrypted_env`; the worker decrypts it at session start via the same Fernet schedule (see agent-shared/src/runtime/encryption.ts).
agent_platformagent_applications
Agent Applications Revisions Skill Refs Update
Full-replace the draft's store-skill references. They are resolved and materialized into the bundle at freeze, not here — this only records which skills (and pinned versions) the freeze should pull in.
agent_platformagent_applications
Agent Applications Revisions Slack Manifest
Build a Slack app manifest for this revision's slack trigger. Deterministic: the OAuth scopes and bot event subscriptions are derived from the slack trigger config (`mention_only` / `auto_resume_threads` / `ack_reaction`) and the agent's Slack tools, so the manifest already subscribes to exactly the events the config needs. 400 if the revision has no slack trigger.
agent_platformagent_applications
Agent Applications Revisions Spec Update
Revisions of an agent. Created in `draft`, promoted through `ready → live` once the bundle has been uploaded + frozen. URLs (nested under an application): Model CRUD: GET .../revisions/ list POST .../revisions/ create draft GET .../revisions/<id>/ retrieve PATCH .../revisions/<id>/ update spec (draft only) Lifecycle: POST .../revisions/<id>/promote/ ready → live POST .../revisions/<id>/archive/ → archived POST .../revisions/<id>/freeze/ draft → ready (stamps sha256) POST .../revisions/<id>/clone_from/ copy bundle from another rev POST .../revisions/new_draft/ create draft + clone_from atomically Bundle authoring (proxied to the janitor): GET .../revisions/<id>/manifest/ list paths + sha256 GET .../revisions/<id>/file/?path=… read one file PUT .../revisions/<id>/file/?path=… write one file (draft) DELETE .../revisions/<id>/file/?path=… delete one file (draft) GET .../revisions/<id>/bundle/ bulk pull all files PUT .../revisions/<id>/bundle/ bulk push (replace|merge)
agent_platformagent_applications
Agent Applications Revisions System Prompt
Return the fully-assembled system prompt for this revision. Authoring tools call this to preview what the model will actually see at session start — the platform framework preamble plus the bundle's `agent.md` plus the skills index. Useful for debugging author-vs-framework precedence conflicts and verifying `spec.framework_prompt.omit` overrides took effect.
agent_platformagent_applications
Agent Applications Revisions Tools Destroy
Revisions of an agent. Created in `draft`, promoted through `ready → live` once the bundle has been uploaded + frozen. URLs (nested under an application): Model CRUD: GET .../revisions/ list POST .../revisions/ create draft GET .../revisions/<id>/ retrieve PATCH .../revisions/<id>/ update spec (draft only) Lifecycle: POST .../revisions/<id>/promote/ ready → live POST .../revisions/<id>/archive/ → archived POST .../revisions/<id>/freeze/ draft → ready (stamps sha256) POST .../revisions/<id>/clone_from/ copy bundle from another rev POST .../revisions/new_draft/ create draft + clone_from atomically Bundle authoring (proxied to the janitor): GET .../revisions/<id>/manifest/ list paths + sha256 GET .../revisions/<id>/file/?path=… read one file PUT .../revisions/<id>/file/?path=… write one file (draft) DELETE .../revisions/<id>/file/?path=… delete one file (draft) GET .../revisions/<id>/bundle/ bulk pull all files PUT .../revisions/<id>/bundle/ bulk push (replace|merge)
agent_platformagent_applications
Agent Applications Revisions Tools Dry Run Create
Execute one persisted custom tool in a single-shot sandbox. Authoring loop's "test this tool" button. The tool's source must already be PUT (compiled.js is what runs); this just invokes it with the caller-supplied args and a stubbed ctx. No real secrets leave Django — `mock_secrets` is a `{name → placeholder}` map.
agent_platformagent_applications
Agent Applications Revisions Tools Update
Revisions of an agent. Created in `draft`, promoted through `ready → live` once the bundle has been uploaded + frozen. URLs (nested under an application): Model CRUD: GET .../revisions/ list POST .../revisions/ create draft GET .../revisions/<id>/ retrieve PATCH .../revisions/<id>/ update spec (draft only) Lifecycle: POST .../revisions/<id>/promote/ ready → live POST .../revisions/<id>/archive/ → archived POST .../revisions/<id>/freeze/ draft → ready (stamps sha256) POST .../revisions/<id>/clone_from/ copy bundle from another rev POST .../revisions/new_draft/ create draft + clone_from atomically Bundle authoring (proxied to the janitor): GET .../revisions/<id>/manifest/ list paths + sha256 GET .../revisions/<id>/file/?path=… read one file PUT .../revisions/<id>/file/?path=… write one file (draft) DELETE .../revisions/<id>/file/?path=… delete one file (draft) GET .../revisions/<id>/bundle/ bulk pull all files PUT .../revisions/<id>/bundle/ bulk push (replace|merge)
agent_platformagent_applications
Agent Applications Revisions Update
Spec edits are only allowed while state='draft'. Once promoted to ready/live the spec is frozen — change requires a new revision.
agent_platformagent_applications
Agent Applications Revisions Validate Create
Pre-flight checks before freeze + promote: agent.md exists, every native tool id is registered, every custom tool has its compiled.js + schema.json, every skill path exists, every declared secret has a value set in this revision's env block. Returns `{ ok, errors: [...] }`. Works on any revision state.
agent_platformagent_applications
Agent Applications Session Logs
Read the runner's structured event log for one session from ClickHouse. Filters (limit / after / before / level / search) match the shared `LogEntryMixin` helper used by hog_function + hog_flow.
agent_platformagent_applications
Agent Applications Sessions List
List sessions for this application, newest first. Strips the conversation transcript from each summary, but includes a `preview` (last assistant text, ~120 chars) and `usage_total` (token + cost aggregate). Use `agent-applications-sessions-retrieve` for the full transcript of a single session.
agent_platformagent_applications
Agent Applications Sessions Retrieve
Fetch one session's state — full conversation by default, or just the trailing N messages with `?last_n=`. Always returns a `usage_total` block aggregated over the entire session, regardless of trim. The runner-side queue DB is the source of truth.
agent_platformagent_applications
Agent Applications Spec Schema
The canonical JSON Schema for an agent `spec` — every field, type, enum, default, and the discriminated unions for `models` / `triggers[]` / `tools[]`, each with an inline description. Emitted from the same source the runner validates against (fields with a default are optional on write), so read it BEFORE composing a spec for create / revisions-spec-update instead of guessing the shape. Pass `section` to fetch just one part.
agent_platformagent_applications
Agent Applications Stats
Roll-up stats for the agent — drives the agent-detail overview tiles.
agent_platformagent_applications
Agent Applications Update
Agent applications — the deployable unit of the platform. URLs: GET /api/projects/<team>/agent_applications/ list POST /api/projects/<team>/agent_applications/ create GET /api/projects/<team>/agent_applications/<id|slug>/ retrieve PATCH /api/projects/<team>/agent_applications/<id|slug>/ update DELETE /api/projects/<team>/agent_applications/<id|slug>/ archive POST /api/projects/<team>/agent_applications/<id|slug>/set_env/ bulk replace env GET /api/projects/<team>/agent_applications/<id|slug>/env_keys/ list set keys GET /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ is one key set? PUT /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ set one key DELETE /api/projects/<team>/agent_applications/<id|slug>/env_keys/<KEY>/ clear one key
agent_platformagent_applications
Agent Applications Users Connection Delete
Revoke one of an end-user's linked connections. The credential is marked revoked (kept for audit), so the agent can no longer act as that user on the provider.
agent_platformagent_applications
Agent Applications Users List
List this agent's end-users (the stable identities behind inbound principals) and each user's linked external connections. Connection metadata only — credential material is never returned.
agent_platformagent_applications
Agent Fleet Approvals List
Approval-gated tool requests across every agent in this team. Team-admin only.
agent_platformagent_fleet
Agent Fleet Live Sessions
Live (non-terminal) sessions across every agent owned by this team, newest activity first.
agent_platformagent_fleet
Agent Fleet Stats
Roll-up stats across every agent owned by this team.
agent_platformagent_fleet
Agent Memory Create File
Create a memory file. Fails if the path already exists — use the update endpoint to overwrite.
agent_platformagent_applications
Agent Memory Delete File
Hard-delete a memory file. Activity log captures the action against the agent.
agent_platformagent_applications
Agent Memory Get File
Read one memory file in full (frontmatter + markdown body).
agent_platformagent_applications
Agent Memory List Files
List memory file headers under the agent's prefix. Headers only — no bodies.
agent_platformagent_applications
Agent Memory List Tables
List the agent's tabular-reference tables (the @posthog/table-* JSONL tables): name + byte size.
agent_platformagent_applications
Agent Memory Read Table
Read rows from one tabular-reference table (capped via ?limit).
agent_platformagent_applications
Agent Memory Search
BM25 search across the agent's memory files. Ranks by description+tags+path+body with field weighting.
agent_platformagent_applications
Agent Memory Tree
Pre-aggregated folder tree of memory files. Saves the frontend re-derivation work.
agent_platformagent_applications
Agent Memory Update File
Update a memory file. Any field omitted is preserved from the existing file.
agent_platformagent_applications
Agent Native Tools List
Read-only catalog of every @posthog/* native tool the runner knows.
agent_platformagent_native_tools
Agent Revisions Env Keys Clear
GET / PUT / DELETE one secret by name on this revision. - `GET` → `{ key, is_set }` (never returns the value). - `PUT` → upserts `{ value }` into the env block. - `DELETE` → removes the key. No-op when it wasn't set. Per-method scope: GET is treated as a write action so the single action name maps to one consistent scope; reading whether a secret is set is restricted to writers in any case.
agent_platformagent_applications
Agent Revisions Env Keys Get
GET / PUT / DELETE one secret by name on this revision. - `GET` → `{ key, is_set }` (never returns the value). - `PUT` → upserts `{ value }` into the env block. - `DELETE` → removes the key. No-op when it wasn't set. Per-method scope: GET is treated as a write action so the single action name maps to one consistent scope; reading whether a secret is set is restricted to writers in any case.
agent_platformagent_applications
Agent Revisions Env Keys List
List the names of secrets currently set on this revision. Returns names only — values stay server-side under `EncryptedTextField`. Use this to drive the "set / unset" badge next to a declared secret in the editor UI.
agent_platformagent_applications
Agent Revisions Env Keys Set
GET / PUT / DELETE one secret by name on this revision. - `GET` → `{ key, is_set }` (never returns the value). - `PUT` → upserts `{ value }` into the env block. - `DELETE` → removes the key. No-op when it wasn't set. Per-method scope: GET is treated as a write action so the single action name maps to one consistent scope; reading whether a secret is set is restricted to writers in any case.
agent_platformagent_applications
Alerts Create
Alerts Create
alerts
Alerts Destroy
Alerts Destroy
alerts
Alerts List
Alerts List
alerts
Alerts Partial Update
Alerts Partial Update
alerts
Alerts Retrieve
Alerts Retrieve
alerts
Alerts Simulate Create
Simulate a detector on an insight's historical data. Read-only — no AlertCheck records are created.
alerts
Alerts Update
Alerts Update
alerts
Annotations Create
Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.
annotations
Annotations Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
annotations
Annotations List
Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.
annotations
Annotations Partial Update
Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.
annotations
Annotations Retrieve
Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.
annotations
Annotations Update
Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.
annotations
Approval Policies Create
Approval Policies Create
platform_featuresapproval_policies
Approval Policies Destroy
Approval Policies Destroy
platform_featuresapproval_policies
Approval Policies List
Approval Policies List
platform_featuresapproval_policies
Approval Policies Partial Update
Approval Policies Partial Update
platform_featuresapproval_policies
Approval Policies Retrieve
Approval Policies Retrieve
platform_featuresapproval_policies
Approval Policies Update
Approval Policies Update
platform_featuresapproval_policies
Batch Exports Backfills Cancel Create
Cancel a batch export backfill.
batch_exports
Batch Exports Backfills Create
Create a new backfill for a BatchExport.
batch_exports
Batch Exports Backfills List
ViewSet for BatchExportBackfill models. Allows creating and reading backfills, but not updating or deleting them.
batch_exports
Batch Exports Backfills Retrieve
ViewSet for BatchExportBackfill models. Allows creating and reading backfills, but not updating or deleting them.
batch_exports
Batch Exports Create
Batch Exports Create
batch_exportsbatch_exports
Batch Exports Destroy
Batch Exports Destroy
batch_exportsbatch_exports
Batch Exports List
Batch Exports List
batch_exportsbatch_exports
Batch Exports Logs Retrieve
Batch Exports Logs Retrieve
batch_exportsbatch_exports
Batch Exports Partial Update
Batch Exports Partial Update
batch_exportsbatch_exports
Batch Exports Pause Create
Pause a BatchExport.
batch_exportsbatch_exports
Batch Exports Retrieve
Batch Exports Retrieve
batch_exportsbatch_exports
Batch Exports Run Test Step Create
Batch Exports Run Test Step Create
batch_exportsbatch_exports
Batch Exports Run Test Step New Create
Batch Exports Run Test Step New Create
batch_exportsbatch_exports
Batch Exports Runs Cancel Create
Cancel a batch export run.
batch_exportsbatch_exports
Batch Exports Runs List
Batch Exports Runs List
batch_exportsbatch_exports
Batch Exports Runs Logs Retrieve
Batch Exports Runs Logs Retrieve
batch_exportsbatch_exports
Batch Exports Runs Retrieve
Batch Exports Runs Retrieve
batch_exportsbatch_exports
Batch Exports Runs Retry Create
Retry a batch export run. We use the same underlying mechanism as when backfilling a batch export, as retrying a run is the same as backfilling one run.
batch_exportsbatch_exports
Batch Exports Test Retrieve
Batch Exports Test Retrieve
batch_exportsbatch_exports
Batch Exports Unpause Create
Unpause a BatchExport.
batch_exportsbatch_exports
Batch Exports Update
Batch Exports Update
batch_exportsbatch_exports
Business Knowledge Documents Search List
Read-only access to parsed knowledge documents. Exposes hybrid search (``search``) and a drill-down window (``window``) so an agent (PHAI or MCP) can find and explore business knowledge chunks.
business_knowledge
Business Knowledge Documents Window List
Read-only access to parsed knowledge documents. Exposes hybrid search (``search``) and a drill-down window (``window``) so an agent (PHAI or MCP) can find and explore business knowledge chunks.
business_knowledge
Business Knowledge Gap Suggestions Accept Create
Surfaces topics the support AI couldn't answer from the knowledge base. Two list shapes controlled by the ``ticket_id`` query param: - **per-ticket** (``?ticket_id=<uuid>``): individual gap rows for that ticket. - **aggregated** (no ``ticket_id``): gaps grouped by normalized topic with counts, for the Business knowledge suggestions panel.
business_knowledge
Business Knowledge Gap Suggestions Accept Topic Create
Accept all pending suggestions for a normalized topic cluster.
business_knowledge
Business Knowledge Gap Suggestions Dismiss Create
Surfaces topics the support AI couldn't answer from the knowledge base. Two list shapes controlled by the ``ticket_id`` query param: - **per-ticket** (``?ticket_id=<uuid>``): individual gap rows for that ticket. - **aggregated** (no ``ticket_id``): gaps grouped by normalized topic with counts, for the Business knowledge suggestions panel.
business_knowledge
Business Knowledge Gap Suggestions Dismiss Topic Create
Dismiss all pending suggestions for a normalized topic cluster.
business_knowledge
Business Knowledge Gap Suggestions List
Surfaces topics the support AI couldn't answer from the knowledge base. Two list shapes controlled by the ``ticket_id`` query param: - **per-ticket** (``?ticket_id=<uuid>``): individual gap rows for that ticket. - **aggregated** (no ``ticket_id``): gaps grouped by normalized topic with counts, for the Business knowledge suggestions panel.
business_knowledge
Business Knowledge Sources Create
Business Knowledge Sources Create
business_knowledge
Business Knowledge Sources Destroy
Business Knowledge Sources Destroy
business_knowledge
Business Knowledge Sources List
Business Knowledge Sources List
business_knowledge
Business Knowledge Sources Partial Update
Business Knowledge Sources Partial Update
business_knowledge
Business Knowledge Sources Refresh Create
Business Knowledge Sources Refresh Create
business_knowledge
Business Knowledge Sources Retrieve
Business Knowledge Sources Retrieve
business_knowledge
Business Knowledge Sources Text Retrieve
Business Knowledge Sources Text Retrieve
business_knowledge
Change Requests Approve Create
Approve a change request. If quorum is reached, automatically applies the change immediately.
platform_featureschange_requests
Change Requests Cancel Create
Cancel a change request. Only the requester can cancel their own pending change request.
platform_featureschange_requests
Change Requests List
Change Requests List
platform_featureschange_requests
Change Requests Reject Create
Reject a change request.
platform_featureschange_requests
Change Requests Retrieve
Change Requests Retrieve
platform_featureschange_requests
Cimd Verification Tokens Create
Manage CIMD verification tokens for an organization. A partner embeds the plaintext token in their CIMD metadata document as `verification_token` inside the `com.posthog` object (the legacy top-level `posthog_verification_token` field still works as a fallback). When PostHog fetches the metadata, matching the token links the partner app to this organization and grants a higher default rate limit for account provisioning. The plaintext value is only available on creation; we store a hash.
organizationscimd_verification_tokens
Cimd Verification Tokens Destroy
Manage CIMD verification tokens for an organization. A partner embeds the plaintext token in their CIMD metadata document as `verification_token` inside the `com.posthog` object (the legacy top-level `posthog_verification_token` field still works as a fallback). When PostHog fetches the metadata, matching the token links the partner app to this organization and grants a higher default rate limit for account provisioning. The plaintext value is only available on creation; we store a hash.
organizationscimd_verification_tokens
Cimd Verification Tokens List
Manage CIMD verification tokens for an organization. A partner embeds the plaintext token in their CIMD metadata document as `verification_token` inside the `com.posthog` object (the legacy top-level `posthog_verification_token` field still works as a fallback). When PostHog fetches the metadata, matching the token links the partner app to this organization and grants a higher default rate limit for account provisioning. The plaintext value is only available on creation; we store a hash.
organizationscimd_verification_tokens
Cimd Verification Tokens Retrieve
Manage CIMD verification tokens for an organization. A partner embeds the plaintext token in their CIMD metadata document as `verification_token` inside the `com.posthog` object (the legacy top-level `posthog_verification_token` field still works as a fallback). When PostHog fetches the metadata, matching the token links the partner app to this organization and grants a higher default rate limit for account provisioning. The plaintext value is only available on creation; we store a hash.
organizationscimd_verification_tokens
Check access
Check whether the authenticated user has access to PostHog Code.
code-invitescode
Redeem invite code
Redeem a PostHog Code invite code to enable access.
code-invitescode
Cohorts Activity Retrieve
Cohorts Activity Retrieve
cohorts
Cohorts Add Persons To Static Cohort Partial Update
Cohorts Add Persons To Static Cohort Partial Update
cohorts
Cohorts All Activity Retrieve
Cohorts All Activity Retrieve
cohorts
Cohorts Calculation History Retrieve
Cohorts Calculation History Retrieve
cohorts
Cohorts Create
Cohorts Create
cohorts
Cohorts Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
cohorts
Cohorts List
Cohorts List
cohorts
Cohorts Partial Update
Cohorts Partial Update
cohorts
Cohorts Persons Retrieve
Cohorts Persons Retrieve
cohorts
Cohorts Remove Person From Static Cohort Partial Update
Cohorts Remove Person From Static Cohort Partial Update
cohorts
Cohorts Retrieve
Cohorts Retrieve
cohorts
Cohorts Update
Cohorts Update
cohorts
Cohorts Used In Retrieve
Cohorts Used In Retrieve
cohorts
Comments Complete Create
Mark a task-comment as complete. Sets completed_at and completed_by. 400 if the comment is not a task or is already complete.
comments
Comments Count Retrieve
Comments Count Retrieve
comments
Comments Create
Comments Create
comments
Comments Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
comments
Comments List
Comments List
comments
Comments Partial Update
Comments Partial Update
comments
Comments Reopen Create
Reopen a completed task-comment. Clears completed_at and completed_by. 400 if the comment is not a task or is already open.
comments
Comments Retrieve
Comments Retrieve
comments
Comments Thread Retrieve
Comments Thread Retrieve
comments
Comments Update
Comments Update
comments
Conversations Append Message Create
Appends a message to an existing conversation without triggering AI processing. This is used for client-side generated messages that need to be persisted (e.g., support ticket confirmation messages).
maxconversations
Conversations Cancel Partial Update
Cancel the conversation's in-progress LangGraph run.
maxconversations
Conversations Create
Unified endpoint that handles both conversation creation and streaming. - If message is provided: Start new conversation processing - If no message: Stream from existing conversation
maxconversations
Conversations Destroy
Delete a conversation.
maxconversations
Conversations List
Conversations List
maxconversations
Conversations Open Create
Create-or-resume a sandbox conversation — the single sandbox session opener. With `content`, processes the turn (first message, in-progress follow-up, or terminal resume); without `content`, warms a sandbox that idles awaiting the first message. Returns the `(task, run)` handle the frontend opens SSE against. The conversation row is created on first use from the URL id.
maxconversations
Conversations Queue Clear Create
Conversations Queue Clear Create
maxconversations
Conversations Queue Create
Conversations Queue Create
maxconversations
Conversations Queue Destroy
Conversations Queue Destroy
maxconversations
Conversations Queue Partial Update
Conversations Queue Partial Update
maxconversations
Conversations Queue Retrieve
Conversations Queue Retrieve
maxconversations
Conversations Retrieve
Conversations Retrieve
maxconversations
Conversations Tickets Ai Feedback Create
Record reviewer feedback on an AI reply, captured to the internal analytics project.
conversations
Conversations Tickets Bulk Update Status Create
Update the status of multiple tickets in a single request. Only tickets belonging to the current team are affected; other-team UUIDs are silently ignored. Tickets already in the requested status are skipped.
conversations
Conversations Tickets Bulk Update Tags Create
Bulk update tags on multiple objects. PAT access: this action has no ``required_scopes=`` on the decorator — inheriting viewsets must add ``"bulk_update_tags"`` to their ``scope_object_write_actions`` list to accept personal API keys. Without that opt-in, ``APIScopePermission`` rejects PAT requests with "This action does not support personal API key access". Done per-viewset so granting ``<scope>:write`` for one resource doesn't leak access to sibling resources that share this mixin. Accepts: - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]} Actions: - "add": Add tags to existing tags on each object - "remove": Remove specific tags from each object - "set": Replace all tags on each object with the provided list
conversations
Conversations Tickets Compose Create
Create a new outbound ticket and send the first message to the customer.
conversations
Conversations Tickets Create
Conversations Tickets Create
conversations
Conversations Tickets Destroy
Conversations Tickets Destroy
conversations
Conversations Tickets List
List tickets with person data attached.
conversations
Conversations Tickets Messages List
Return the message thread for a ticket, ordered chronologically (paginated).
conversations
Conversations Tickets Partial Update
Conversations Tickets Partial Update
conversations
Conversations Tickets Reply Create
Post a reply or internal note to a ticket. With is_private=false, the reply is delivered to the customer via the ticket's channel (email, Slack, Teams, GitHub). With is_private=true, the message is stored as an internal note only visible to team members.
conversations
Conversations Tickets Retrieve
Get single ticket and mark as read by team.
conversations
Conversations Tickets Unread Count Retrieve
Get total unread ticket count for the team. Returns the sum of unread_team_count for all non-resolved tickets. Cached in Redis for 30 seconds, invalidated on changes.
conversations
Conversations Tickets Update
Handle ticket updates including assignee changes.
conversations
Conversations Views Create
Conversations Views Create
conversations
Conversations Views Destroy
Conversations Views Destroy
conversations
Conversations Views List
Conversations Views List
conversations
Conversations Views Retrieve
Conversations Views Retrieve
conversations
Create
Create
organizationsorganizations
Create Session Summaries
Generate AI summary for a group of session recordings to find patterns and generate a notebook.
session_summaries
Create Session Summaries Individually
Generate AI individual summary for each session, without grouping.
replaysession_summaries
Custom Property Definitions Create
Custom Property Definitions Create
custom_property_definitions
Custom Property Definitions Destroy
Custom Property Definitions Destroy
custom_property_definitions
Custom Property Definitions List
Custom Property Definitions List
custom_property_definitions
Custom Property Definitions Partial Update
Custom Property Definitions Partial Update
custom_property_definitions
Custom Property Definitions Retrieve
Custom Property Definitions Retrieve
custom_property_definitions
Custom Property Definitions Update
Custom Property Definitions Update
custom_property_definitions
Custom Property Sources Create
Custom Property Sources Create
custom_property_sources
Custom Property Sources Destroy
Custom Property Sources Destroy
custom_property_sources
Custom Property Sources List
Custom Property Sources List
custom_property_sources
Custom Property Sources Partial Update
Custom Property Sources Partial Update
custom_property_sources
Custom Property Sources Retrieve
Custom Property Sources Retrieve
custom_property_sources
Custom Property Sources Update
Custom Property Sources Update
custom_property_sources
Customer Journeys Create
Customer Journeys Create
customer_journeys
Customer Journeys Destroy
Customer Journeys Destroy
customer_journeys
Customer Journeys List
Customer Journeys List
customer_journeys
Customer Journeys Partial Update
Customer Journeys Partial Update
customer_journeys
Customer Journeys Retrieve
Customer Journeys Retrieve
customer_journeys
Customer Journeys Update
Customer Journeys Update
customer_journeys
Customer Profile Configs Create
Customer Profile Configs Create
customer_profile_configs
Customer Profile Configs Destroy
Customer Profile Configs Destroy
customer_profile_configs
Customer Profile Configs List
Customer Profile Configs List
customer_profile_configs
Customer Profile Configs Partial Update
Customer Profile Configs Partial Update
customer_profile_configs
Customer Profile Configs Retrieve
Customer Profile Configs Retrieve
customer_profile_configs
Customer Profile Configs Update
Customer Profile Configs Update
customer_profile_configs
Copy a team template to this project
Creates a new team-scoped template in the **target** project (URL) from a **team-scoped** source template in the same organization. Global and feature-flag templates return 400. Cross-organization or inaccessible sources return 404. Source and destination projects must differ (400 if equal). Conflicting `template_name` values on the destination are auto-suffixed with `(copy)`, `(copy 2)`, …
dashboard_templates
Dashboard Templates Create
Dashboard Templates Create
dashboard_templates
Dashboard Templates Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
dashboard_templates
Dashboard Templates Json Schema Retrieve
Dashboard Templates Json Schema Retrieve
dashboard_templates
Dashboard Templates List
Dashboard Templates List
dashboard_templates
Dashboard Templates Partial Update
Dashboard Templates Partial Update
dashboard_templates
Dashboard Templates Retrieve
Dashboard Templates Retrieve
dashboard_templates
Dashboard Templates Update
Dashboard Templates Update
dashboard_templates
Dashboards Bulk Update Tags Create
Bulk update tags on multiple objects. PAT access: this action has no ``required_scopes=`` on the decorator — inheriting viewsets must add ``"bulk_update_tags"`` to their ``scope_object_write_actions`` list to accept personal API keys. Without that opt-in, ``APIScopePermission`` rejects PAT requests with "This action does not support personal API key access". Done per-viewset so granting ``<scope>:write`` for one resource doesn't leak access to sibling resources that share this mixin. Accepts: - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]} Actions: - "add": Add tags to existing tags on each object - "remove": Remove specific tags from each object - "set": Replace all tags on each object with the provided list
dashboards
Dashboards Collaborators Create
Dashboards Collaborators Create
dashboards
Dashboards Collaborators Destroy
Dashboards Collaborators Destroy
dashboards
Dashboards Collaborators List
Dashboards Collaborators List
dashboards
Dashboards Copy Tile Create
Copy an existing dashboard tile to another dashboard (insight, text card, or widget tile).
dashboards
Dashboards Create
Dashboards Create
dashboards
Dashboards Create From Template Json Create
Dashboards Create From Template Json Create
dashboards
Dashboards Create Text Tile Create
Add a markdown text tile to a dashboard. Text tiles render as markdown blocks on the dashboard — useful as section headings, dividers, or annotations between insight tiles to give the dashboard structure.
dashboards
Dashboards Create Unlisted Dashboard Create
Creates an unlisted dashboard from template by tag. Enforces uniqueness (one per tag per team). Returns 409 if unlisted dashboard with this tag already exists.
dashboards
Dashboards Delete Tile
Soft-delete a single tile from a dashboard. Works for text, insight, and button tiles. The underlying Insight, Text, or ButtonTile object is preserved — only the dashboard tile is hidden. To delete the entire dashboard, use the dashboard delete endpoint instead.
dashboards
Dashboards Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
dashboards
Dashboards List
Dashboards List
dashboards
Dashboards Move Tile Create
Dashboards Move Tile Create
dashboards
Dashboards Move Tile Partial Update
Dashboards Move Tile Partial Update
dashboards
Dashboards Partial Update
Dashboards Partial Update
dashboards
Dashboards Reorder Tiles Create
Dashboards Reorder Tiles Create
dashboards
Dashboards Retrieve
Dashboards Retrieve
dashboards
Dashboards Run Insights Retrieve
Run all insights on a dashboard and return their results.
dashboards
Dashboards Run Widgets Retrieve
Dashboards Run Widgets Retrieve
dashboards
Dashboards Sharing List
Dashboards Sharing List
dashboards
Dashboards Sharing Passwords Create
Create a new password for the sharing configuration.
dashboards
Dashboards Sharing Passwords Destroy
Delete a password from the sharing configuration.
dashboards
Dashboards Sharing Refresh Create
Dashboards Sharing Refresh Create
dashboards
Dashboards Stream Tiles Retrieve
Stream dashboard metadata and tiles via Server-Sent Events. Sends metadata first, then tiles as they are rendered.
dashboards
Dashboards Update
Dashboards Update
dashboards
Dashboards Update Text Tile Create
Update the markdown body, layout, or color of an existing text tile on a dashboard.
dashboards
Dashboards Update Widgets Batch
Update the settings of existing widgets in place, atomically — config, name, and description. Each entry targets a widget by its tile_id and reuses the same write path as the dashboard PATCH endpoint. The widget_type is immutable. This edits widget settings only (config, name, description); tile placement (layouts, show_description) is a dashboard concern — use the dashboard PATCH endpoint or reorder_tiles for that. All updates succeed or fail together. To add new widgets, use the widgets/batch POST endpoint; to remove one, use delete_tile.
dashboards
Dashboards Widget Catalog Retrieve
List registered dashboard widget types and per-type config_schema documentation for agents.
dashboards
Dashboards Widgets Batch Create
Add multiple widget tiles to a dashboard in one atomic request.
dashboards
Data Color Themes Create
Data Color Themes Create
data_color_themes
Data Color Themes Destroy
Data Color Themes Destroy
data_color_themes
Data Color Themes List
Data Color Themes List
data_color_themes
Data Color Themes Partial Update
Data Color Themes Partial Update
data_color_themes
Data Color Themes Retrieve
Data Color Themes Retrieve
data_color_themes
Data Color Themes Update
Data Color Themes Update
data_color_themes
Data Modeling Jobs List
List data modeling jobs which are "runs" for our saved queries.
data_modeling_jobs
Data Modeling Jobs Recent Retrieve
Get the most recent non-running job for each saved query from the v2 backend.
data_modeling_jobs
Data Modeling Jobs Retrieve
List data modeling jobs which are "runs" for our saved queries.
data_modeling_jobs
Data Modeling Jobs Running Retrieve
Get all currently running jobs from the v2 backend.
data_modeling_jobs
Data Warehouse Check Database Name Retrieve
Check if a database name is available.
data_warehouse
Data Warehouse Completed Activity Retrieve
Returns completed/non-running activities (jobs with status 'Completed'). Supports pagination and cutoff time filtering.
data_warehouse
Data Warehouse Data Health Issues Retrieve
Returns failed/disabled data pipeline items for the Pipeline status side panel. Includes: materializations, syncs, sources, destinations, and transformations.
data_warehouse
Data Warehouse Data Ops Dashboard Retrieve
Returns the data ops overview dashboard ID for this team, creating it if it doesn't exist yet.
data_warehouse
Data Warehouse Delete Org Destroy
Remove the organization's provisioning record after teardown, freeing its warehouse name. Called once the warehouse status reports `deleted`: deprovision tears the warehouse down, this removes the now-empty org row so the database_name can be reused. Restricted to organization admins.
data_warehouse
Data Warehouse Deprovision Create
Start deprovisioning the organization's managed warehouse. Restricted to organization admins.
data_warehouse
Data Warehouse Enable Backfill Create
Enable warehouse backfill for this environment with a dedicated set of tables. Requires a table name and records the environment's membership in the organization's managed warehouse. Restricted to organization admins.
data_warehouse
Data Warehouse Job Stats Retrieve
Returns success and failed job statistics for the last 1, 7, or 30 days. Query parameter 'days' can be 1, 7, or 30 (default: 7).
data_warehouse
Data Warehouse Property Values Retrieve
API endpoints for data warehouse aggregate statistics and operations.
data_warehouse
Data Warehouse Provision Create
Start provisioning a managed warehouse for this organization (shared by all its teams).
data_warehouse
Data Warehouse Reset Password Create
Reset the root password for the managed warehouse.
data_warehouse
Data Warehouse Running Activity Retrieve
Returns currently running activities (jobs with status 'Running'). Supports pagination and cutoff time filtering.
data_warehouse
Data Warehouse Total Rows Stats Retrieve
Returns aggregated statistics for the data warehouse total rows processed within the current billing period. Used by the frontend data warehouse scene to display usage information.
data_warehouse
Data Warehouse Warehouse Status Retrieve
Get the current provisioning status of the managed warehouse, with this project's backfill state.
data_warehouse
Dataset Items Create
Dataset Items Create
dataset_items
Dataset Items Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
dataset_items
Dataset Items List
Dataset Items List
dataset_items
Dataset Items Partial Update
Dataset Items Partial Update
dataset_items
Dataset Items Retrieve
Dataset Items Retrieve
dataset_items
Dataset Items Update
Dataset Items Update
dataset_items
Datasets Create
Datasets Create
datasets
Datasets Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
datasets
Datasets List
Datasets List
datasets
Datasets Partial Update
Datasets Partial Update
datasets
Datasets Retrieve
Datasets Retrieve
datasets
Datasets Update
Datasets Update
datasets
Desktop File System Canvas Partial Update
Publish a new version of a freeform canvas's React source. Merges into the dashboard row's `meta` (never replaces it), so existing keys like `channelId`/`templateId` survive. Appends a full-file version snapshot and points `currentVersionId` at it — the server-side mirror of the app's dashboardsService.saveFreeform.
desktop_file_system
Desktop File System Context Generation Retrieve
Return the Task currently generating this folder's CONTEXT.md, or null if none.
desktop_file_system
Desktop File System Context Generation Update
Set or clear the Task associated with this folder's CONTEXT.md generation.
desktop_file_system
Desktop File System Count By Path Create
Get count of all files in a folder.
desktop_file_system
Desktop File System Count Create
Get count of all files in a folder.
desktop_file_system
Desktop File System Create
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree. Adds per-folder, versioned markdown instructions describing the contents of a folder.
desktop_file_system
Desktop File System Destroy
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree. Adds per-folder, versioned markdown instructions describing the contents of a folder.
desktop_file_system
Desktop File System Instructions Destroy
Soft-delete every version of this folder's instructions.
desktop_file_system
Desktop File System Instructions Partial Update
Publish a new version of the folder's instructions.
desktop_file_system
Desktop File System Instructions Retrieve
Return the latest non-deleted instructions for this folder.
desktop_file_system
Desktop File System Instructions Update
Publish a new version of the folder's instructions.
desktop_file_system
Desktop File System Instructions Versions List
List the version history for this folder's instructions, newest first.
desktop_file_system
Desktop File System Link Create
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree. Adds per-folder, versioned markdown instructions describing the contents of a folder.
desktop_file_system
Desktop File System List
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree. Adds per-folder, versioned markdown instructions describing the contents of a folder.
desktop_file_system
Desktop File System Log View Create
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree. Adds per-folder, versioned markdown instructions describing the contents of a folder.
desktop_file_system
Desktop File System Log View Retrieve
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree. Adds per-folder, versioned markdown instructions describing the contents of a folder.
desktop_file_system
Desktop File System Move Create
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree. Adds per-folder, versioned markdown instructions describing the contents of a folder.
desktop_file_system
Desktop File System Partial Update
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree. Adds per-folder, versioned markdown instructions describing the contents of a folder.
desktop_file_system
Desktop File System Retrieve
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree. Adds per-folder, versioned markdown instructions describing the contents of a folder.
desktop_file_system
Desktop File System Shortcut Create
Sidebar shortcuts for the desktop product surface. Reuses all FileSystemShortcutViewSet behaviour but is scoped to the "desktop" surface, so its shortcuts are fully isolated from the default "web" surface.
desktop_file_system_shortcut
Desktop File System Shortcut Destroy
Sidebar shortcuts for the desktop product surface. Reuses all FileSystemShortcutViewSet behaviour but is scoped to the "desktop" surface, so its shortcuts are fully isolated from the default "web" surface.
desktop_file_system_shortcut
Desktop File System Shortcut List
Sidebar shortcuts for the desktop product surface. Reuses all FileSystemShortcutViewSet behaviour but is scoped to the "desktop" surface, so its shortcuts are fully isolated from the default "web" surface.
desktop_file_system_shortcut
Desktop File System Shortcut Partial Update
Sidebar shortcuts for the desktop product surface. Reuses all FileSystemShortcutViewSet behaviour but is scoped to the "desktop" surface, so its shortcuts are fully isolated from the default "web" surface.
desktop_file_system_shortcut
Desktop File System Shortcut Reorder Create
Set the display order of the current user's shortcuts. `ordered_ids` becomes the new top-to-bottom order; any unknown IDs are rejected.
desktop_file_system_shortcut
Desktop File System Shortcut Retrieve
Sidebar shortcuts for the desktop product surface. Reuses all FileSystemShortcutViewSet behaviour but is scoped to the "desktop" surface, so its shortcuts are fully isolated from the default "web" surface.
desktop_file_system_shortcut
Desktop File System Shortcut Update
Sidebar shortcuts for the desktop product surface. Reuses all FileSystemShortcutViewSet behaviour but is scoped to the "desktop" surface, so its shortcuts are fully isolated from the default "web" surface.
desktop_file_system_shortcut
Desktop File System Undo Delete Create
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree. Adds per-folder, versioned markdown instructions describing the contents of a folder.
desktop_file_system
Desktop File System Unfiled Retrieve
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree. Adds per-folder, versioned markdown instructions describing the contents of a folder.
desktop_file_system
Desktop File System Update
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree. Adds per-folder, versioned markdown instructions describing the contents of a folder.
desktop_file_system
Destroy
Destroy
organizationsorganizations
Search PostHog documentation
Run a hybrid (semantic + full-text) RAG search over the PostHog documentation via Inkeep. Returns a markdown body with title, URL, and excerpt for each match for the agent to cite back to the user.
docsmcp_tools
Domains Create
Domains Create
organizationsdomains
Domains Destroy
Domains Destroy
organizationsdomains
Domains List
Domains List
organizationsdomains
Domains Partial Update
Domains Partial Update
organizationsdomains
Domains Retrieve
Domains Retrieve
organizationsdomains
Domains Scim Logs Retrieve
Domains Scim Logs Retrieve
organizationsdomains
Domains Scim Token Create
Regenerate SCIM bearer token.
organizationsdomains
Domains Update
Domains Update
organizationsdomains
Domains Verify Create
Domains Verify Create
organizationsdomains
Early Access Feature Create
Early Access Feature Create
early_access_feature
Early Access Feature Destroy
Early Access Feature Destroy
early_access_feature
Early Access Feature List
Early Access Feature List
early_access_feature
Early Access Feature Partial Update
Early Access Feature Partial Update
early_access_feature
Early Access Feature Retrieve
Early Access Feature Retrieve
early_access_feature
Early Access Feature Update
Early Access Feature Update
early_access_feature
Elements Create
Elements Create
elements
Elements Destroy
Elements Destroy
elements
Elements List
Elements List
elements
Elements Partial Update
Elements Partial Update
elements
Elements Retrieve
Elements Retrieve
elements
Elements Stats Retrieve
Counts of $autocapture, $rageclick, and $dead_click events grouped by the element chain they occurred on, ordered by count. Defaults to all three event types; narrow with the include parameter.
elements
Elements Update
Elements Update
elements
Elements Values List
Elements Values List
elements
Endpoints Create
Create a new endpoint.
endpoints
Endpoints Destroy
Delete an endpoint and clean up materialized query.
endpoints
Endpoints Last Execution Times Create
Get the most recent execution time per endpoint (endpoint-level). Timestamps are recorded by the run path for personal-API-key calls. For per-version usage, query the query_log table directly.
endpoints
Endpoints List
List all endpoints for the team.
endpoints
Endpoints Logs Retrieve
Endpoints Logs Retrieve
endpoints
Endpoints Materialization Conditions Retrieve
Get the source code of the live materialization checks, plus the rewrite contract. Lets an agent rewrite a rejected endpoint query itself: fetch these conditions, produce a semantically equivalent query that passes every check, update the endpoint with it, then confirm via materialization_status. The source is read from the running system, so it always matches the checks this instance enforces.
endpoints
Endpoints Materialization Preview Create
Preview the materialization transform for an endpoint. Shows what the query will look like after materialization, including range pair detection and bucket functions.
endpoints
Endpoints Materialization Status Retrieve
Get materialization status for an endpoint. Supports ?version=N query param.
endpoints
Endpoints Materialization Suggestion Create
Ask AI to rewrite the endpoint's query into a semantically equivalent form that can be materialized. Only applicable to SQL (HogQL) endpoints that currently fail the materialization checks. The suggestion is validated against the live checks before being returned; nothing is saved. Requires the organization's AI data processing approval.
endpoints
Endpoints Openapi Spec Retrieve
Get OpenAPI 3.0 specification for this endpoint. Use this to generate typed SDK clients.
endpoints
Endpoints Partial Update
Update an existing endpoint.
endpoints
Endpoints Retrieve
Retrieve an endpoint, or a specific version via ?version=N.
endpoints
Endpoints Run Create
Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set.
endpoints
Endpoints Run Retrieve
Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set.
endpoints
Endpoints Update
Update an existing endpoint. Parameters are optional. Pass version in body or ?version=N query param to target a specific version.
endpoints
Endpoints Versions List
List all versions for an endpoint.
endpoints
Engineering Analytics Author Workflow Costs
One author's estimated CI cost split by workflow over a window (date_from default -30d), highest spend first. Runs are attributed to the author through their pull requests (attribution is by PR number). Returns an empty list when the job-level source isn't synced.
engineering_analyticsengineering_analytics
Engineering Analytics Ci Cards
Headline counts for the open-PR backlog: open PRs, distinct repos, stuck PRs (open, non-draft, non-bot, older than 7 days), and PRs with failing CI. The failing-CI count rests on the head-SHA join and can lag until late CI completions settle.
engineering_analyticsengineering_analytics
Engineering Analytics Ci Failure Logs
The thinned CI failure logs for a pull request, grouped by failed job. Resolves the PR to its workflow runs via the pull_requests association (all of the PR's pushes, not just the latest commit), then reads the Logs product joined on run_id. Returns failed jobs only (the worker fetches logs for failures); logs_available is false when CI hasn't failed, the logs aged out of the short Logs retention, or a fork PR has no run association. Each line carries its original 1-based line number in the full pre-thinning log; lines are the failure region (errors plus surrounding context, with omission markers), capped per job and overall.
engineering_analyticsengineering_analytics
Engineering Analytics Flaky Tests
The flaky-test leaderboard: backend tests ranked by flakiness signal from the per-test CI spans, over a window (default -7d, maximum 30 days). A test qualifies by passing on retry at least min_rerun_passes times OR failing on at least min_failed_prs distinct PRs. All figures are absolute counts, never rates: fast passing runs are not emitted, so denominators are biased. Pass-on-retry counts only flow from CI lanes running with reruns enabled; in other lanes a flake surfaces as a plain failure, which the distinct-PR count catches.
engineering_analyticsengineering_analytics
Engineering Analytics Job Aggregates
Per-job aggregates for one workflow over a window (default -30d), one row per de-sharded job name (matrix shards aggregate together), busiest first: queue p50, duration p50/p95, failure rate, retry pressure, run share (below 1.0 = conditional job), and billable cost. Jobs always need their run as context — this is the aggregate view; use workflow_jobs for one run's jobs. Empty when the job-level source isn't synced.
engineering_analyticsengineering_analytics
Engineering Analytics Master Failures
Default-branch failures over a window (default -24h), grouped error-tracking style by (workflow, de-sharded failing job) with a run count and first/last seen, newest group first. `branch` overrides the detected default branch. PR-branch failures are deliberately excluded — at monorepo volume a flat feed is a firehose; those surface per PR. Groups degrade to workflow level (failed_job '') when the job-level source isn't synced.
engineering_analyticsengineering_analytics
Engineering Analytics Pr Cost
Estimated CI cost for a pull request, summed over the jobs of all its workflow runs. Billable self-hosted Linux runners only — provider-hosted (free GitHub-hosted) and non-Linux jobs are excluded. Every figure is zero/null with `jobs_available` false when the job-level source isn't synced yet.
engineering_analyticsengineering_analytics
Engineering Analytics Pr Lifecycle
The timeline of a single pull request: header plus ordered events (opened, CI started/finished, merged or closed). Use this to answer 'where is this PR stuck and what happened to it'. This is a partial view: review and comment events are not yet available.
engineering_analyticsengineering_analytics
Engineering Analytics Pr Runs
Every workflow run attributed to a pull request, across all its commits (grouped by head SHA client-side), newest first. Run-level only.
engineering_analyticsengineering_analytics
Engineering Analytics Pull Requests
Open pull requests plus any merged or closed since date_from (default -30d), newest first, each with its head-SHA CI rollup. The list is capped; when more match, `truncated` is true and the ci_cards counts can exceed it. open_to_merge_seconds is coarse — it fuses draft and ready-for-review time; CI counts can lag until late completions settle.
engineering_analyticsengineering_analytics
Flaky-test quarantine file
The repository's checked-in .test_quarantine.json: flaky tests temporarily quarantined with a hard expiry, classified by urgency (overdue, in grace, expiring soon, active). `available` is false when the repo has no quarantine file — that is not an error. Parsing is fail-open: malformed entries are reported in parse_errors while well-formed ones are kept.
engineering_analyticsengineering_analytics
Quarantine, extend, or unquarantine a flaky test
Opens a pull request that edits the repository's checked-in .test_quarantine.json — and, for a new quarantine, a tracking issue the PR links but does not close. The file stays the source of truth that CI enforces; this never bypasses it. A quarantine only affects CI runs that start after the PR merges.
engineering_analyticsengineering_analytics
Engineering Analytics Repo Overview
Repo-level headline aggregates over a window (default -30d): run count, success rate, re-run cycles, median PR open-to-merge (bots and drafts excluded; coarse — draft and ready time fused), and billable minutes + estimated cost — each with its equal-length previous-window twin so a caller can render honest deltas. Also carries the detected default branch and its completed-run history series. Cost figures are null until the job-level source is synced.
engineering_analyticsengineering_analytics
Engineering Analytics Repo Run Activity
Default-branch health as compact chart points over a window (default -30d), newest first, for the repo-hub run-activity chart. All of a commit's workflow runs are collapsed into ONE point per commit (head SHA): its earliest workflow start, wall-clock duration until the last workflow settled (null while any is still running), and an overall conclusion that is 'failure' if any workflow decisively failed, else 'success' when at least one passed, else 'neutral'. `branch` overrides the detected default branch. `truncated` is true when more commits matched than the cap, so the chart covers only the most recent commits.
engineering_analyticsengineering_analytics
Engineering Analytics Run Failure Logs
The thinned CI failure logs of one workflow run, grouped by failed job — the run-scoped twin of ci_failure_logs for surfaces that aren't PR-scoped (default-branch failures, the run page). logs_available is false when the run didn't fail or its logs aged out of the short Logs retention.
engineering_analyticsengineering_analytics
Engineering Analytics Sources
The team's connected GitHub data warehouse sources, oldest first. Populate a source picker from this and pass a chosen `id` back as `source_id` to the other endpoints. A team can connect GitHub more than once (e.g. one source per repository); this lists them all, including any whose tables aren't fully synced yet.
engineering_analyticsengineering_analytics
Engineering Analytics Workflow Health
Per-workflow CI health over a window (default last 24 hours, maximum 366 days): run count, success rate, p50/p95 duration over completed runs, last failure time, latest-run status, and a zero-filled run history bucketed by hour/day/week to fit the window. Optionally scope to a single git branch via `branch`. Use this for 'is CI getting slower' and 'which workflow is the long pole'; compare two windows to get a trend.
engineering_analyticsengineering_analytics
Engineering Analytics Workflow Jobs
Jobs of a single workflow run attempt, with per-job duration, runner tier, and estimated cost. Scoped to one run_attempt (the latest unless specified) so a re-run's attempts don't merge. Returns an empty list when the job-level source isn't synced yet.
engineering_analyticsengineering_analytics
Engineering Analytics Workflow Run
A single workflow run: status, conclusion, duration, branch, attempt, and the attributed pull request. Run-level only — per-job and per-step detail are not tracked yet.
engineering_analyticsengineering_analytics
Engineering Analytics Workflow Run Activity
Compact per-run points for a single workflow over a window (date_from default -30d), newest first, for the run-activity chart: each run's start time, duration, conclusion, branch, and attributed PR. Optionally scope to a single git branch via `branch`, matching workflow_runs. Leaner and higher-capped than workflow_runs so the chart spans the full window even on busy workflows; `truncated` is true when the cap is hit, so the chart covers only the most recent runs.
engineering_analyticsengineering_analytics
Engineering Analytics Workflow Runner Costs
A workflow's estimated CI cost broken down by runner tier over a window (date_from default -30d), highest spend first. Optionally scope to a single git branch via `branch`. Returns an empty list when the job-level source isn't synced.
engineering_analyticsengineering_analytics
Engineering Analytics Workflow Runs
Runs of a single workflow within a repo over a window (date_from default -30d), newest first. Optionally scope to a single git branch via `branch`. Each row is run-level — per-job and per-step detail are not tracked yet. Use this as the GitHub 'workflow' page between the workflow list and a single run.
engineering_analyticsengineering_analytics
Environment Vision Quota Retrieve
Environment Vision Quota Retrieve
vision
Environments Accounts Create
Environments Accounts Create
accounts
Environments Accounts Destroy
Environments Accounts Destroy
accounts
Environments Accounts List
Environments Accounts List
accounts
Environments Accounts Notebooks Create
Environments Accounts Notebooks Create
customer_analyticsaccounts
Environments Accounts Notebooks Destroy
Environments Accounts Notebooks Destroy
customer_analyticsaccounts
Environments Accounts Notebooks List
Environments Accounts Notebooks List
customer_analyticsaccounts
Environments Accounts Notebooks Retrieve
Environments Accounts Notebooks Retrieve
customer_analyticsaccounts
Environments Accounts Partial Update
Environments Accounts Partial Update
accounts
Environments Accounts Retrieve
Environments Accounts Retrieve
accounts
Environments Accounts Update
Environments Accounts Update
accounts
Environments Activity Retrieve
Deprecated: use /api/environments/{id}/ instead.
environments
Environments Add Product Intent Partial Update
Deprecated: use /api/environments/{id}/ instead.
environments
Environments Alerts Create
Environments Alerts Create
alerts
Environments Alerts Destroy
Environments Alerts Destroy
alerts
Environments Alerts List
Environments Alerts List
alerts
Environments Alerts Partial Update
Environments Alerts Partial Update
alerts
Environments Alerts Retrieve
Environments Alerts Retrieve
alerts
Environments Alerts Simulate Create
Simulate a detector on an insight's historical data. Read-only — no AlertCheck records are created.
alerts
Environments Alerts Update
Environments Alerts Update
alerts
Environments Approval Policies Create
Environments Approval Policies Create
platform_featuresapproval_policies
Environments Approval Policies Destroy
Environments Approval Policies Destroy
platform_featuresapproval_policies
Environments Approval Policies List
Environments Approval Policies List
platform_featuresapproval_policies
Environments Approval Policies Partial Update
Environments Approval Policies Partial Update
platform_featuresapproval_policies
Environments Approval Policies Retrieve
Environments Approval Policies Retrieve
platform_featuresapproval_policies
Environments Approval Policies Update
Environments Approval Policies Update
platform_featuresapproval_policies
Environments Batch Exports Backfills Cancel Create
Cancel a batch export backfill.
batch_exports
Environments Batch Exports Backfills Create
Create a new backfill for a BatchExport.
batch_exports
Environments Batch Exports Backfills List
ViewSet for BatchExportBackfill models. Allows creating and reading backfills, but not updating or deleting them.
batch_exports
Environments Batch Exports Backfills Retrieve
ViewSet for BatchExportBackfill models. Allows creating and reading backfills, but not updating or deleting them.
batch_exports
Environments Batch Exports Create
Environments Batch Exports Create
batch_exportsbatch_exports
Environments Batch Exports Destroy
Environments Batch Exports Destroy
batch_exportsbatch_exports
Environments Batch Exports List
Environments Batch Exports List
batch_exportsbatch_exports
Environments Batch Exports Logs Retrieve
Environments Batch Exports Logs Retrieve
batch_exportsbatch_exports
Environments Batch Exports Partial Update
Environments Batch Exports Partial Update
batch_exportsbatch_exports
Environments Batch Exports Pause Create
Pause a BatchExport.
batch_exportsbatch_exports
Environments Batch Exports Retrieve
Environments Batch Exports Retrieve
batch_exportsbatch_exports
Environments Batch Exports Run Test Step Create
Environments Batch Exports Run Test Step Create
batch_exportsbatch_exports
Environments Batch Exports Run Test Step New Create
Environments Batch Exports Run Test Step New Create
batch_exportsbatch_exports
Environments Batch Exports Runs Cancel Create
Cancel a batch export run.
batch_exportsbatch_exports
Environments Batch Exports Runs List
Environments Batch Exports Runs List
batch_exportsbatch_exports
Environments Batch Exports Runs Logs Retrieve
Environments Batch Exports Runs Logs Retrieve
batch_exportsbatch_exports
Environments Batch Exports Runs Retrieve
Environments Batch Exports Runs Retrieve
batch_exportsbatch_exports
Environments Batch Exports Runs Retry Create
Retry a batch export run. We use the same underlying mechanism as when backfilling a batch export, as retrying a run is the same as backfilling one run.
batch_exportsbatch_exports
Environments Batch Exports Test Retrieve
Environments Batch Exports Test Retrieve
batch_exportsbatch_exports
Environments Batch Exports Unpause Create
Unpause a BatchExport.
batch_exportsbatch_exports
Environments Batch Exports Update
Environments Batch Exports Update
batch_exportsbatch_exports
Environments Change Requests Approve Create
Approve a change request. If quorum is reached, automatically applies the change immediately.
platform_featureschange_requests
Environments Change Requests Cancel Create
Cancel a change request. Only the requester can cancel their own pending change request.
platform_featureschange_requests
Environments Change Requests List
Environments Change Requests List
platform_featureschange_requests
Environments Change Requests Reject Create
Reject a change request.
platform_featureschange_requests
Environments Change Requests Retrieve
Environments Change Requests Retrieve
platform_featureschange_requests
Environments Complete Product Onboarding Partial Update
Deprecated: use /api/environments/{id}/ instead.
environments
Environments Conversations Append Message Create
Appends a message to an existing conversation without triggering AI processing. This is used for client-side generated messages that need to be persisted (e.g., support ticket confirmation messages).
maxconversations
Environments Conversations Cancel Partial Update
Cancel the conversation's in-progress LangGraph run.
maxconversations
Environments Conversations Create
Unified endpoint that handles both conversation creation and streaming. - If message is provided: Start new conversation processing - If no message: Stream from existing conversation
maxconversations
Environments Conversations Destroy
Delete a conversation.
maxconversations
Environments Conversations List
Environments Conversations List
maxconversations
Environments Conversations Open Create
Create-or-resume a sandbox conversation — the single sandbox session opener. With `content`, processes the turn (first message, in-progress follow-up, or terminal resume); without `content`, warms a sandbox that idles awaiting the first message. Returns the `(task, run)` handle the frontend opens SSE against. The conversation row is created on first use from the URL id.
maxconversations
Environments Conversations Queue Clear Create
Environments Conversations Queue Clear Create
maxconversations
Environments Conversations Queue Create
Environments Conversations Queue Create
maxconversations
Environments Conversations Queue Destroy
Environments Conversations Queue Destroy
maxconversations
Environments Conversations Queue Partial Update
Environments Conversations Queue Partial Update
maxconversations
Environments Conversations Queue Retrieve
Environments Conversations Queue Retrieve
maxconversations
Environments Conversations Retrieve
Environments Conversations Retrieve
maxconversations
Environments Conversations Views Create
Environments Conversations Views Create
conversations
Environments Conversations Views Destroy
Environments Conversations Views Destroy
conversations
Environments Conversations Views List
Environments Conversations Views List
conversations
Environments Conversations Views Retrieve
Environments Conversations Views Retrieve
conversations
Environments Create
Deprecated: use /api/environments/{id}/ instead.
environments
Environments Create Session Summaries
Generate AI summary for a group of session recordings to find patterns and generate a notebook.
session_summaries
Environments Create Session Summaries Individually
Generate AI individual summary for each session, without grouping.
replaysession_summaries
Environments Custom Property Definitions Create
Environments Custom Property Definitions Create
custom_property_definitions
Environments Custom Property Definitions Destroy
Environments Custom Property Definitions Destroy
custom_property_definitions
Environments Custom Property Definitions List
Environments Custom Property Definitions List
custom_property_definitions
Environments Custom Property Definitions Partial Update
Environments Custom Property Definitions Partial Update
custom_property_definitions
Environments Custom Property Definitions Retrieve
Environments Custom Property Definitions Retrieve
custom_property_definitions
Environments Custom Property Definitions Update
Environments Custom Property Definitions Update
custom_property_definitions
Environments Customer Journeys Create
Environments Customer Journeys Create
customer_journeys
Environments Customer Journeys Destroy
Environments Customer Journeys Destroy
customer_journeys
Environments Customer Journeys List
Environments Customer Journeys List
customer_journeys
Environments Customer Journeys Partial Update
Environments Customer Journeys Partial Update
customer_journeys
Environments Customer Journeys Retrieve
Environments Customer Journeys Retrieve
customer_journeys
Environments Customer Journeys Update
Environments Customer Journeys Update
customer_journeys
Environments Customer Profile Configs Create
Environments Customer Profile Configs Create
customer_profile_configs
Environments Customer Profile Configs Destroy
Environments Customer Profile Configs Destroy
customer_profile_configs
Environments Customer Profile Configs List
Environments Customer Profile Configs List
customer_profile_configs
Environments Customer Profile Configs Partial Update
Environments Customer Profile Configs Partial Update
customer_profile_configs
Environments Customer Profile Configs Retrieve
Environments Customer Profile Configs Retrieve
customer_profile_configs
Environments Customer Profile Configs Update
Environments Customer Profile Configs Update
customer_profile_configs
Environments Dashboards Bulk Update Tags Create
Bulk update tags on multiple objects. PAT access: this action has no ``required_scopes=`` on the decorator — inheriting viewsets must add ``"bulk_update_tags"`` to their ``scope_object_write_actions`` list to accept personal API keys. Without that opt-in, ``APIScopePermission`` rejects PAT requests with "This action does not support personal API key access". Done per-viewset so granting ``<scope>:write`` for one resource doesn't leak access to sibling resources that share this mixin. Accepts: - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]} Actions: - "add": Add tags to existing tags on each object - "remove": Remove specific tags from each object - "set": Replace all tags on each object with the provided list
dashboards
Environments Dashboards Collaborators Create
Environments Dashboards Collaborators Create
dashboards
Environments Dashboards Collaborators Destroy
Environments Dashboards Collaborators Destroy
dashboards
Environments Dashboards Collaborators List
Environments Dashboards Collaborators List
dashboards
Environments Dashboards Copy Tile Create
Copy an existing dashboard tile to another dashboard (insight, text card, or widget tile).
dashboards
Environments Dashboards Create
Environments Dashboards Create
dashboards
Environments Dashboards Create From Template Json Create
Environments Dashboards Create From Template Json Create
dashboards
Environments Dashboards Create Text Tile Create
Add a markdown text tile to a dashboard. Text tiles render as markdown blocks on the dashboard — useful as section headings, dividers, or annotations between insight tiles to give the dashboard structure.
dashboards
Environments Dashboards Create Unlisted Dashboard Create
Creates an unlisted dashboard from template by tag. Enforces uniqueness (one per tag per team). Returns 409 if unlisted dashboard with this tag already exists.
dashboards
Environments Dashboards Delete Tile
Soft-delete a single tile from a dashboard. Works for text, insight, and button tiles. The underlying Insight, Text, or ButtonTile object is preserved — only the dashboard tile is hidden. To delete the entire dashboard, use the dashboard delete endpoint instead.
dashboards
Environments Dashboards Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
dashboards
Environments Dashboards List
Environments Dashboards List
dashboards
Environments Dashboards Move Tile Create
Environments Dashboards Move Tile Create
dashboards
Environments Dashboards Move Tile Partial Update
Environments Dashboards Move Tile Partial Update
dashboards
Environments Dashboards Partial Update
Environments Dashboards Partial Update
dashboards
Environments Dashboards Reorder Tiles Create
Environments Dashboards Reorder Tiles Create
dashboards
Environments Dashboards Retrieve
Environments Dashboards Retrieve
dashboards
Environments Dashboards Run Insights Retrieve
Run all insights on a dashboard and return their results.
dashboards
Environments Dashboards Run Widgets Retrieve
Environments Dashboards Run Widgets Retrieve
dashboards
Environments Dashboards Sharing List
Environments Dashboards Sharing List
dashboards
Environments Dashboards Sharing Passwords Create
Create a new password for the sharing configuration.
dashboards
Environments Dashboards Sharing Passwords Destroy
Delete a password from the sharing configuration.
dashboards
Environments Dashboards Sharing Refresh Create
Environments Dashboards Sharing Refresh Create
dashboards
Environments Dashboards Stream Tiles Retrieve
Stream dashboard metadata and tiles via Server-Sent Events. Sends metadata first, then tiles as they are rendered.
dashboards
Environments Dashboards Update
Environments Dashboards Update
dashboards
Environments Dashboards Update Text Tile Create
Update the markdown body, layout, or color of an existing text tile on a dashboard.
dashboards
Environments Dashboards Update Widgets Batch
Update the settings of existing widgets in place, atomically — config, name, and description. Each entry targets a widget by its tile_id and reuses the same write path as the dashboard PATCH endpoint. The widget_type is immutable. This edits widget settings only (config, name, description); tile placement (layouts, show_description) is a dashboard concern — use the dashboard PATCH endpoint or reorder_tiles for that. All updates succeed or fail together. To add new widgets, use the widgets/batch POST endpoint; to remove one, use delete_tile.
dashboards
Environments Dashboards Widget Catalog Retrieve
List registered dashboard widget types and per-type config_schema documentation for agents.
dashboards
Environments Dashboards Widgets Batch Create
Add multiple widget tiles to a dashboard in one atomic request.
dashboards
Environments Data Color Themes Create
Environments Data Color Themes Create
data_color_themes
Environments Data Color Themes Destroy
Environments Data Color Themes Destroy
data_color_themes
Environments Data Color Themes List
Environments Data Color Themes List
data_color_themes
Environments Data Color Themes Partial Update
Environments Data Color Themes Partial Update
data_color_themes
Environments Data Color Themes Retrieve
Environments Data Color Themes Retrieve
data_color_themes
Environments Data Color Themes Update
Environments Data Color Themes Update
data_color_themes
Environments Data Modeling Jobs List
List data modeling jobs which are "runs" for our saved queries.
data_modeling_jobs
Environments Data Modeling Jobs Recent Retrieve
Get the most recent non-running job for each saved query from the v2 backend.
data_modeling_jobs
Environments Data Modeling Jobs Retrieve
List data modeling jobs which are "runs" for our saved queries.
data_modeling_jobs
Environments Data Modeling Jobs Running Retrieve
Get all currently running jobs from the v2 backend.
data_modeling_jobs
Environments Data Warehouse Check Database Name Retrieve
Check if a database name is available.
data_warehouse
Environments Data Warehouse Completed Activity Retrieve
Returns completed/non-running activities (jobs with status 'Completed'). Supports pagination and cutoff time filtering.
data_warehouse
Environments Data Warehouse Data Health Issues Retrieve
Returns failed/disabled data pipeline items for the Pipeline status side panel. Includes: materializations, syncs, sources, destinations, and transformations.
data_warehouse
Environments Data Warehouse Data Ops Dashboard Retrieve
Returns the data ops overview dashboard ID for this team, creating it if it doesn't exist yet.
data_warehouse
Environments Data Warehouse Delete Org Destroy
Remove the organization's provisioning record after teardown, freeing its warehouse name. Called once the warehouse status reports `deleted`: deprovision tears the warehouse down, this removes the now-empty org row so the database_name can be reused. Restricted to organization admins.
data_warehouse
Environments Data Warehouse Deprovision Create
Start deprovisioning the organization's managed warehouse. Restricted to organization admins.
data_warehouse
Environments Data Warehouse Enable Backfill Create
Enable warehouse backfill for this environment with a dedicated set of tables. Requires a table name and records the environment's membership in the organization's managed warehouse. Restricted to organization admins.
data_warehouse
Environments Data Warehouse Job Stats Retrieve
Returns success and failed job statistics for the last 1, 7, or 30 days. Query parameter 'days' can be 1, 7, or 30 (default: 7).
data_warehouse
Environments Data Warehouse Property Values Retrieve
API endpoints for data warehouse aggregate statistics and operations.
data_warehouse
Environments Data Warehouse Provision Create
Start provisioning a managed warehouse for this organization (shared by all its teams).
data_warehouse
Environments Data Warehouse Reset Password Create
Reset the root password for the managed warehouse.
data_warehouse
Environments Data Warehouse Running Activity Retrieve
Returns currently running activities (jobs with status 'Running'). Supports pagination and cutoff time filtering.
data_warehouse
Environments Data Warehouse Total Rows Stats Retrieve
Returns aggregated statistics for the data warehouse total rows processed within the current billing period. Used by the frontend data warehouse scene to display usage information.
data_warehouse
Environments Data Warehouse Warehouse Status Retrieve
Get the current provisioning status of the managed warehouse, with this project's backfill state.
data_warehouse
Environments Dataset Items Create
Environments Dataset Items Create
dataset_items
Environments Dataset Items Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
dataset_items
Environments Dataset Items List
Environments Dataset Items List
dataset_items
Environments Dataset Items Partial Update
Environments Dataset Items Partial Update
dataset_items
Environments Dataset Items Retrieve
Environments Dataset Items Retrieve
dataset_items
Environments Dataset Items Update
Environments Dataset Items Update
dataset_items
Environments Datasets Create
Environments Datasets Create
datasets
Environments Datasets Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
datasets
Environments Datasets List
Environments Datasets List
datasets
Environments Datasets Partial Update
Environments Datasets Partial Update
datasets
Environments Datasets Retrieve
Environments Datasets Retrieve
datasets
Environments Datasets Update
Environments Datasets Update
datasets
Environments Default Evaluation Contexts Create
Manage default evaluation contexts for a team.
environments
Environments Default Evaluation Contexts Destroy
Manage default evaluation contexts for a team.
environments
Environments Default Evaluation Contexts Retrieve
Manage default evaluation contexts for a team.
environments
Environments Default Release Conditions Retrieve
Manage default release conditions for new feature flags in this team.
environments
Environments Default Release Conditions Update
Manage default release conditions for new feature flags in this team.
environments
Environments Delete Secret Token Backup Partial Update
Deprecated: use /api/environments/{id}/ instead.
environments
Environments Destroy
Deprecated: use /api/environments/{id}/ instead.
environments
Search PostHog documentation
Run a hybrid (semantic + full-text) RAG search over the PostHog documentation via Inkeep. Returns a markdown body with title, URL, and excerpt for each match for the agent to cite back to the user.
docsmcp_tools
Environments Elements Create
Environments Elements Create
elements
Environments Elements Destroy
Environments Elements Destroy
elements
Environments Elements List
Environments Elements List
elements
Environments Elements Partial Update
Environments Elements Partial Update
elements
Environments Elements Retrieve
Environments Elements Retrieve
elements
Environments Elements Stats Retrieve
Counts of $autocapture, $rageclick, and $dead_click events grouped by the element chain they occurred on, ordered by count. Defaults to all three event types; narrow with the include parameter.
elements
Environments Elements Update
Environments Elements Update
elements
Environments Elements Values List
Environments Elements Values List
elements
Environments Endpoints Create
Create a new endpoint.
endpoints
Environments Endpoints Destroy
Delete an endpoint and clean up materialized query.
endpoints
Environments Endpoints Last Execution Times Create
Get the most recent execution time per endpoint (endpoint-level). Timestamps are recorded by the run path for personal-API-key calls. For per-version usage, query the query_log table directly.
endpoints
Environments Endpoints List
List all endpoints for the team.
endpoints
Environments Endpoints Logs Retrieve
Environments Endpoints Logs Retrieve
endpoints
Environments Endpoints Materialization Conditions Retrieve
Get the source code of the live materialization checks, plus the rewrite contract. Lets an agent rewrite a rejected endpoint query itself: fetch these conditions, produce a semantically equivalent query that passes every check, update the endpoint with it, then confirm via materialization_status. The source is read from the running system, so it always matches the checks this instance enforces.
endpoints
Environments Endpoints Materialization Preview Create
Preview the materialization transform for an endpoint. Shows what the query will look like after materialization, including range pair detection and bucket functions.
endpoints
Environments Endpoints Materialization Status Retrieve
Get materialization status for an endpoint. Supports ?version=N query param.
endpoints
Environments Endpoints Materialization Suggestion Create
Ask AI to rewrite the endpoint's query into a semantically equivalent form that can be materialized. Only applicable to SQL (HogQL) endpoints that currently fail the materialization checks. The suggestion is validated against the live checks before being returned; nothing is saved. Requires the organization's AI data processing approval.
endpoints
Environments Endpoints Openapi Spec Retrieve
Get OpenAPI 3.0 specification for this endpoint. Use this to generate typed SDK clients.
endpoints
Environments Endpoints Partial Update
Update an existing endpoint.
endpoints
Environments Endpoints Retrieve
Retrieve an endpoint, or a specific version via ?version=N.
endpoints
Environments Endpoints Run Create
Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set.
endpoints
Environments Endpoints Run Retrieve
Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set.
endpoints
Environments Endpoints Update
Update an existing endpoint. Parameters are optional. Pass version in body or ?version=N query param to target a specific version.
endpoints
Environments Endpoints Versions List
List all versions for an endpoint.
endpoints
Environments Environment Vision Quota Retrieve
Environments Environment Vision Quota Retrieve
vision
Environments Error Tracking Assignment Rules Create
Environments Error Tracking Assignment Rules Create
error_tracking
Environments Error Tracking Assignment Rules Destroy
Environments Error Tracking Assignment Rules Destroy
error_tracking
Environments Error Tracking Assignment Rules List
Environments Error Tracking Assignment Rules List
error_tracking
Environments Error Tracking Assignment Rules Partial Update
Environments Error Tracking Assignment Rules Partial Update
error_tracking
Environments Error Tracking Assignment Rules Reorder Partial Update
Environments Error Tracking Assignment Rules Reorder Partial Update
error_tracking
Environments Error Tracking Assignment Rules Retrieve
Environments Error Tracking Assignment Rules Retrieve
error_tracking
Environments Error Tracking Assignment Rules Update
Environments Error Tracking Assignment Rules Update
error_tracking
Environments Error Tracking Bypass Rules Create
Environments Error Tracking Bypass Rules Create
error_tracking
Environments Error Tracking Bypass Rules Destroy
Environments Error Tracking Bypass Rules Destroy
error_tracking
Environments Error Tracking Bypass Rules List
Environments Error Tracking Bypass Rules List
error_tracking
Environments Error Tracking Bypass Rules Partial Update
Environments Error Tracking Bypass Rules Partial Update
error_tracking
Environments Error Tracking Bypass Rules Reorder Partial Update
Environments Error Tracking Bypass Rules Reorder Partial Update
error_tracking
Environments Error Tracking Bypass Rules Retrieve
Environments Error Tracking Bypass Rules Retrieve
error_tracking
Environments Error Tracking Bypass Rules Update
Environments Error Tracking Bypass Rules Update
error_tracking
Environments Error Tracking External References Create
Environments Error Tracking External References Create
error_tracking
Environments Error Tracking External References Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
error_tracking
Environments Error Tracking External References List
Environments Error Tracking External References List
error_tracking
Environments Error Tracking External References Retrieve
Environments Error Tracking External References Retrieve
error_tracking
Environments Error Tracking Fingerprints Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
error_tracking
Environments Error Tracking Fingerprints List
Environments Error Tracking Fingerprints List
error_tracking
Environments Error Tracking Fingerprints Retrieve
Environments Error Tracking Fingerprints Retrieve
error_tracking
Environments Error Tracking Git Provider File Links Resolve Github Retrieve
Environments Error Tracking Git Provider File Links Resolve Github Retrieve
error_tracking
Environments Error Tracking Git Provider File Links Resolve Gitlab Retrieve
Environments Error Tracking Git Provider File Links Resolve Gitlab Retrieve
error_tracking
Environments Error Tracking Grouping Rules Create
Environments Error Tracking Grouping Rules Create
error_tracking
Environments Error Tracking Grouping Rules Destroy
Environments Error Tracking Grouping Rules Destroy
error_tracking
Environments Error Tracking Grouping Rules List
Environments Error Tracking Grouping Rules List
error_tracking
Environments Error Tracking Grouping Rules Partial Update
Environments Error Tracking Grouping Rules Partial Update
error_tracking
Environments Error Tracking Grouping Rules Reorder Partial Update
Environments Error Tracking Grouping Rules Reorder Partial Update
error_tracking
Environments Error Tracking Grouping Rules Retrieve
Environments Error Tracking Grouping Rules Retrieve
error_tracking
Environments Error Tracking Grouping Rules Update
Environments Error Tracking Grouping Rules Update
error_tracking
Environments Error Tracking Issues Activity Retrieve
Environments Error Tracking Issues Activity Retrieve
error_tracking
Environments Error Tracking Issues All Activity Retrieve
Environments Error Tracking Issues All Activity Retrieve
error_tracking
Environments Error Tracking Issues Assign Partial Update
Environments Error Tracking Issues Assign Partial Update
error_tracking
Environments Error Tracking Issues Bulk Create
Environments Error Tracking Issues Bulk Create
error_tracking
Environments Error Tracking Issues Cohort Update
Environments Error Tracking Issues Cohort Update
error_tracking
Environments Error Tracking Issues Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
error_tracking
Environments Error Tracking Issues Exists Retrieve
Environments Error Tracking Issues Exists Retrieve
error_tracking
Environments Error Tracking Issues List
Environments Error Tracking Issues List
error_tracking
Environments Error Tracking Issues Merge Create
Environments Error Tracking Issues Merge Create
error_tracking
Environments Error Tracking Issues Partial Update
Environments Error Tracking Issues Partial Update
error_tracking
Environments Error Tracking Issues Retrieve
Environments Error Tracking Issues Retrieve
error_tracking
Environments Error Tracking Issues Split Create
Environments Error Tracking Issues Split Create
error_tracking
Environments Error Tracking Issues Update
Environments Error Tracking Issues Update
error_tracking
Environments Error Tracking Issues Values Retrieve
Environments Error Tracking Issues Values Retrieve
error_tracking
Get compact error tracking issue details
Fetch one error tracking issue with impact counts, top in_app frame, latest release, and optional sparkline.
error_tracking
List sampled exception events for an error tracking issue
Fetch sampled exception events, stack traces, browser/SDK context, URL, and $session_id values for one issue.
error_tracking
List compact error tracking issues
List error tracking issues with typed filters and compact aggregate counts.
error_tracking
Environments Error Tracking Recommendations Dismiss Create
Environments Error Tracking Recommendations Dismiss Create
error_tracking
Environments Error Tracking Recommendations List
Environments Error Tracking Recommendations List
error_tracking
Environments Error Tracking Recommendations Refresh Create
Environments Error Tracking Recommendations Refresh Create
error_tracking
Environments Error Tracking Recommendations Restore Create
Environments Error Tracking Recommendations Restore Create
error_tracking
Environments Error Tracking Releases Create
Environments Error Tracking Releases Create
error_tracking
Environments Error Tracking Releases Destroy
Environments Error Tracking Releases Destroy
error_tracking
Environments Error Tracking Releases Hash Retrieve
Environments Error Tracking Releases Hash Retrieve
error_tracking
Environments Error Tracking Releases List
Environments Error Tracking Releases List
error_tracking
Environments Error Tracking Releases Partial Update
Environments Error Tracking Releases Partial Update
error_tracking
Environments Error Tracking Releases Retrieve
Environments Error Tracking Releases Retrieve
error_tracking
Environments Error Tracking Releases Update
Environments Error Tracking Releases Update
error_tracking
Environments Error Tracking Settings Retrieve Settings Retrieve
Environments Error Tracking Settings Retrieve Settings Retrieve
error_tracking
Environments Error Tracking Settings Update Settings Partial Update
Environments Error Tracking Settings Update Settings Partial Update
error_tracking
Environments Error Tracking Spike Detection Config List
Environments Error Tracking Spike Detection Config List
error_tracking
Environments Error Tracking Spike Detection Config Update Config Partial Update
Environments Error Tracking Spike Detection Config Update Config Partial Update
error_tracking
Environments Error Tracking Spike Events List
Environments Error Tracking Spike Events List
error_tracking
Environments Error Tracking Stack Frames Batch Get Create
Environments Error Tracking Stack Frames Batch Get Create
error_tracking
Environments Error Tracking Stack Frames Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
error_tracking
Environments Error Tracking Stack Frames List
Environments Error Tracking Stack Frames List
error_tracking
Environments Error Tracking Stack Frames Retrieve
Environments Error Tracking Stack Frames Retrieve
error_tracking
Environments Error Tracking Suppression Rules Create
Environments Error Tracking Suppression Rules Create
error_tracking
Environments Error Tracking Suppression Rules Destroy
Environments Error Tracking Suppression Rules Destroy
error_tracking
Environments Error Tracking Suppression Rules List
Environments Error Tracking Suppression Rules List
error_tracking
Environments Error Tracking Suppression Rules Partial Update
Environments Error Tracking Suppression Rules Partial Update
error_tracking
Environments Error Tracking Suppression Rules Reorder Partial Update
Environments Error Tracking Suppression Rules Reorder Partial Update
error_tracking
Environments Error Tracking Suppression Rules Retrieve
Environments Error Tracking Suppression Rules Retrieve
error_tracking
Environments Error Tracking Suppression Rules Update
Environments Error Tracking Suppression Rules Update
error_tracking
Environments Error Tracking Symbol Sets Bulk Delete Create
Environments Error Tracking Symbol Sets Bulk Delete Create
error_tracking
Environments Error Tracking Symbol Sets Bulk Finish Upload Create
Environments Error Tracking Symbol Sets Bulk Finish Upload Create
error_tracking
Environments Error Tracking Symbol Sets Bulk Start Upload Create
Environments Error Tracking Symbol Sets Bulk Start Upload Create
error_tracking
Environments Error Tracking Symbol Sets Destroy
Environments Error Tracking Symbol Sets Destroy
error_tracking
Environments Error Tracking Symbol Sets Download Retrieve
Return a presigned URL for downloading the symbol set's source map.
error_tracking
Environments Error Tracking Symbol Sets Finish Upload Update
Environments Error Tracking Symbol Sets Finish Upload Update
error_tracking
Environments Error Tracking Symbol Sets List
Environments Error Tracking Symbol Sets List
error_tracking
Environments Error Tracking Symbol Sets Retrieve
Environments Error Tracking Symbol Sets Retrieve
error_tracking
Environments Evaluation Context Suggestions Create
Hide an evaluation context name from the flag editor's suggestion list, or restore it. POST hides the name; DELETE restores it. The underlying context row and any flags already using it are never modified — this only controls what gets suggested.
environments
Environments Evaluation Context Suggestions Destroy
Hide an evaluation context name from the flag editor's suggestion list, or restore it. POST hides the name; DELETE restores it. The underlying context row and any flags already using it are never modified — this only controls what gets suggested.
environments
Environments Evaluation Runs Create
Create a new evaluation run. This endpoint validates the request and enqueues a Temporal workflow to asynchronously execute the evaluation.
evaluation_runs
Environments Evaluations Create
Environments Evaluations Create
evaluations
Environments Evaluations Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
evaluations
Environments Evaluations List
Environments Evaluations List
evaluations
Environments Evaluations Partial Update
Environments Evaluations Partial Update
evaluations
Environments Evaluations Retrieve
Environments Evaluations Retrieve
evaluations
Environments Evaluations Test Hog Create
Test Hog evaluation code against sample events without saving.
evaluations
Environments Evaluations Update
Environments Evaluations Update
evaluations
Environments Event Filter Create
Create or update the event filter config.
event_filter
Environments Event Filter Metrics Retrieve
Single event filter per team. GET /event_filter/ — returns the config (or null if not yet created) POST /event_filter/ — creates or updates the config (upsert) GET /event_filter/metrics/ — time-series metrics GET /event_filter/metrics/totals/ — aggregate totals
event_filter
Environments Event Filter Metrics Totals Retrieve
Single event filter per team. GET /event_filter/ — returns the config (or null if not yet created) POST /event_filter/ — creates or updates the config (upsert) GET /event_filter/metrics/ — time-series metrics GET /event_filter/metrics/totals/ — aggregate totals
event_filter
Environments Event Filter Retrieve
Returns the event filter config for the team, or null if not yet created.
event_filter
Environments Event Ingestion Restrictions Retrieve
Deprecated: use /api/environments/{id}/ instead.
environments
Environments Events List
This endpoint allows you to list and filter events. It is effectively deprecated and is kept only for backwards compatibility. If you ever ask about it you will be advised to not use it... If you want to ad-hoc list or aggregate events, use the Query endpoint instead. If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.
events
Environments Events Retrieve
Environments Events Retrieve
events
Environments Events Values Retrieve
Environments Events Values Retrieve
events
Environments Experiments Config Partial Update
Manage experiment configuration for this environment.
environments
Environments Experiments Config Retrieve
Manage experiment configuration for this environment.
environments
Environments Exports Content Retrieve
Environments Exports Content Retrieve
exports
Environments Exports Create
Environments Exports Create
exports
Environments Exports List
Environments Exports List
exports
Environments Exports Retrieve
Environments Exports Retrieve
exports
Environments External Data Schemas Cancel Create
Environments External Data Schemas Cancel Create
external_data_schemas
Environments External Data Schemas Create
Environments External Data Schemas Create
external_data_schemas
Environments External Data Schemas Delete Data Destroy
Environments External Data Schemas Delete Data Destroy
external_data_schemas
Environments External Data Schemas Destroy
Environments External Data Schemas Destroy
external_data_schemas
Environments External Data Schemas Incremental Fields Create
Environments External Data Schemas Incremental Fields Create
external_data_schemas
Environments External Data Schemas List
Environments External Data Schemas List
external_data_schemas
Environments External Data Schemas Logs Retrieve
Environments External Data Schemas Logs Retrieve
external_data_schemas
Environments External Data Schemas Partial Update
Environments External Data Schemas Partial Update
external_data_schemas
Environments External Data Schemas Reload Create
Environments External Data Schemas Reload Create
external_data_schemas
Environments External Data Schemas Resync Create
Environments External Data Schemas Resync Create
external_data_schemas
Environments External Data Schemas Retrieve
Environments External Data Schemas Retrieve
external_data_schemas
Environments External Data Schemas Update
Environments External Data Schemas Update
external_data_schemas
Environments External Data Sources Bulk Update Schemas Partial Update
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Cdc Status Retrieve
Live CDC health for an existing source: slot/publication existence and WAL lag. Reads from the source DB via the engine adapter. Returns ``{"enabled": false}`` when CDC is off, or the stored config plus live ``slot_exists`` / ``publication_exists`` / ``lag_bytes`` when on. 400s if the source DB is unreachable so the UI can show a degraded/unreachable state.
external_data_sources
Environments External Data Sources Check Cdc Prerequisites Create
Validate CDC prerequisites against a live Postgres connection. Used by the source wizard to surface ✅/❌ checks before source creation, and by the self-managed setup popup to verify user-created publications.
external_data_sources
Environments External Data Sources Check Cdc Prerequisites For Source Create
Validate CDC prerequisites for an existing source using its stored credentials. The detail=False ``check_cdc_prerequisites`` action is for the creation wizard, where the client still holds the raw connection config (incl. password) in the form. On the Configuration page the source already exists and secret fields are stripped from API responses — so the client can't supply them. This reads the stored (encrypted) credentials from the DB via the adapter instead. Body params: ``cdc_management_mode`` (``"posthog"`` | ``"self_managed"``), ``cdc_slot_name`` (optional), ``cdc_publication_name`` (optional).
external_data_sources
Environments External Data Sources Connect Link Retrieve
Return a secure browser link for connecting a data warehouse source. The link opens a minimal connect page rendering the source's full connection form — OAuth options included — with no table selection and no source creation. The user authenticates in their browser, secrets never pass through the agent, and the agent finishes setup afterwards by passing the stored credential id to data-warehouse-source-setup.
external_data_sources
Environments External Data Sources Connections List
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Create
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Create Webhook Create
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Database Schema Create
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Delete Webhook Create
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Destroy
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Disable Cdc Create
Disable CDC on an existing source. Cancels any running CDC extraction workflow, deletes the extraction schedule, delegates engine-side teardown to the source's adapter (drops slot/publication for Postgres; equivalent for other engines), clears ``cdc_*`` keys from ``job_inputs``, soft-deletes companion CDC tables, and sets all CDC schemas to ``sync_type=None``, ``should_sync=False`` so the user must pick a new sync strategy before they resume.
external_data_sources
Environments External Data Sources Draft Custom Manifest Create
Draft a Custom REST source manifest from API documentation using an LLM. Reads the docs (a URL fetched server-side, or pasted text / OpenAPI spec), asks the model to author a RESTAPIConfig manifest, and validates it against the create-path checks — repairing against validation errors up to a small budget. Returns the manifest for the user to review and tweak in the builder before creating the source; it does NOT create anything. Gated by the `dwh-custom-source-ai-builder` flag, and requires the org to have approved AI data processing, since the docs are sent to the LLM gateway.
external_data_sources
Environments External Data Sources Enable Cdc Create
Enable CDC on an existing source. Provisions engine-side CDC resources via the source's adapter, writes the CDC config into ``source.job_inputs``, and ensures the CDC extraction schedule exists. Re-runs prereq checks server-side so we never trust a stale client-side check. Body params: ``cdc_management_mode`` (``"posthog"`` | ``"self_managed"``), plus engine-specific identifier hints (e.g. ``cdc_slot_name``, ``cdc_publication_name`` for Postgres). Universal tuning fields: ``cdc_auto_drop_slot`` (optional bool), ``cdc_lag_warning_threshold_mb`` (optional int), ``cdc_lag_critical_threshold_mb`` (optional int).
external_data_sources
Environments External Data Sources Jobs Retrieve
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources List
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Partial Update
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Preview Resource Create
Read a bounded sample of rows for one resource of a Custom REST source. Lets a manifest author verify `data_selector`, `primary_key`, and the incremental `cursor_path` against live data before creating the source. Only `source_type: "Custom"` is supported — other source types return 400. The read is bounded (single page per resource, capped row count, short timeouts, no redirects). Manifest, validation, and SSRF problems return 400; a live fetch failure returns 200 with `error` set and empty `rows`.
external_data_sources
Environments External Data Sources Refresh Schemas Create
Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync).
external_data_sources
Environments External Data Sources Reload Create
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Repair Cdc Create
Repair CDC on a source whose replication resources were lost. Only proceeds on evidence of breakage (a persisted broken marker, or a live probe showing the slot/publication missing) — repairing a healthy source would drop its slot and force a full re-sync. Cancels running CDC jobs, recreates the engine-side slot/publication against the stored CDC config, resets every active CDC schema to snapshot mode for a full re-sync (changes since the old slot died are unrecoverable), clears the broken markers, and resumes the paused schedules. Idempotent: safe to retry after a partial failure. Concurrent repairs of the same source are rejected with a 409.
external_data_sources
Environments External Data Sources Retrieve
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Revenue Analytics Config Partial Update
Update the revenue analytics configuration and return the full external data source.
external_data_sources
Environments External Data Sources Setup Create
One-shot data warehouse source setup. Validate credentials, discover available tables, enable them all with sensible sync defaults (incremental where supported, else append, else full refresh), and create the source in a single call — the caller never has to assemble a `schemas` array. For sources that support webhooks (e.g. Stripe), a webhook is auto-registered after creation: on success webhook-capable tables switch to real-time webhook sync (unlocking webhook-only tables); on failure the polling defaults stay in place. For fine-grained table/sync control, use the lower-level `database_schema` + `create` flow instead.
external_data_sources
Environments External Data Sources Source Prefix Create
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Store Credentials Create
Validate and store credentials for a data warehouse source without creating the source. Backs the source connect page: the user enters credentials directly in PostHog, they are checked against a live connection, then stashed encrypted in a temporary store. The returned credential id can be passed to `setup` as {'credential_id': <id>} to create the source — so secrets never travel through an agent conversation. The stash is single-use: it is deleted as soon as `setup` consumes it, and expires after 24 hours if never consumed.
external_data_sources
Environments External Data Sources Stored Credentials List
List credentials stored via the source connect page that haven't been consumed yet. Returns metadata only (id, source type, timestamps) — never the secrets themselves. Stored credentials are temporary: they disappear once consumed by `setup` or when they expire. Newest first, so after a user confirms they've finished the connect page, the first entry for the source type is the one to pass to `setup`.
external_data_sources
Environments External Data Sources Update
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Update Cdc Settings Create
Update CDC tuning fields without enabling/disabling. Lets users edit ``cdc_auto_drop_slot``, ``cdc_lag_warning_threshold_mb``, and ``cdc_lag_critical_threshold_mb`` independently. These fields are universal across engines. Engine-specific identifiers (slot name, management mode, …) are immutable post-enable — switching them requires disable + enable.
external_data_sources
Environments External Data Sources Update Webhook Inputs Create
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Webhook Info Retrieve
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments External Data Sources Wizard Retrieve
Create, Read, Update and Delete External data Sources.
external_data_sources
Environments File Download Batch Exports Cancel Create
Cancel an ongoing file-download batch export.
batch_exportsfile_download_batch_exports
Environments File Download Batch Exports Create
Create and start a batch export on demand run to download a file.
batch_exportsfile_download_batch_exports
Environments File Download Batch Exports Download Retrieve
Download a file (or a part) from this batch export run. Users can provide a part component with an id or index, or no part component at all: * If part id is included: The file download matching the id is downloaded. * If part index is included: The file download matching the index (as ordered by key) is downloaded. * If no part component is present: If there is only one file downloaded, that is downloaded. Otherwise the first one as sorted by key is downloaded.
batch_exportsfile_download_batch_exports
Environments File Download Batch Exports List
Environments File Download Batch Exports List
batch_exportsfile_download_batch_exports
Environments File Download Batch Exports Logs Retrieve
Environments File Download Batch Exports Logs Retrieve
batch_exportsfile_download_batch_exports
Environments File Download Batch Exports Retrieve
Get a batch export on demand run. If the underlying batch export run has completed, we return keys to the generated file downloads so that users may download them by making a request to /download.
batch_exportsfile_download_batch_exports
Environments File System Count By Path Create
Get count of all files in a folder.
file_system
Environments File System Count Create
Get count of all files in a folder.
file_system
Environments File System Create
Environments File System Create
file_system
Environments File System Destroy
Environments File System Destroy
file_system
Environments File System Link Create
Environments File System Link Create
file_system
Environments File System List
Environments File System List
file_system
Environments File System Log View Create
Environments File System Log View Create
file_system
Environments File System Log View Retrieve
Environments File System Log View Retrieve
file_system
Environments File System Move Create
Environments File System Move Create
file_system
Environments File System Partial Update
Environments File System Partial Update
file_system
Environments File System Retrieve
Environments File System Retrieve
file_system
Environments File System Shortcut Create
Environments File System Shortcut Create
file_system_shortcut
Environments File System Shortcut Destroy
Environments File System Shortcut Destroy
file_system_shortcut
Environments File System Shortcut List
Environments File System Shortcut List
file_system_shortcut
Environments File System Shortcut Partial Update
Environments File System Shortcut Partial Update
file_system_shortcut
Environments File System Shortcut Reorder Create
Set the display order of the current user's shortcuts. `ordered_ids` becomes the new top-to-bottom order; any unknown IDs are rejected.
file_system_shortcut
Environments File System Shortcut Retrieve
Environments File System Shortcut Retrieve
file_system_shortcut
Environments File System Shortcut Update
Environments File System Shortcut Update
file_system_shortcut
Environments File System Undo Delete Create
Environments File System Undo Delete Create
file_system
Environments File System Unfiled Retrieve
Environments File System Unfiled Retrieve
file_system
Environments File System Update
Environments File System Update
file_system
Environments Generate Conversations Public Token Create
Deprecated: use /api/environments/{id}/ instead.
environments
Environments Groups Activity Retrieve
Environments Groups Activity Retrieve
groups
Environments Groups Create
Environments Groups Create
groups
Environments Groups Delete Property Create
Environments Groups Delete Property Create
groups
Environments Groups Find Retrieve
Environments Groups Find Retrieve
groups
Environments Groups List
List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/. Uses forward-only keyset pagination via the `cursor` parameter. The `previous` field in the response envelope is always null.
groups
Environments Groups Property Values Retrieve
Environments Groups Property Values Retrieve
groups
Environments Groups Related Retrieve
Environments Groups Related Retrieve
groups
Environments Groups Update Property Create
Environments Groups Update Property Create
groups
List health issues
Lists health issues detected across all of this project's PostHog health checks (outdated SDKs, data warehouse sync failures, missing web analytics events, ingestion warnings, and more). Filter by status, severity, kind, or dismissed state.
health_issues
Environments Health Issues Partial Update
Environments Health Issues Partial Update
health_issues
Environments Health Issues Refresh Create
Environments Health Issues Refresh Create
health_issues
Environments Health Issues Resolve Create
Environments Health Issues Resolve Create
health_issues
Get a health issue
Fetches a single health issue, enriched with the owning check's rendered explanation: a title, a one-line summary of what's wrong, a deep link to the relevant page, and remediation guidance for how to fix it.
health_issues
Summarize active health issues
Returns aggregated counts of active, non-dismissed health issues for the project, broken down by severity and by kind. Use for a quick overview of overall project health before drilling in with the list endpoint.
health_issues
Environments Heatmap Screenshots Content Retrieve
Fetch the rendered screenshot image (JPEG bytes) for a saved heatmap at a given viewport width. Returns 202 with the saved-heatmap metadata while the screenshot is still being generated.
heatmap_screenshots
Environments Heatmaps Events Retrieve
Drill into the individual session interactions behind one or more heatmap coordinates. Pass the 'points' you want to inspect (from the heatmaps list response) to get the underlying per-session events, so you can jump to the session recordings that produced a hotspot.
heatmaps
Environments Heatmaps List
Aggregated heatmap interactions for a page. For type 'click'/'rageclick'/'mousemove' each result is a point with relative x, absolute client-y, and a count. For type 'scrolldepth' the response is scroll-depth buckets instead (cumulative reach down the page).
heatmaps
Environments Hog Flows Asset Content Retrieve
Environments Hog Flows Asset Content Retrieve
hog_flows
Environments Hog Flows Assets Retrieve
Environments Hog Flows Assets Retrieve
hog_flows
Environments Hog Flows Batch Jobs Create
Environments Hog Flows Batch Jobs Create
hog_flows
Environments Hog Flows Batch Jobs List
Environments Hog Flows Batch Jobs List
hog_flows
Environments Hog Flows Bulk Delete Create
Environments Hog Flows Bulk Delete Create
hog_flows
Environments Hog Flows Create
Environments Hog Flows Create
hog_flows
Environments Hog Flows Destroy
Environments Hog Flows Destroy
hog_flows
Environments Hog Flows Graph Partial Update
Environments Hog Flows Graph Partial Update
hog_flows
Environments Hog Flows Invocation Result Retrieve
Environments Hog Flows Invocation Result Retrieve
hog_flows
Environments Hog Flows Invocation Results Retrieve
Environments Hog Flows Invocation Results Retrieve
hog_flows
Environments Hog Flows Invocations Create
Environments Hog Flows Invocations Create
hog_flows
Environments Hog Flows List
Environments Hog Flows List
hog_flows
Environments Hog Flows Logs Retrieve
Environments Hog Flows Logs Retrieve
hog_flows
Environments Hog Flows Metrics Global Retrieve
Environments Hog Flows Metrics Global Retrieve
hog_flows
Environments Hog Flows Metrics Retrieve
Environments Hog Flows Metrics Retrieve
hog_flows
Environments Hog Flows Metrics Totals Retrieve
Environments Hog Flows Metrics Totals Retrieve
hog_flows
Environments Hog Flows Partial Update
Environments Hog Flows Partial Update
hog_flows
Environments Hog Flows Rerun Create
Rerun past invocations of this hog flow from their stored payloads. Same shape and semantics as the hog function rerun endpoint — proxies through to the CDP worker, which reads matching rows from ClickHouse, rehydrates from `invocation_globals`, and re-enqueues onto cyclotron with `is_retry=1`. Because rerun replays historical event/person/group data, it requires `person:read` and `group:read` on top of `hog_flow:write`.
hog_flows
Environments Hog Flows Retrieve
Environments Hog Flows Retrieve
hog_flows
Environments Hog Flows Schedules Create
Environments Hog Flows Schedules Create
hog_flows
Environments Hog Flows Schedules Destroy
Environments Hog Flows Schedules Destroy
hog_flows
Environments Hog Flows Schedules List
Environments Hog Flows Schedules List
hog_flows
Environments Hog Flows Schedules Partial Update
Environments Hog Flows Schedules Partial Update
hog_flows
Environments Hog Flows Update
Environments Hog Flows Update
hog_flows
Environments Hog Flows User Blast Radius Create
Environments Hog Flows User Blast Radius Create
hog_flows
Environments Hog Functions Create
Environments Hog Functions Create
hog_functionshog_functions
Environments Hog Functions Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
hog_functionshog_functions
Environments Hog Functions Enable Backfills Create
Environments Hog Functions Enable Backfills Create
hog_functionshog_functions
Environments Hog Functions Icon Retrieve
Environments Hog Functions Icon Retrieve
hog_functionshog_functions
Environments Hog Functions Icons Retrieve
Environments Hog Functions Icons Retrieve
hog_functionshog_functions
Environments Hog Functions Invocations Create
Environments Hog Functions Invocations Create
hog_functionshog_functions
Environments Hog Functions List
Environments Hog Functions List
hog_functionshog_functions
Environments Hog Functions Logs Retrieve
Environments Hog Functions Logs Retrieve
hog_functionshog_functions
Environments Hog Functions Metrics Retrieve
Environments Hog Functions Metrics Retrieve
hog_functionshog_functions
Environments Hog Functions Metrics Totals Retrieve
Environments Hog Functions Metrics Totals Retrieve
hog_functionshog_functions
Environments Hog Functions Partial Update
Environments Hog Functions Partial Update
hog_functionshog_functions
Environments Hog Functions Rearrange Partial Update
Update the execution order of multiple HogFunctions.
hog_functionshog_functions
Environments Hog Functions Rerun Create
Rerun past invocations of this hog function from their stored payloads. The CDP worker reads matching rows from the `hog_invocation_results` ClickHouse table, rehydrates the invocation from the stored `invocation_globals`, and re-enqueues onto cyclotron. Each rerun run reuses the original `invocation_id` with `is_retry=1` set on the new lifecycle row so the UI can surface that it was a rerun. For source-webhook functions the worker strips `request.headers` from the rehydrated globals before re-enqueuing (see the rerun paginator): those headers carry the inbound sender's credentials, and replaying them through a reconfigured function would let a write-access user exfiltrate stored secrets. Because rerun replays historical event/person/group data, it requires `person:read` and `group:read` on top of `hog_function:write`.
hog_functionshog_functions
Environments Hog Functions Retrieve
Environments Hog Functions Retrieve
hog_functionshog_functions
Environments Hog Functions Update
Environments Hog Functions Update
hog_functionshog_functions
Environments Insight Variables Create
Environments Insight Variables Create
insight_variables
Environments Insight Variables Destroy
Environments Insight Variables Destroy
insight_variables
Environments Insight Variables List
Environments Insight Variables List
insight_variables
Environments Insight Variables Partial Update
Environments Insight Variables Partial Update
insight_variables
Environments Insight Variables Retrieve
Environments Insight Variables Retrieve
insight_variables
Environments Insight Variables Update
Environments Insight Variables Update
insight_variables
Environments Insights Activity Retrieve
Audit trail for a single insight — every change made to it, by whom, and when. Use this when you want the change history of a specific insight; use the project-wide activity endpoint for a broader view.
insights
Environments Insights All Activity Retrieve
Project-wide audit trail across all insights — who created, edited, deleted, or restored insights, what changed (with before/after diffs), and when. Useful for surfacing what people (or agents) have been working on recently.
insights
Environments Insights Analyze Retrieve
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Environments Insights Bulk Delete Create
Soft-delete insights in bulk by ID. Mirrors the single-insight delete: sets deleted=True, soft-deletes the insights' dashboard tiles, and removes their linked alerts. Insights the requester cannot edit are skipped and reported in `skipped`. Reversible via the bulk_restore endpoint.
insights
Environments Insights Bulk Restore Create
Restore soft-deleted insights in bulk by ID — the inverse of bulk_delete. Sets deleted=False and re-activates the insights' dashboard tiles on dashboards that still exist. Linked alerts are not restored (they are removed on delete). Insights the requester cannot edit are reported in `skipped`.
insights
Environments Insights Bulk Update Tags Create
Bulk update tags on multiple objects. PAT access: this action has no ``required_scopes=`` on the decorator — inheriting viewsets must add ``"bulk_update_tags"`` to their ``scope_object_write_actions`` list to accept personal API keys. Without that opt-in, ``APIScopePermission`` rejects PAT requests with "This action does not support personal API key access". Done per-viewset so granting ``<scope>:write`` for one resource doesn't leak access to sibling resources that share this mixin. Accepts: - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]} Actions: - "add": Add tags to existing tags on each object - "remove": Remove specific tags from each object - "set": Replace all tags on each object with the provided list
insights
Environments Insights Cancel Create
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Environments Insights Create
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Environments Insights Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
insights
Environments Insights Generate Metadata Create
Generate an AI-suggested name and description for an insight based on its query configuration.
insights
Environments Insights List
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Environments Insights My Last Viewed Retrieve
Returns basic details about the last 5 insights viewed by this user. Most recently viewed first.
insights
Environments Insights Partial Update
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Environments Insights Retrieve
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Environments Insights Sharing List
Environments Insights Sharing List
insights
Environments Insights Sharing Passwords Create
Create a new password for the sharing configuration.
insights
Environments Insights Sharing Passwords Destroy
Delete a password from the sharing configuration.
insights
Environments Insights Sharing Refresh Create
Environments Insights Sharing Refresh Create
insights
Environments Insights Suggestions Create
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Environments Insights Suggestions Retrieve
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Environments Insights Thresholds List
Environments Insights Thresholds List
insights
Environments Insights Thresholds Retrieve
Environments Insights Thresholds Retrieve
insights
Environments Insights Trending Retrieve
Returns insights ranked by view count over the last N days (default 7), highest first. Each result includes the same metadata as the standard insights list, plus a `view_count` and up to 3 recent `viewers`. Useful for surfacing the most-used insights in a project.
insights
Environments Insights Update
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Environments Insights Viewed Create
Record that the current user has just viewed one or more insights. Submitted ids that do not belong to the current project or that point at deleted insights are silently dropped. Returns 201 on success regardless of how many ids were retained.
insights
Environments Integrations Anthropic Managed Agent Envs Retrieve
Environments Integrations Anthropic Managed Agent Envs Retrieve
integrations
Environments Integrations Anthropic Managed Agent Vaults Retrieve
Environments Integrations Anthropic Managed Agent Vaults Retrieve
integrations
Environments Integrations Anthropic Managed Agents Retrieve
Environments Integrations Anthropic Managed Agents Retrieve
integrations
Environments Integrations Authorize Retrieve
Environments Integrations Authorize Retrieve
integrations
Environments Integrations Channels Retrieve
Environments Integrations Channels Retrieve
integrations
Environments Integrations Clickup Lists Retrieve
Environments Integrations Clickup Lists Retrieve
integrations
Environments Integrations Clickup Spaces Retrieve
Environments Integrations Clickup Spaces Retrieve
integrations
Environments Integrations Clickup Workspaces Retrieve
Environments Integrations Clickup Workspaces Retrieve
integrations
Environments Integrations Create
Environments Integrations Create
integrations
Environments Integrations Destroy
Environments Integrations Destroy
integrations
Environments Integrations Domain Connect Apply Url Create
Unified endpoint for generating Domain Connect apply URLs. Accepts a context ("email" or "proxy") and the relevant resource ID. The backend resolves the domain, template variables, and service ID based on context, then builds the signed apply URL.
integrations
Environments Integrations Domain Connect Check Retrieve
Environments Integrations Domain Connect Check Retrieve
integrations
Environments Integrations Email Partial Update
Environments Integrations Email Partial Update
integrations
Environments Integrations Email Verify Create
Environments Integrations Email Verify Create
integrations
Environments Integrations Github Branches Retrieve
Environments Integrations Github Branches Retrieve
integrations
Environments Integrations Github Link Existing Create
Reuse a GitHub installation already linked to a sibling team in the same organization.
integrations
Environments Integrations Github Oauth Authorize Create
Mint a User OAuth URL to bootstrap a fresh `code` when the install flow returns without one.
integrations
Environments Integrations Github Prepare Callback Create
Seed GitHub setup callback state without redirecting to GitHub. Used when the user opens an existing installation's settings on github.com (e.g. PostHog Code "Update in GitHub") so the subsequent Setup URL redirect can be validated.
integrations
Environments Integrations Github Repos Refresh Create
Environments Integrations Github Repos Refresh Create
integrations
Environments Integrations Github Repos Retrieve
Environments Integrations Github Repos Retrieve
integrations
Environments Integrations Github Teams Retrieve
Environments Integrations Github Teams Retrieve
integrations
Environments Integrations Google Accessible Accounts Retrieve
Environments Integrations Google Accessible Accounts Retrieve
integrations
Environments Integrations Google Conversion Actions Retrieve
Environments Integrations Google Conversion Actions Retrieve
integrations
Environments Integrations Google Search Console Sites Retrieve
List the Search Console properties the connected Google account has access to.
integrations
Environments Integrations Jira Projects Retrieve
Environments Integrations Jira Projects Retrieve
integrations
Environments Integrations Linear Teams Retrieve
Environments Integrations Linear Teams Retrieve
integrations
Environments Integrations Linkedin Ads Accounts Retrieve
Environments Integrations Linkedin Ads Accounts Retrieve
integrations
Environments Integrations Linkedin Ads Conversion Rules Retrieve
Environments Integrations Linkedin Ads Conversion Rules Retrieve
integrations
Environments Integrations List
Environments Integrations List
integrations
Environments Integrations Request Access Create
Notify project admins that a member is requesting an integration be connected.
integrations
Environments Integrations Retrieve
Environments Integrations Retrieve
integrations
Environments Integrations Twilio Phone Numbers Retrieve
Environments Integrations Twilio Phone Numbers Retrieve
integrations
Environments Is Generating Demo Data Retrieve
Deprecated: use /api/environments/{id}/ instead.
environments
Environments List
Deprecated: use /api/environments/{id}/ instead.
environments
Environments Llm Analytics Clustering Config List
Team-level clustering configuration (event filters for automated pipelines).
llm_analytics
Environments Llm Analytics Clustering Config Set Event Filters Create
Team-level clustering configuration (event filters for automated pipelines).
llm_analytics
Environments Llm Analytics Clustering Jobs Create
CRUD for clustering job configurations (max 10 per team).
llm_analytics
Environments Llm Analytics Clustering Jobs Destroy
CRUD for clustering job configurations (max 10 per team).
llm_analytics
Environments Llm Analytics Clustering Jobs List
CRUD for clustering job configurations (max 10 per team).
llm_analytics
Environments Llm Analytics Clustering Jobs Partial Update
CRUD for clustering job configurations (max 10 per team).
llm_analytics
Environments Llm Analytics Clustering Jobs Retrieve
CRUD for clustering job configurations (max 10 per team).
llm_analytics
Environments Llm Analytics Clustering Jobs Update
CRUD for clustering job configurations (max 10 per team).
llm_analytics
Environments Llm Analytics Evaluation Config Retrieve
Get the evaluation config for this team
llm_analytics
Environments Llm Analytics Evaluation Config Set Active Key Create
Set the active provider key for evaluations
llm_analytics
Environments Llm Analytics Evaluation Reports Create
CRUD for evaluation report configurations + report run history.
llm_analytics
Environments Llm Analytics Evaluation Reports Destroy
Evaluation report configs are deleted only when their evaluation is deleted. Use PATCH enabled=false to stop delivery.
llm_analytics
Environments Llm Analytics Evaluation Reports Generate Create
Trigger immediate report generation.
llm_analytics
Environments Llm Analytics Evaluation Reports List
CRUD for evaluation report configurations + report run history.
llm_analytics
Environments Llm Analytics Evaluation Reports Partial Update
CRUD for evaluation report configurations + report run history.
llm_analytics
Environments Llm Analytics Evaluation Reports Retrieve
CRUD for evaluation report configurations + report run history.
llm_analytics
Environments Llm Analytics Evaluation Reports Runs List
List report runs (history) for this report.
llm_analytics
Environments Llm Analytics Evaluation Reports Update
CRUD for evaluation report configurations + report run history.
llm_analytics
Environments Llm Analytics Evaluation Summary Create
Generate an AI-powered summary of evaluation results. This endpoint analyzes evaluation runs and identifies patterns in passing and failing evaluations, providing actionable recommendations. Data is fetched server-side by evaluation ID to ensure data integrity. **Use Cases:** - Understand why evaluations are passing or failing - Identify systematic issues in LLM responses - Get recommendations for improving response quality - Review patterns across many evaluation runs at once
AI observabilityllm_analytics
Environments Llm Analytics Models Retrieve
List available models for a provider.
llm_analytics
Environments Llm Analytics Offline Evaluations Experiment Items Create
Environments Llm Analytics Offline Evaluations Experiment Items Create
AI observabilityllm_analytics
Environments Llm Analytics Provider Key Validations Create
Validate LLM provider API keys without persisting them
llm_analytics
Environments Llm Analytics Provider Keys Assign Create
Assign this key to evaluations and optionally re-enable them.
llm_analytics
Environments Llm Analytics Provider Keys Create
Environments Llm Analytics Provider Keys Create
llm_analytics
Environments Llm Analytics Provider Keys Dependent Configs Retrieve
Get evaluations using this key and alternative keys for replacement.
llm_analytics
Environments Llm Analytics Provider Keys Destroy
Environments Llm Analytics Provider Keys Destroy
llm_analytics
Environments Llm Analytics Provider Keys List
Environments Llm Analytics Provider Keys List
llm_analytics
Environments Llm Analytics Provider Keys Partial Update
Environments Llm Analytics Provider Keys Partial Update
llm_analytics
Environments Llm Analytics Provider Keys Retrieve
Environments Llm Analytics Provider Keys Retrieve
llm_analytics
Environments Llm Analytics Provider Keys Trial Evaluations Retrieve
List enabled evaluations currently using trial credits for a given provider.
llm_analytics
Environments Llm Analytics Provider Keys Update
Environments Llm Analytics Provider Keys Update
llm_analytics
Environments Llm Analytics Provider Keys Validate Create
Environments Llm Analytics Provider Keys Validate Create
llm_analytics
Environments Llm Analytics Review Queue Items Create
Environments Llm Analytics Review Queue Items Create
llm_analytics
Environments Llm Analytics Review Queue Items Destroy
Environments Llm Analytics Review Queue Items Destroy
llm_analytics
Environments Llm Analytics Review Queue Items List
Environments Llm Analytics Review Queue Items List
llm_analytics
Environments Llm Analytics Review Queue Items Partial Update
Environments Llm Analytics Review Queue Items Partial Update
llm_analytics
Environments Llm Analytics Review Queue Items Retrieve
Environments Llm Analytics Review Queue Items Retrieve
llm_analytics
Environments Llm Analytics Review Queues Create
Environments Llm Analytics Review Queues Create
llm_analytics
Environments Llm Analytics Review Queues Destroy
Environments Llm Analytics Review Queues Destroy
llm_analytics
Environments Llm Analytics Review Queues List
Environments Llm Analytics Review Queues List
llm_analytics
Environments Llm Analytics Review Queues Partial Update
Environments Llm Analytics Review Queues Partial Update
llm_analytics
Environments Llm Analytics Review Queues Retrieve
Environments Llm Analytics Review Queues Retrieve
llm_analytics
Environments Llm Analytics Score Definitions Create
Environments Llm Analytics Score Definitions Create
llm_analytics
Environments Llm Analytics Score Definitions List
Environments Llm Analytics Score Definitions List
llm_analytics
Environments Llm Analytics Score Definitions New Version Create
Environments Llm Analytics Score Definitions New Version Create
llm_analytics
Environments Llm Analytics Score Definitions Partial Update
Environments Llm Analytics Score Definitions Partial Update
llm_analytics
Environments Llm Analytics Score Definitions Retrieve
Environments Llm Analytics Score Definitions Retrieve
llm_analytics
Environments Llm Analytics Summarization Batch Check Create
Check which traces have cached summaries available. This endpoint allows batch checking of multiple trace IDs to see which ones have cached summaries. Returns only the traces that have cached summaries with their titles. **Use Cases:** - Load cached summaries on session view load - Avoid unnecessary LLM calls for already-summarized traces - Display summary previews without generating new summaries
AI observabilityllm_analytics
Environments Llm Analytics Summarization Create
Generate an AI-powered summary of an LLM trace or event. This endpoint analyzes the provided trace/event, generates a line-numbered text representation, and uses an LLM to create a concise summary with line references. **Two ways to use this endpoint:** 1. **By ID (recommended):** Pass `trace_id` or `generation_id` with an optional `date_from`/`date_to`. The backend fetches the data automatically. `summarize_type` is inferred. 2. **By data:** Pass the full trace/event data blob in `data` with `summarize_type`. This is how the frontend uses it. **Summary Format:** - Title (concise, max 10 words) - Mermaid flow diagram showing the main flow - 3-10 summary bullets with line references - "Interesting Notes" section for failures, successes, or unusual patterns - Line references in [L45] or [L45-52] format pointing to relevant sections The response includes the structured summary, the text representation, and metadata.
AI observabilityllm_analytics
Environments Llm Analytics Text Repr Create
Generate a human-readable text representation of an LLM trace event. This endpoint converts AI observability events ($ai_generation, $ai_span, $ai_embedding, or $ai_trace) into formatted text representations suitable for display, logging, or analysis. **Supported Event Types:** - `$ai_generation`: Individual LLM API calls with input/output messages - `$ai_span`: Logical spans with state transitions - `$ai_embedding`: Embedding generation events (text input → vector) - `$ai_trace`: Full traces with hierarchical structure **Options:** - `max_length`: Maximum character count (default: 2000000) - `truncated`: Enable middle-content truncation within events (default: true) - `truncate_buffer`: Characters at start/end when truncating (default: 1000) - `include_markers`: Use interactive markers vs plain text indicators (default: true) - Frontend: set true for `<<<TRUNCATED|base64|...>>>` markers - Backend/LLM: set false for `... (X chars truncated) ...` text - `collapsed`: Show summary vs full trace tree (default: false) - `include_hierarchy`: Include tree structure for traces (default: true) - `max_depth`: Maximum depth for hierarchical rendering (default: unlimited) - `tools_collapse_threshold`: Number of tools before auto-collapsing list (default: 5) - Tool lists >5 items show `<<<TOOLS_EXPANDABLE|...>>>` marker for frontend - Or `[+] AVAILABLE TOOLS: N` for backend when `include_markers: false` - `include_line_numbers`: Prefix each line with line number like L001:, L010: (default: false) **Use Cases:** - Frontend display: `truncated: true, include_markers: true, include_line_numbers: true` - Backend LLM context (summary): `truncated: true, include_markers: false, collapsed: true` - Backend LLM context (full): `truncated: false` The response includes the formatted text and metadata about the rendering.
AI observabilityllm_analytics
Environments Llm Analytics Trace Reviews Create
Environments Llm Analytics Trace Reviews Create
llm_analytics
Environments Llm Analytics Trace Reviews Destroy
Environments Llm Analytics Trace Reviews Destroy
llm_analytics
Environments Llm Analytics Trace Reviews List
Environments Llm Analytics Trace Reviews List
llm_analytics
Environments Llm Analytics Trace Reviews Partial Update
Environments Llm Analytics Trace Reviews Partial Update
llm_analytics
Environments Llm Analytics Trace Reviews Retrieve
Environments Llm Analytics Trace Reviews Retrieve
llm_analytics
Environments Llm Analytics Translate Create
Translate text to target language.
llm_analytics
Environments Llm Prompts Create
Environments Llm Prompts Create
llm_prompts
Environments Llm Prompts List
Environments Llm Prompts List
llm_prompts
Environments Llm Prompts Name Archive Create
Environments Llm Prompts Name Archive Create
llm_prompts
Environments Llm Prompts Name Duplicate Create
Environments Llm Prompts Name Duplicate Create
llm_prompts
Environments Llm Prompts Name Partial Update
Environments Llm Prompts Name Partial Update
llm_prompts
Environments Llm Prompts Name Retrieve
Environments Llm Prompts Name Retrieve
llm_prompts
Environments Llm Prompts Resolve Name Retrieve
Environments Llm Prompts Resolve Name Retrieve
llm_prompts
Environments Llm Skills Create
Environments Llm Skills Create
llm_skills
Environments Llm Skills Import Create
Environments Llm Skills Import Create
llm_skills
Environments Llm Skills List
Environments Llm Skills List
llm_skills
Environments Llm Skills Marketplace Install Command Create
Mint the user's read-only marketplace credential (or rotate it) and return the install command. Per-user: rotating only ever invalidates this user's own credential, never a teammate's.
llm_skills
Environments Llm Skills Marketplace Install Command Retrieve
Report whether the user already has a marketplace credential, without minting one. The token is unrecoverable, so an existing credential returns its mask only — the UI shows "already connected, existing setups keep working" and offers an explicit rotate.
llm_skills
Environments Llm Skills Name Archive Create
Environments Llm Skills Name Archive Create
llm_skills
Environments Llm Skills Name Duplicate Create
Environments Llm Skills Name Duplicate Create
llm_skills
Environments Llm Skills Name Export Retrieve
Environments Llm Skills Name Export Retrieve
llm_skills
Environments Llm Skills Name Files Create
Environments Llm Skills Name Files Create
llm_skills
Environments Llm Skills Name Files Destroy
Environments Llm Skills Name Files Destroy
llm_skills
Environments Llm Skills Name Files Rename Create
Environments Llm Skills Name Files Rename Create
llm_skills
Environments Llm Skills Name Files Retrieve
Environments Llm Skills Name Files Retrieve
llm_skills
Environments Llm Skills Name Partial Update
Environments Llm Skills Name Partial Update
llm_skills
Environments Llm Skills Name Retrieve
Environments Llm Skills Name Retrieve
llm_skills
Environments Llm Skills Resolve Name Retrieve
Environments Llm Skills Resolve Name Retrieve
llm_skills
Environments Logs Alerts Create
Environments Logs Alerts Create
logs
Environments Logs Alerts Destinations Create
Create a notification destination for this alert. One HogFunction is created per alert event kind (firing, resolved, ...) atomically.
logs
Environments Logs Alerts Destinations Delete Create
Delete a notification destination by deleting its HogFunction group atomically.
logs
Environments Logs Alerts Destroy
Environments Logs Alerts Destroy
logs
Environments Logs Alerts Events List
Paginated event history for this alert, newest first. Returns state transitions, errored checks, and user-initiated control-plane rows (reset, enable/disable, snooze/unsnooze, threshold change) — quiet no-op check rows (where state didn't change and there was no error) are filtered out since only the last 10 are kept and they carry no forensic value. Optional `?kind=...` narrows to a single kind.
logs
Environments Logs Alerts List
Environments Logs Alerts List
logs
Environments Logs Alerts Partial Update
Environments Logs Alerts Partial Update
logs
Environments Logs Alerts Reset Create
Reset a broken alert. Clears the consecutive-failure counter and schedules an immediate recheck.
logs
Environments Logs Alerts Retrieve
Environments Logs Alerts Retrieve
logs
Environments Logs Alerts Simulate Create
Simulate a logs alert on historical data using the full state machine. Read-only — no alert check records are created.
logs
Environments Logs Alerts Update
Environments Logs Alerts Update
logs
Environments Logs Attributes Retrieve
Environments Logs Attributes Retrieve
logs
Environments Logs Config Partial Update
Manage logs product configuration for this environment.
environments
Environments Logs Config Retrieve
Manage logs product configuration for this environment.
environments
Environments Logs Count Create
Environments Logs Count Create
logs
Environments Logs Count Ranges Create
Environments Logs Count Ranges Create
logs
Environments Logs ExplainLogWithAI Create
Explain a log entry using AI. POST /api/environments/:id/logs/explainLogWithAI/
logs
Environments Logs Export Create
Environments Logs Export Create
logs
Environments Logs Facet Values Create
Environments Logs Facet Values Create
logs
Environments Logs Group By Create
Environments Logs Group By Create
logs
Environments Logs Has Logs Retrieve
Environments Logs Has Logs Retrieve
logs
Environments Logs Patterns Create
Environments Logs Patterns Create
logs
Environments Logs Query Create
Environments Logs Query Create
logs
Environments Logs Sampling Rules Create
Environments Logs Sampling Rules Create
logs
Environments Logs Sampling Rules Destroy
Environments Logs Sampling Rules Destroy
logs
Environments Logs Sampling Rules List
Environments Logs Sampling Rules List
logs
Environments Logs Sampling Rules Partial Update
Environments Logs Sampling Rules Partial Update
logs
Environments Logs Sampling Rules Reorder Create
Atomically reassign priorities so the given ID order maps to ascending priorities (0..n-1).
logs
Environments Logs Sampling Rules Retrieve
Environments Logs Sampling Rules Retrieve
logs
Environments Logs Sampling Rules Simulate Create
Dry-run estimate for how much volume this rule would remove (placeholder response until CH-backed simulation is wired).
logs
Environments Logs Sampling Rules Update
Environments Logs Sampling Rules Update
logs
Environments Logs Services Create
Environments Logs Services Create
logs
Environments Logs Sparkline Create
Environments Logs Sparkline Create
logs
Environments Logs Values Retrieve
Environments Logs Values Retrieve
logs
Environments Logs Views Create
Environments Logs Views Create
logs
Environments Logs Views Destroy
Environments Logs Views Destroy
logs
Environments Logs Views List
Environments Logs Views List
logs
Environments Logs Views Partial Update
Environments Logs Views Partial Update
logs
Environments Logs Views Retrieve
Environments Logs Views Retrieve
logs
Environments Logs Views Update
Environments Logs Views Update
logs
Environments Managed Viewsets Retrieve
Get all views associated with a specific managed viewset. GET /api/environments/{team_id}/managed_viewsets/{kind}/
managed_viewsets
Environments Managed Viewsets Update
Enable or disable a managed viewset by kind. PUT /api/environments/{team_id}/managed_viewsets/{kind}/ with body {"enabled": true/false}
managed_viewsets
List conversion goals
Read the configured conversion goals for the current project — each with its kind, target, last-30d count, integrated vs non-integrated split, and a misconfiguration flag. Read-only.
marketing_analytics
List marketing data sources
Check the platform → data-warehouse side of every native marketing integration: connection state, sync recency, row counts, required-table status, and schema-mapping coverage. Read-only.
marketing_analytics
Diagnose marketing analytics
Aggregate data-source sync health, UTM attribution health, and conversion-goal config into a single per-integration diagnostic with recommended actions. Read-only.
marketing_analytics
Explain a conversion goal
Break down a single conversion goal's events over a period by event name, utm_source, and matched integration, with a small sample of events. Read-only.
marketing_analytics
Suggest conversion goals
Rank existing custom events as conversion-goal candidates by volume, UTM-tag coverage, and unique users, excluding system/autocaptured events. Read-only.
marketing_analytics
Suggest UTM source mappings
Detect unmatched utm_source values from recent events and propose custom_source_mappings entries, alongside the full utm_source catalogue and current mappings. Read-only.
marketing_analytics
Environments Marketing Analytics Test Mapping Create
Environments Marketing Analytics Test Mapping Create
marketing_analytics
Run UTM audit
Cross-reference campaigns with spend from ad platforms against pageview events with UTM parameters to identify tracking issues.
marketing_analytics
Environments Max Tools Create And Query Insight Create
Environments Max Tools Create And Query Insight Create
max_tools
Environments Mcp Analytics Feedback Create
Create a new MCP feedback submission for the current project.
mcp_analytics
Environments Mcp Analytics Feedback List
List MCP feedback submissions for the current project, newest first.
mcp_analytics
Environments Mcp Analytics Intent Clusters Recompute
Trigger an asynchronous recompute of the intent cluster snapshot. The task runs in the background; poll the GET endpoint for progress (status transitions to 'idle' or 'error').
mcp_analytics
Environments Mcp Analytics Intent Clusters Retrieve
Return the most recent intent cluster snapshot for the current project. Returns an empty IDLE snapshot when no clustering run has happened yet.
mcp_analytics
Environments Mcp Analytics Missing Capabilities Create
Create a new missing capability report for the current project.
mcp_analytics
Environments Mcp Analytics Missing Capabilities List
List missing capability reports for the current project, newest first.
mcp_analytics
Environments Mcp Analytics Sessions Activity Overview
Aggregate counters, top tools, agent clients, and the most recent tool calls for the last 30 days, computed in one request. Powers the dashboard's activity view; always computed fresh so polling callers watch data arrive.
mcp_analytics
Environments Mcp Analytics Sessions Generate Intent
Generate (or return the cached) LLM summary of the agent's goal for a session, derived from its recorded $mcp_intents. The first call summarises and persists the result; subsequent calls return the stored summary.
mcp_analytics
Environments Mcp Analytics Sessions Intent Digest
Generate (or return the cached) LLM digest of what agents are trying to do with this MCP server, derived from the most recent recorded $mcp_intents across all sessions. Content-addressed cache: only regenerates when new intents arrive. Powers the dashboard's low-volume activity stage.
mcp_analytics
Environments Mcp Analytics Sessions List
List MCP sessions for the current project, derived by grouping $mcp_tool_call events by $mcp_session_id. Ordered by newest session start first by default.
mcp_analytics
Environments Mcp Analytics Sessions Tool Calls
List a page of the $mcp_tool_call events that belong to a given $session_id, in chronological order.
mcp_analytics
Environments Mcp Server Installations Authorize Retrieve
Start (or re-start) an OAuth flow. Pass ``template_id`` to (re)connect a catalog template, or ``installation_id`` to reconnect an existing custom install using its cached metadata and per-user DCR creds.
mcp_server_installations
Environments Mcp Server Installations Create
Environments Mcp Server Installations Create
mcp_server_installations
Environments Mcp Server Installations Destroy
Environments Mcp Server Installations Destroy
mcp_server_installations
Environments Mcp Server Installations Install Custom Create
Environments Mcp Server Installations Install Custom Create
mcp_server_installations
Environments Mcp Server Installations Install Template Create
Environments Mcp Server Installations Install Template Create
mcp_server_installations
Environments Mcp Server Installations List
Environments Mcp Server Installations List
mcp_server_installations
Environments Mcp Server Installations Partial Update
Environments Mcp Server Installations Partial Update
mcp_server_installations
Environments Mcp Server Installations Proxy Create
Environments Mcp Server Installations Proxy Create
mcp_server_installations
Environments Mcp Server Installations Retrieve
Environments Mcp Server Installations Retrieve
mcp_server_installations
Environments Mcp Server Installations Tools Partial Update
Environments Mcp Server Installations Tools Partial Update
mcp_server_installations
Environments Mcp Server Installations Tools Refresh Create
Environments Mcp Server Installations Tools Refresh Create
mcp_server_installations
Environments Mcp Server Installations Tools Retrieve
Environments Mcp Server Installations Tools Retrieve
mcp_server_installations
Environments Mcp Server Installations Update
Environments Mcp Server Installations Update
mcp_server_installations
Environments Mcp Servers List
Lists curated MCP server templates that users can install with one click. Templates are seeded by PostHog operators and carry shared, encrypted OAuth client credentials. Inactive templates are hidden from the catalog.
mcp_servers
Environments Mcp Tools Create
Invoke an MCP tool by name. This endpoint allows MCP callers to invoke Max AI tools directly without going through the full LangChain conversation flow. Scopes are resolved dynamically per tool via dangerously_get_required_scopes.
mcp_tools
Environments Messaging Templates Create
Environments Messaging Templates Create
messaging_templates
Environments Messaging Templates Design Partial Update
Environments Messaging Templates Design Partial Update
messaging_templates
Environments Messaging Templates Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
messaging_templates
Environments Messaging Templates List
Environments Messaging Templates List
messaging_templates
Environments Messaging Templates Partial Update
Environments Messaging Templates Partial Update
messaging_templates
Environments Messaging Templates Retrieve
Environments Messaging Templates Retrieve
messaging_templates
Environments Messaging Templates Update
Environments Messaging Templates Update
messaging_templates
Environments Metrics Characterize Create
Characterize a metric anomaly: compare an anomaly window against a baseline, find the onset, and rank which label values moved.
metricsmetrics
Environments Metrics Has Metrics Retrieve
Environments Metrics Has Metrics Retrieve
metricsmetrics
Environments Metrics Query Create
Environments Metrics Query Create
metricsmetrics
Environments Metrics Samples Create
Raw individual emissions for a metric (the events model), newest first — backs the Samples view and the metric->trace pivot.
metricsmetrics
Environments Metrics Values Retrieve
Distinct metric names for the team. Backs the picker UI.
metricsmetrics
Environments Partial Update
Deprecated: use /api/environments/{id}/ instead.
environments
Environments Persons Activity Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons All Activity Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Batch By Distinct Ids Create
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Batch By Uuids Create
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Bulk Delete Create
This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted.
persons
Environments Persons Cohorts Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Delete Property Create
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Deletion Status List
List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed.
persons
Environments Persons Emails List
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Funnel Create
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Funnel Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Lifecycle Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons List
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Partial Update
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Properties At Time Retrieve
Get person properties as they existed at a specific point in time. This endpoint reconstructs person properties by querying ClickHouse events for $set and $set_once operations up to the specified timestamp. Query parameters: - distinct_id: The distinct_id of the person - timestamp: ISO datetime string for the point in time (e.g., "2023-06-15T14:30:00Z") - include_set_once: Whether to handle $set_once operations (default: false)
personspersons
Environments Persons Properties Timeline Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Reset Person Distinct Id Create
Reset a distinct_id for a deleted person. This allows the distinct_id to be used again.
persons
Environments Persons Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Split Create
Split distinct_ids off a merged person. Two mutually exclusive modes: - **`distinct_ids_to_split`** (recommended for surgical edits): moves only the listed distinct_ids off this person onto new single-id persons. The original person keeps every other distinct_id and its properties. - **`main_distinct_id`**: keeps only the specified distinct_id on this person; moves every *other* distinct_id off onto its own new person. If omitted, the first distinct_id is kept. The original person always retains its properties. To clear individual properties afterward, use the `delete_property` endpoint. The split runs asynchronously: a 201 response means the task was enqueued. Newly-created split-off persons get a deterministic UUID derived from `(team_id, distinct_id)`, so they can be located client-side without polling. If you need to delete a split-off person after this call, prefer looking it up by that deterministic UUID rather than by distinct_id, since the latter still resolves to the original merged person until the async task completes.
persons
Environments Persons Trends Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Update
Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. This means that only the properties listed will be updated, but other properties won't be removed nor updated. If you would like to remove a property use the `delete_property` endpoint.
persons
Environments Persons Update Property Create
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Persons Values Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Environments Plugin Configs Logs List
Environments Plugin Configs Logs List
plugin_configs
Environments Project Secret Api Keys Create
Environments Project Secret Api Keys Create
project_secret_api_keys
Environments Project Secret Api Keys Destroy
Environments Project Secret Api Keys Destroy
project_secret_api_keys
Environments Project Secret Api Keys List
Environments Project Secret Api Keys List
project_secret_api_keys
Environments Project Secret Api Keys Partial Update
Environments Project Secret Api Keys Partial Update
project_secret_api_keys
Environments Project Secret Api Keys Retrieve
Environments Project Secret Api Keys Retrieve
project_secret_api_keys
Environments Project Secret Api Keys Roll Create
Roll a project secret API key
project_secret_api_keys
Environments Project Secret Api Keys Update
Environments Project Secret Api Keys Update
project_secret_api_keys
Environments Property Access Controls Create
Create or update a property access control rule.
property_access_controls
Environments Property Access Controls Destroy
Delete a property access control rule. The rule is identified by `property_definition_id` plus an optional `organization_member` or `role` query parameter. Omitting both targets deletes the default rule.
property_access_controls
Environments Property Access Controls Retrieve
Get all property access control rules for a property definition.
property_access_controls
Environments Query Check Auth For Async Create
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
query
Environments Query Create
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
query
Environments Query Create With Kind
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
query
Environments Query Destroy
(Experimental)
query
Environments Query Draft Sql Retrieve
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
query
Environments Query Log Retrieve
Get query log details from query_log_archive table for a specific query_id, the query must have been issued in last 24 hours.
query
Environments Query Retrieve
(Experimental)
query
Environments Query Upgrade Create
Upgrades a query without executing it. Returns a query with all nodes migrated to the latest version.
query
Environments Reset Token Partial Update
Deprecated: use /api/environments/{id}/ instead.
environments
Environments Retrieve
Deprecated: use /api/environments/{id}/ instead.
environments
Environments Retrieve Session Summaries Config
Retrieve the team's session summaries configuration (product context used to tailor single-session replay summaries).
session_summaries
Environments Rotate Secret Token Partial Update
Deprecated: use /api/environments/{id}/ instead.
environments
Environments Saved Create
Create a saved heatmap for a page URL. For type 'screenshot' (the default) this enqueues a headless render of the page at each target width; poll the saved heatmap or its content endpoint until status is 'completed'. Provide 'widths' to control which viewport widths are rendered.
saved
Environments Saved Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
saved
Environments Saved List
List saved heatmaps for the project. A saved heatmap pins a page URL and a set of viewport widths, and (for type 'screenshot') renders the page so heatmap data can be overlaid on it.
saved
Environments Saved Partial Update
Update a saved heatmap (e.g. rename, change widths, or soft-delete via 'deleted'). Changing the URL of a 'screenshot' heatmap triggers a re-render.
saved
Environments Saved Regenerate Create
Re-run screenshot generation for a saved heatmap of type 'screenshot'. Clears existing renders and re-renders at every target width; status returns to 'processing'.
saved
Environments Saved Retrieve
Get a single saved heatmap by its short_id, including per-width render status.
saved
Environments Session Recording Playlists Create
Environments Session Recording Playlists Create
replaysession_recording_playlists
Environments Session Recording Playlists Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
replaysession_recording_playlists
Environments Session Recording Playlists List
Override list to include synthetic playlists. Synthetics have no DB row, so we compute each one's position in the merged sort and split the requested page between synthetics and a DB queryset slice. The merge/rank/sort is all in-memory, so each phase is wrapped in a span and the input sizes are recorded as span attributes — a slow response on a team with many playlists then shows up as a wide span against a large db_count.
replaysession_recording_playlists
Environments Session Recording Playlists Partial Update
Environments Session Recording Playlists Partial Update
replaysession_recording_playlists
Environments Session Recording Playlists Recordings Create
Environments Session Recording Playlists Recordings Create
replaysession_recording_playlists
Environments Session Recording Playlists Recordings Destroy
Environments Session Recording Playlists Recordings Destroy
replaysession_recording_playlists
Environments Session Recording Playlists Recordings Retrieve
Environments Session Recording Playlists Recordings Retrieve
replaysession_recording_playlists
Environments Session Recording Playlists Retrieve
Environments Session Recording Playlists Retrieve
replaysession_recording_playlists
Environments Session Recording Playlists Update
Environments Session Recording Playlists Update
replaysession_recording_playlists
Environments Session Recordings Bulk Delete Create
Delete a batch of session recordings by session ID. Deletion is permanent and cannot be undone. IDs that don't match an existing recording are skipped and counted in `total_requested` but not `deleted_count`.
replaysession_recordings
Environments Session Recordings Destroy
Environments Session Recordings Destroy
replaysession_recordings
Environments Session Recordings List
Environments Session Recordings List
replaysession_recordings
Environments Session Recordings Partial Update
Environments Session Recordings Partial Update
replaysession_recordings
Environments Session Recordings Retrieve
Environments Session Recordings Retrieve
replaysession_recordings
Environments Session Recordings Sharing List
Environments Session Recordings Sharing List
session_recordings
Environments Session Recordings Sharing Passwords Create
Create a new password for the sharing configuration.
session_recordings
Environments Session Recordings Sharing Passwords Destroy
Delete a password from the sharing configuration.
session_recordings
Environments Session Recordings Sharing Refresh Create
Environments Session Recordings Sharing Refresh Create
session_recordings
Environments Session Recordings Update
Environments Session Recordings Update
replaysession_recordings
Environments Sessions Property Definitions Retrieve
Environments Sessions Property Definitions Retrieve
sessions
Environments Sessions Values Retrieve
Environments Sessions Values Retrieve
sessions
Environments Settings As Of Retrieve
Return the team settings as of the provided timestamp. Query params: - at: ISO8601 datetime (required) - scope: optional, one or multiple keys to filter the returned settings
environments
Environments Subscriptions Create
Environments Subscriptions Create
subscriptionssubscriptions
List subscription deliveries
Paginated delivery history for a subscription. Requires premium subscriptions.
subscriptionssubscriptions
Retrieve subscription delivery
Fetch one delivery row by id.
subscriptionssubscriptions
Environments Subscriptions Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
subscriptionssubscriptions
Environments Subscriptions List
Environments Subscriptions List
subscriptionssubscriptions
Environments Subscriptions Partial Update
Environments Subscriptions Partial Update
subscriptionssubscriptions
Environments Subscriptions Retrieve
Environments Subscriptions Retrieve
subscriptionssubscriptions
Environments Subscriptions Summary Quota Retrieve
Environments Subscriptions Summary Quota Retrieve
subscriptionssubscriptions
Environments Subscriptions Test Delivery Create
Environments Subscriptions Test Delivery Create
subscriptionssubscriptions
Environments Subscriptions Update
Environments Subscriptions Update
subscriptionssubscriptions
Environments Taggers Create
Environments Taggers Create
taggers
Environments Taggers Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
taggers
Environments Taggers List
Environments Taggers List
taggers
Environments Taggers Partial Update
Environments Taggers Partial Update
taggers
Environments Taggers Retrieve
Environments Taggers Retrieve
taggers
Environments Taggers Test Hog Create
Test Hog tagger code against sample events without saving.
taggers
Environments Taggers Update
Environments Taggers Update
taggers
Environments Tracing Spans Aggregate Create
Environments Tracing Spans Aggregate Create
tracing
Environments Tracing Spans Attribute Breakdown Create
Environments Tracing Spans Attribute Breakdown Create
tracing
Environments Tracing Spans Attributes Retrieve
Environments Tracing Spans Attributes Retrieve
tracing
Environments Tracing Spans Count Create
Environments Tracing Spans Count Create
tracing
Environments Tracing Spans Duration Histogram Create
Environments Tracing Spans Duration Histogram Create
tracing
Environments Tracing Spans Has Spans Retrieve
Environments Tracing Spans Has Spans Retrieve
tracing
Environments Tracing Spans Query Create
Environments Tracing Spans Query Create
tracing
Environments Tracing Spans Service Names Retrieve
Environments Tracing Spans Service Names Retrieve
tracing
Environments Tracing Spans Sparkline Create
Environments Tracing Spans Sparkline Create
tracing
Environments Tracing Spans Symbol Stats Create
Environments Tracing Spans Symbol Stats Create
tracing
Environments Tracing Spans Trace Create
Environments Tracing Spans Trace Create
tracing
Environments Tracing Spans Tree Create
Environments Tracing Spans Tree Create
tracing
Environments Tracing Spans Values Retrieve
Environments Tracing Spans Values Retrieve
tracing
Environments Tracing Views Create
Environments Tracing Views Create
tracing
Environments Tracing Views Destroy
Environments Tracing Views Destroy
tracing
Environments Tracing Views List
Environments Tracing Views List
tracing
Environments Tracing Views Partial Update
Environments Tracing Views Partial Update
tracing
Environments Tracing Views Retrieve
Environments Tracing Views Retrieve
tracing
Environments Tracing Views Update
Environments Tracing Views Update
tracing
Environments Update
Deprecated: use /api/environments/{id}/ instead.
environments
Environments Update Session Summaries Config
Update the team's session summaries configuration (product context used to tailor single-session replay summaries).
session_summaries
Environments User Interview Topics Add Interviewee Create
Add a single interviewee to this topic. Email-shaped identifiers (including the `Display Name <email@host>` form) are appended to `interviewee_emails`; everything else is appended to `interviewee_distinct_ids`. Idempotent — adding an identifier that's already present leaves the topic unchanged. Returns the updated topic.
user_interview_topics
Environments User Interview Topics Create
Planned user interview topics: who we want to target and what we want to ask about.
user_interview_topics
Environments User Interview Topics Destroy
Planned user interview topics: who we want to target and what we want to ask about.
user_interview_topics
Environments User Interview Topics Generate Links Create
Generate one public interview link per targeted interviewee. Materializes an IntervieweeContext row for every identifier on the topic (without overwriting existing per-person context), and an enabled SharingConfiguration with a unique access token. The URL resolves to the public interview viewer with no PostHog auth required.
user_interview_topics
Environments User Interview Topics Interviewees Bulk Create
Create up to 500 interviewee context rows for a topic in a single request. Rows whose (topic, interviewee_identifier) already exists are skipped — the response surfaces an `inserted_count`, a `skipped_count`, and the `skipped_identifiers` so the caller can reconcile. Items must have unique `interviewee_identifier` values within the batch.
user_interview_topics
Environments User Interview Topics Interviewees Create
Per-interviewee extra context for a user interview topic. At most one row per (topic, interviewee_identifier).
user_interview_topics
Environments User Interview Topics Interviewees Destroy
Per-interviewee extra context for a user interview topic. At most one row per (topic, interviewee_identifier).
user_interview_topics
Environments User Interview Topics Interviewees List
Per-interviewee extra context for a user interview topic. At most one row per (topic, interviewee_identifier).
user_interview_topics
Environments User Interview Topics Interviewees Partial Update
Per-interviewee extra context for a user interview topic. At most one row per (topic, interviewee_identifier).
user_interview_topics
Environments User Interview Topics Interviewees Retrieve
Per-interviewee extra context for a user interview topic. At most one row per (topic, interviewee_identifier).
user_interview_topics
Environments User Interview Topics Interviewees Update
Per-interviewee extra context for a user interview topic. At most one row per (topic, interviewee_identifier).
user_interview_topics
Environments User Interview Topics Links Csv Create
Same materialization as generate_links, returned as a downloadable CSV. Intended for users who want to mail-merge the per-person interview links into their own email tooling.
user_interview_topics
Environments User Interview Topics List
Planned user interview topics: who we want to target and what we want to ask about.
user_interview_topics
Environments User Interview Topics Partial Update
Planned user interview topics: who we want to target and what we want to ask about.
user_interview_topics
Environments User Interview Topics Preview Invite Create
Render the invite email exactly as a specific targeted interviewee would receive it — personalized subject and body — without sending anything and without creating or reading any share links. Pass `interviewee_identifier` to preview for a particular person, or omit it to preview for the first targeted interviewee. The body always shows an illustrative placeholder link (`is_preview_link: true`), never a live interview URL.
user_interview_topics
Environments User Interview Topics Remove Interviewee Create
Remove an interviewee from this topic. Drops the identifier from both `interviewee_emails` and `interviewee_distinct_ids`, and disables any active SharingConfiguration linked to an IntervieweeContext for that identifier on this topic so the removed person can no longer open their interview link. Idempotent — removing an identifier that isn't present is a no-op. Returns the updated topic.
user_interview_topics
Environments User Interview Topics Retrieve
Planned user interview topics: who we want to target and what we want to ask about.
user_interview_topics
Environments User Interview Topics Send Invites Create
Generate (if needed) and email a personalized public interview link to every targeted interviewee on this topic whose identifier is an email address. Distinct-ID-only interviewees are skipped and surfaced in the response. Each invite is keyed on the underlying SharingConfiguration so re-runs after token rotation produce a fresh send.
user_interview_topics
Environments User Interview Topics Test Link Retrieve
Return the calling user's personal dogfood interview link for this topic, plus the latest test interview they have recorded against it. Lazily get-or-creates a per-caller IntervieweeContext + enabled SharingConfiguration the first time it's called, then returns the same stable URL on subsequent calls. The caller's identifier is intentionally not added to the topic's targeting arrays — each user dogfoods under their own row, so test calls never mint a public share token on someone else's behalf.
user_interview_topics
Environments User Interview Topics Update
Planned user interview topics: who we want to target and what we want to ask about.
user_interview_topics
Environments User Interviews Create
Environments User Interviews Create
user_interviews
Environments User Interviews Destroy
Environments User Interviews Destroy
user_interviews
Environments User Interviews List
Environments User Interviews List
user_interviews
Environments User Interviews Partial Update
Environments User Interviews Partial Update
user_interviews
Environments User Interviews Retrieve
Environments User Interviews Retrieve
user_interviews
Search interview responses by semantic similarity
Embed `query` with the same model used to index interview transcripts and summaries, then return the top matches by cosine distance. Each match is a single (interview, document_type) pair — an interview can appear up to twice if both its transcript and summary score above other interviews. Useful for surfacing relevant interview snippets in natural language, without exact keyword matches.
user_interviews
Environments User Interviews Update
Environments User Interviews Update
user_interviews
Environments Vision Observations Label Create
Set or update the observation's shared label: whether the scanner scored the session correctly, plus optional feedback on what it got wrong. One label per observation, shared across the team; these labels feed prompt improvement. Requires session recording edit access.
vision
Environments Vision Observations Label Destroy
Remove the observation's shared label. Requires session recording edit access.
vision
Environments Vision Observations List
Read-only access to a session's observations across every scanner the caller can read, for the replay-page dock.
vision
Environments Vision Observations Retrieve
Read-only access to a session's observations across every scanner the caller can read, for the replay-page dock.
vision
Environments Vision Observations Retry Create
Delete a failed observation and re-run its scanner on the same recording. Returns 202 with the workflow handle.
vision
Environments Vision Scanners Create
CRUD for Replay Vision scanners.
vision
Environments Vision Scanners Creators Retrieve
Distinct creators across the team's scanners — feeds the `Created by` filter dropdown.
vision
Environments Vision Scanners Destroy
CRUD for Replay Vision scanners.
vision
Environments Vision Scanners Estimate Create
Estimate the observation volume a proposed scanner would generate, for the pre-save cost preview.
vision
Environments Vision Scanners List
CRUD for Replay Vision scanners.
vision
Environments Vision Scanners Observations Label Create
Set or update the observation's shared label: whether the scanner scored the session correctly, plus optional feedback on what it got wrong. One label per observation, shared across the team; these labels feed prompt improvement. Requires session recording edit access.
vision
Environments Vision Scanners Observations Label Destroy
Remove the observation's shared label. Requires session recording edit access.
vision
Environments Vision Scanners Observations List
Read-only access to observations produced by a scanner.
vision
Environments Vision Scanners Observations Retrieve
Read-only access to observations produced by a scanner.
vision
Environments Vision Scanners Observations Retry Create
Delete a failed observation and re-run its scanner on the same recording. Returns 202 with the workflow handle.
vision
Environments Vision Scanners Observations Stats Retrieve
Aggregate counts and per-scanner-type distributions over the filtered observation set. Same filters as the list endpoint apply.
vision
Environments Vision Scanners Observe Create
Apply this scanner to one specific session, on demand. Returns 202 with the workflow handle.
vision
Environments Vision Scanners Partial Update
CRUD for Replay Vision scanners.
vision
Environments Vision Scanners Prompt Suggestions Apply Create
Apply this suggestion: write its prompt to the scanner (bumping the scanner version) and mark the suggestion applied. Only the current pending suggestion can be applied. Requires session recording edit access.
vision
Environments Vision Scanners Prompt Suggestions Current Retrieve
The scanner's newest prompt suggestion plus whether it is stale (the ratings changed since it was generated) and how many rated observations are available.
vision
Environments Vision Scanners Prompt Suggestions Dismiss Create
Dismiss this suggestion without applying it. Only the current pending suggestion can be dismissed. Requires session recording edit access.
vision
Environments Vision Scanners Prompt Suggestions Generate Create
Generate a fresh prompt suggestion from the team's current ratings. The previous pending suggestion becomes history (superseded). Requires at least one rated observation and session recording edit access.
vision
Environments Vision Scanners Prompt Suggestions List
AI prompt-rewrite suggestions for a scanner, generated from the team's thumbs up/down ratings.
vision
Environments Vision Scanners Retrieve
CRUD for Replay Vision scanners.
vision
Environments Vision Scanners Stats Retrieve
Team-wide scanner counts — independent of list filters, so the overview stays stable.
vision
Environments Vision Scanners Suggest Tags Create
Suggest classifier tags grounded in the scanner's own observations and the org's product data.
vision
Environments Warehouse Saved Queries Activity Retrieve
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Environments Warehouse Saved Queries Ancestors Create
Return the ancestors of this saved query. By default, we return the immediate parents. The `level` parameter can be used to look further back into the ancestor tree. If `level` overshoots (i.e. points to only ancestors beyond the root), we return an empty list.
warehouse_saved_queries
Environments Warehouse Saved Queries Cancel Create
Cancel a running saved query workflow.
warehouse_saved_queries
Environments Warehouse Saved Queries Create
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Environments Warehouse Saved Queries Dependencies Retrieve
Return the count of immediate upstream and downstream dependencies for this saved query.
warehouse_saved_queries
Environments Warehouse Saved Queries Descendants Create
Return the descendants of this saved query. By default, we return the immediate children. The `level` parameter can be used to look further ahead into the descendants tree. If `level` overshoots (i.e. points to only descendants further than a leaf), we return an empty list.
warehouse_saved_queries
Environments Warehouse Saved Queries Destroy
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Environments Warehouse Saved Queries List
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Environments Warehouse Saved Queries Materialize Create
Enable materialization for this saved query with a 24-hour sync frequency.
warehouse_saved_queries
Environments Warehouse Saved Queries Partial Update
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Environments Warehouse Saved Queries Resume Schedules Create
Resume paused materialization schedules for multiple matviews. Accepts a list of view IDs in the request body: {"view_ids": ["id1", "id2", ...]} This endpoint is idempotent - calling it on already running or non-existent schedules is safe.
warehouse_saved_queries
Environments Warehouse Saved Queries Retrieve
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Environments Warehouse Saved Queries Revert Materialization Create
Undo materialization, revert back to the original view. (i.e. delete the materialized table and the schedule)
warehouse_saved_queries
Environments Warehouse Saved Queries Run Create
Run this saved query.
warehouse_saved_queries
Environments Warehouse Saved Queries Run History Retrieve
Return the recent run history (up to 5 most recent) for this materialized view.
warehouse_saved_queries
Environments Warehouse Saved Queries Update
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Environments Warehouse Saved Query Folders Create
Environments Warehouse Saved Query Folders Create
warehouse_saved_query_folders
Environments Warehouse Saved Query Folders Destroy
Environments Warehouse Saved Query Folders Destroy
warehouse_saved_query_folders
Environments Warehouse Saved Query Folders List
Environments Warehouse Saved Query Folders List
warehouse_saved_query_folders
Environments Warehouse Saved Query Folders Partial Update
Environments Warehouse Saved Query Folders Partial Update
warehouse_saved_query_folders
Environments Warehouse Saved Query Folders Retrieve
Environments Warehouse Saved Query Folders Retrieve
warehouse_saved_query_folders
Environments Warehouse Tables Create
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Environments Warehouse Tables Destroy
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Environments Warehouse Tables File Create
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Environments Warehouse Tables List
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Environments Warehouse Tables Partial Update
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Refresh table schema from source
Re-introspect a self-managed (manually linked) warehouse table's schema from its underlying source files and overwrite its stored column list. Use when the source schema has evolved (e.g. new columns in the underlying Delta/Parquet/CSV files) but queries still can't see the new columns, because PostHog serves a cached column snapshot until the table is refreshed. Not for tables managed by an external data source sync — those refresh on their own schedule.
warehouse_tables
Environments Warehouse Tables Retrieve
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Environments Warehouse Tables Update
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Environments Warehouse Tables Update Schema Create
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Environments Warehouse View Link Create
Create, Read, Update and Delete View Columns.
warehouse_view_link
Environments Warehouse View Link Destroy
Create, Read, Update and Delete View Columns.
warehouse_view_link
Environments Warehouse View Link List
Create, Read, Update and Delete View Columns.
warehouse_view_link
Environments Warehouse View Link Partial Update
Create, Read, Update and Delete View Columns.
warehouse_view_link
Environments Warehouse View Link Retrieve
Create, Read, Update and Delete View Columns.
warehouse_view_link
Environments Warehouse View Link Update
Create, Read, Update and Delete View Columns.
warehouse_view_link
Environments Warehouse View Link Validate Create
Create, Read, Update and Delete View Columns.
warehouse_view_link
Environments Warehouse View Links Create
Create, Read, Update and Delete View Columns.
warehouse_view_links
Environments Warehouse View Links Destroy
Create, Read, Update and Delete View Columns.
warehouse_view_links
Environments Warehouse View Links List
Create, Read, Update and Delete View Columns.
warehouse_view_links
Environments Warehouse View Links Partial Update
Create, Read, Update and Delete View Columns.
warehouse_view_links
Environments Warehouse View Links Retrieve
Create, Read, Update and Delete View Columns.
warehouse_view_links
Environments Warehouse View Links Update
Create, Read, Update and Delete View Columns.
warehouse_view_links
Environments Warehouse View Links Validate Create
Create, Read, Update and Delete View Columns.
warehouse_view_links
Weekly web analytics recap
The 'Wrapped'-style weekly recap: everything in the weekly digest (visitors, pageviews, sessions, bounce rate, average session duration with period-over-period comparisons, top pages, top sources, and goals) plus a single derived weekly persona and a short list of screenshot-worthy highlights for the period.
web_analyticsweb_analytics
Summarize web analytics
Summarizes a project's web analytics over a lookback window (default 7 days): unique visitors, pageviews, sessions, bounce rate, and average session duration with period-over-period comparisons, plus the top 5 pages, top 5 traffic sources, and goal conversions.
web_analyticsweb_analytics
Environments Web Vitals Retrieve
Get web vitals for a specific pathname. Toolbar accesses this via OAuth (handled by TeamAndOrgViewSetMixin.get_authenticators).
web_vitals
Error Tracking Assignment Rules Create
Error Tracking Assignment Rules Create
error_tracking
Error Tracking Assignment Rules Destroy
Error Tracking Assignment Rules Destroy
error_tracking
Error Tracking Assignment Rules List
Error Tracking Assignment Rules List
error_tracking
Error Tracking Assignment Rules Partial Update
Error Tracking Assignment Rules Partial Update
error_tracking
Error Tracking Assignment Rules Reorder Partial Update
Error Tracking Assignment Rules Reorder Partial Update
error_tracking
Error Tracking Assignment Rules Retrieve
Error Tracking Assignment Rules Retrieve
error_tracking
Error Tracking Assignment Rules Update
Error Tracking Assignment Rules Update
error_tracking
Error Tracking Bypass Rules Create
Error Tracking Bypass Rules Create
error_tracking
Error Tracking Bypass Rules Destroy
Error Tracking Bypass Rules Destroy
error_tracking
Error Tracking Bypass Rules List
Error Tracking Bypass Rules List
error_tracking
Error Tracking Bypass Rules Partial Update
Error Tracking Bypass Rules Partial Update
error_tracking
Error Tracking Bypass Rules Reorder Partial Update
Error Tracking Bypass Rules Reorder Partial Update
error_tracking
Error Tracking Bypass Rules Retrieve
Error Tracking Bypass Rules Retrieve
error_tracking
Error Tracking Bypass Rules Update
Error Tracking Bypass Rules Update
error_tracking
Error Tracking External References Create
Error Tracking External References Create
error_tracking
Error Tracking External References Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
error_tracking
Error Tracking External References List
Error Tracking External References List
error_tracking
Error Tracking External References Retrieve
Error Tracking External References Retrieve
error_tracking
Error Tracking Fingerprints Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
error_tracking
Error Tracking Fingerprints List
Error Tracking Fingerprints List
error_tracking
Error Tracking Fingerprints Retrieve
Error Tracking Fingerprints Retrieve
error_tracking
Error Tracking Git Provider File Links Resolve Github Retrieve
Error Tracking Git Provider File Links Resolve Github Retrieve
error_tracking
Error Tracking Git Provider File Links Resolve Gitlab Retrieve
Error Tracking Git Provider File Links Resolve Gitlab Retrieve
error_tracking
Error Tracking Grouping Rules Create
Error Tracking Grouping Rules Create
error_tracking
Error Tracking Grouping Rules Destroy
Error Tracking Grouping Rules Destroy
error_tracking
Error Tracking Grouping Rules List
Error Tracking Grouping Rules List
error_tracking
Error Tracking Grouping Rules Partial Update
Error Tracking Grouping Rules Partial Update
error_tracking
Error Tracking Grouping Rules Reorder Partial Update
Error Tracking Grouping Rules Reorder Partial Update
error_tracking
Error Tracking Grouping Rules Retrieve
Error Tracking Grouping Rules Retrieve
error_tracking
Error Tracking Grouping Rules Update
Error Tracking Grouping Rules Update
error_tracking
Error Tracking Issues Activity Retrieve
Error Tracking Issues Activity Retrieve
error_tracking
Error Tracking Issues All Activity Retrieve
Error Tracking Issues All Activity Retrieve
error_tracking
Error Tracking Issues Assign Partial Update
Error Tracking Issues Assign Partial Update
error_tracking
Error Tracking Issues Bulk Create
Error Tracking Issues Bulk Create
error_tracking
Error Tracking Issues Cohort Update
Error Tracking Issues Cohort Update
error_tracking
Error Tracking Issues Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
error_tracking
Error Tracking Issues Exists Retrieve
Error Tracking Issues Exists Retrieve
error_tracking
Error Tracking Issues List
Error Tracking Issues List
error_tracking
Error Tracking Issues Merge Create
Error Tracking Issues Merge Create
error_tracking
Error Tracking Issues Partial Update
Error Tracking Issues Partial Update
error_tracking
Error Tracking Issues Retrieve
Error Tracking Issues Retrieve
error_tracking
Error Tracking Issues Split Create
Error Tracking Issues Split Create
error_tracking
Error Tracking Issues Update
Error Tracking Issues Update
error_tracking
Error Tracking Issues Values Retrieve
Error Tracking Issues Values Retrieve
error_tracking
Get compact error tracking issue details
Fetch one error tracking issue with impact counts, top in_app frame, latest release, and optional sparkline.
error_tracking
List sampled exception events for an error tracking issue
Fetch sampled exception events, stack traces, browser/SDK context, URL, and $session_id values for one issue.
error_tracking
List compact error tracking issues
List error tracking issues with typed filters and compact aggregate counts.
error_tracking
Error Tracking Recommendations Dismiss Create
Error Tracking Recommendations Dismiss Create
error_tracking
Error Tracking Recommendations List
Error Tracking Recommendations List
error_tracking
Error Tracking Recommendations Refresh Create
Error Tracking Recommendations Refresh Create
error_tracking
Error Tracking Recommendations Restore Create
Error Tracking Recommendations Restore Create
error_tracking
Error Tracking Releases Create
Error Tracking Releases Create
error_tracking
Error Tracking Releases Destroy
Error Tracking Releases Destroy
error_tracking
Error Tracking Releases Hash Retrieve
Error Tracking Releases Hash Retrieve
error_tracking
Error Tracking Releases List
Error Tracking Releases List
error_tracking
Error Tracking Releases Partial Update
Error Tracking Releases Partial Update
error_tracking
Error Tracking Releases Retrieve
Error Tracking Releases Retrieve
error_tracking
Error Tracking Releases Update
Error Tracking Releases Update
error_tracking
Error Tracking Settings Retrieve Settings Retrieve
Error Tracking Settings Retrieve Settings Retrieve
error_tracking
Error Tracking Settings Update Settings Partial Update
Error Tracking Settings Update Settings Partial Update
error_tracking
Error Tracking Spike Detection Config List
Error Tracking Spike Detection Config List
error_tracking
Error Tracking Spike Detection Config Update Config Partial Update
Error Tracking Spike Detection Config Update Config Partial Update
error_tracking
Error Tracking Spike Events List
Error Tracking Spike Events List
error_tracking
Error Tracking Stack Frames Batch Get Create
Error Tracking Stack Frames Batch Get Create
error_tracking
Error Tracking Stack Frames Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
error_tracking
Error Tracking Stack Frames List
Error Tracking Stack Frames List
error_tracking
Error Tracking Stack Frames Retrieve
Error Tracking Stack Frames Retrieve
error_tracking
Error Tracking Suppression Rules Create
Error Tracking Suppression Rules Create
error_tracking
Error Tracking Suppression Rules Destroy
Error Tracking Suppression Rules Destroy
error_tracking
Error Tracking Suppression Rules List
Error Tracking Suppression Rules List
error_tracking
Error Tracking Suppression Rules Partial Update
Error Tracking Suppression Rules Partial Update
error_tracking
Error Tracking Suppression Rules Reorder Partial Update
Error Tracking Suppression Rules Reorder Partial Update
error_tracking
Error Tracking Suppression Rules Retrieve
Error Tracking Suppression Rules Retrieve
error_tracking
Error Tracking Suppression Rules Update
Error Tracking Suppression Rules Update
error_tracking
Error Tracking Symbol Sets Bulk Delete Create
Error Tracking Symbol Sets Bulk Delete Create
error_tracking
Error Tracking Symbol Sets Bulk Finish Upload Create
Error Tracking Symbol Sets Bulk Finish Upload Create
error_tracking
Error Tracking Symbol Sets Bulk Start Upload Create
Error Tracking Symbol Sets Bulk Start Upload Create
error_tracking
Error Tracking Symbol Sets Destroy
Error Tracking Symbol Sets Destroy
error_tracking
Error Tracking Symbol Sets Download Retrieve
Return a presigned URL for downloading the symbol set's source map.
error_tracking
Error Tracking Symbol Sets Finish Upload Update
Error Tracking Symbol Sets Finish Upload Update
error_tracking
Error Tracking Symbol Sets List
Error Tracking Symbol Sets List
error_tracking
Error Tracking Symbol Sets Retrieve
Error Tracking Symbol Sets Retrieve
error_tracking
Evaluation Runs Create
Create a new evaluation run. This endpoint validates the request and enqueues a Temporal workflow to asynchronously execute the evaluation.
evaluation_runs
Evaluations Create
Evaluations Create
evaluations
Evaluations Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
evaluations
Evaluations List
Evaluations List
evaluations
Evaluations Partial Update
Evaluations Partial Update
evaluations
Evaluations Retrieve
Evaluations Retrieve
evaluations
Evaluations Test Hog Create
Test Hog evaluation code against sample events without saving.
evaluations
Evaluations Update
Evaluations Update
evaluations
Event Definitions Bulk Update Tags Create
Add, remove, or replace tags across multiple event definitions in one request. Overrides ``TaggedItemViewSetMixin.bulk_update_tags``, which assumes integer PKs and runs object-level access-control filtering. Event definitions use UUID PKs and are not an object-level access-controlled resource — project membership (enforced by the viewset) is the only boundary, matching the single-object update path — so this scopes by project and skips the per-object editor check. Tags live on the base ``EventDefinition`` row, so it operates there regardless of the enterprise extension.
event_definitions
Event Definitions By Name Retrieve
Get event definition by exact name
event_definitions
Event Definitions Create
Event Definitions Create
event_definitions
Event Definitions Destroy
Event Definitions Destroy
event_definitions
Event Definitions Golang Retrieve
Event Definitions Golang Retrieve
event_definitions
Event Definitions List
Event Definitions List
event_definitions
Event Definitions Metrics Retrieve
Event Definitions Metrics Retrieve
event_definitions
Event Definitions Partial Update
Event Definitions Partial Update
event_definitions
Event Definitions Primary Properties Retrieve
Resolve team-configured primary properties for event definitions. The response only contains entries where a non-null primary_property is set on the EventDefinition. Callers should fall back to the core taxonomy defaults client-side for names not present in the response.
event_definitions
Event Definitions Python Retrieve
Event Definitions Python Retrieve
event_definitions
Event Definitions Retrieve
Event Definitions Retrieve
event_definitions
Event Definitions Typescript Retrieve
Event Definitions Typescript Retrieve
event_definitions
Event Definitions Update
Event Definitions Update
event_definitions
Event Filter Create
Create or update the event filter config.
event_filter
Event Filter Metrics Retrieve
Single event filter per team. GET /event_filter/ — returns the config (or null if not yet created) POST /event_filter/ — creates or updates the config (upsert) GET /event_filter/metrics/ — time-series metrics GET /event_filter/metrics/totals/ — aggregate totals
event_filter
Event Filter Metrics Totals Retrieve
Single event filter per team. GET /event_filter/ — returns the config (or null if not yet created) POST /event_filter/ — creates or updates the config (upsert) GET /event_filter/metrics/ — time-series metrics GET /event_filter/metrics/totals/ — aggregate totals
event_filter
Event Filter Retrieve
Returns the event filter config for the team, or null if not yet created.
event_filter
Event Schemas Create
Event Schemas Create
event_schemas
Event Schemas Destroy
Event Schemas Destroy
event_schemas
Event Schemas List
Event Schemas List
event_schemas
Event Schemas Partial Update
Event Schemas Partial Update
event_schemas
Event Schemas Update
Event Schemas Update
event_schemas
Events List
This endpoint allows you to list and filter events. It is effectively deprecated and is kept only for backwards compatibility. If you ever ask about it you will be advised to not use it... If you want to ad-hoc list or aggregate events, use the Query endpoint instead. If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.
events
Events Retrieve
Events Retrieve
events
Events Values Retrieve
Events Values Retrieve
events
Experiment Holdouts Create
Experiment Holdouts Create
experiment_holdouts
Experiment Holdouts Destroy
Experiment Holdouts Destroy
experiment_holdouts
Experiment Holdouts List
Experiment Holdouts List
experiment_holdouts
Experiment Holdouts Partial Update
Experiment Holdouts Partial Update
experiment_holdouts
Experiment Holdouts Retrieve
Experiment Holdouts Retrieve
experiment_holdouts
Experiment Holdouts Update
Experiment Holdouts Update
experiment_holdouts
Experiment Saved Metrics Create
Experiment Saved Metrics Create
experiment_saved_metrics
Experiment Saved Metrics Destroy
Experiment Saved Metrics Destroy
experiment_saved_metrics
Experiment Saved Metrics List
Experiment Saved Metrics List
experiment_saved_metrics
Experiment Saved Metrics Partial Update
Experiment Saved Metrics Partial Update
experiment_saved_metrics
Experiment Saved Metrics Retrieve
Experiment Saved Metrics Retrieve
experiment_saved_metrics
Experiment Saved Metrics Update
Experiment Saved Metrics Update
experiment_saved_metrics
Experiments Archive Create
Archive an ended experiment. Hides the experiment from the default list view. The experiment can be restored at any time by updating archived=false. When the linked feature flag is still enabled, pass disable_feature_flag=true to also disable and archive it. Returns 400 if the experiment is already archived or has not ended yet.
experiments
Experiments Calculate Running Time Create
Estimate the recommended sample size and running time for an experiment. Pure statistical calculation — does not read or write any experiment. Pass the metric type, a minimum detectable effect, and either a baseline value or raw baseline statistics. When `exposure_rate_per_day` is provided, the response also includes the estimated running time in days.
experiments
Experiments Copy To Project Create
Copy an experiment into another project in the same organization as a new draft.
experiments
Experiments Create
Create a new experiment in draft status with optional metrics.
experiments
Experiments Create Exposure Cohort For Experiment Create
Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers. This mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator on serializer methods and converts them into proper HTTP 409 Conflict responses with change request details.
experiments
Experiments Create From Prompt Create
Create an experiment that compares N versions of an LLM prompt using a metric template. The user picks 2+ versions of an existing LLMPrompt and 1+ metric templates (cost / latency / eval_pass_rate). The endpoint builds the matching variants (control + test-N, each named after its prompt version) and attaches one metric per selected template, each scoped to the prompt's $ai_prompt_name. Resulting experiment is in draft state.
experiments
Experiments Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
experiments
Experiments Duplicate Create
Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers. This mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator on serializer methods and converts them into proper HTTP 409 Conflict responses with change request details.
experiments
Experiments Eligible Feature Flags Retrieve
Returns a paginated list of feature flags eligible for use in experiments. Eligible flags must: - Be multivariate with at least 2 variants - Have "control" as the first variant key Query parameters: - search: Filter by flag key or name (case insensitive) - limit: Number of results per page (default: 20) - offset: Pagination offset (default: 0) - active: Filter by active status ("true" or "false") - created_by_id: Filter by creator user ID - order: Sort order field - evaluation_runtime: Filter by evaluation runtime - has_evaluation_contexts: Filter by presence of evaluation contexts ("true" or "false")
experiments
Experiments End Create
End a running experiment without shipping a variant. Sets end_date to now and marks the experiment as stopped. The feature flag is NOT modified — users continue to see their assigned variants and exposure events ($feature_flag_called) continue to be recorded. However, only data up to end_date is included in experiment results. Use this when: - You want to freeze the results window without changing which variant users see. - A variant was already shipped manually via the feature flag UI and the experiment just needs to be marked complete. The end_date can be adjusted after ending via PATCH if it needs to be backdated (e.g. to match when the flag was actually paused). Other options: - Use ship_variant to end the experiment AND roll out a single variant to 100%% of users. - Use pause to deactivate the flag without ending the experiment (stops variant assignment but does not freeze results). Returns 400 if the experiment is not running.
experiments
Experiments Launch Create
Launch a draft experiment. Validates the experiment is in draft state, activates its linked feature flag, sets start_date to the current server time, and transitions the experiment to running. Returns 400 if the experiment has already been launched or if the feature flag configuration is invalid (e.g. missing "control" variant or fewer than 2 variants).
experiments
Experiments List
List experiments for the current project. Supports filtering by status and archival state.
experiments
Experiments Metrics Recalculation Create
Trigger a batch recalculation of all metrics for this experiment. Returns 201 with the new pending recalculation, or 200 with the active one if a recalculation is already pending or in progress for this experiment. The response payload intentionally does not include the `results` array — at POST time the workflow has just been queued and no per-metric results exist yet. Clients should poll `GET metrics_recalculation/{id}/` for results as the workflow progresses.
experiments
Experiments Metrics Recalculation Latest Retrieve
Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers. This mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator on serializer methods and converts them into proper HTTP 409 Conflict responses with change request details.
experiments
Experiments Metrics Recalculation Retrieve
Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers. This mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator on serializer methods and converts them into proper HTTP 409 Conflict responses with change request details.
experiments
Experiments Partial Update
Update an experiment. Use this to modify experiment properties such as name, description, metrics, variants, and configuration. Metrics can be added, changed and removed at any time. Feature-flag config (variants, rollout, payloads) is sent via the feature_flag object.
experiments
Experiments Pause Create
Pause a running experiment. Deactivates the linked feature flag so it is no longer returned by the /decide endpoint. Users fall back to the application default (typically the control experience), and no new exposure events are recorded (i.e. $feature_flag_called is not fired). Returns 400 if the experiment is not running or is already paused.
experiments
Experiments Prompt Templates Retrieve
List the LLM metric templates that can be passed to `create_from_prompt`.
experiments
Experiments Recalculate Timeseries Create
Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers. This mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator on serializer methods and converts them into proper HTTP 409 Conflict responses with change request details.
experiments
Experiments Requires Flag Implementation Retrieve
Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers. This mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator on serializer methods and converts them into proper HTTP 409 Conflict responses with change request details.
experiments
Experiments Reset Create
Reset an experiment back to draft state. Clears start/end dates, conclusion, and archived flag. The feature flag is left unchanged — users continue to see their assigned variants. Previously collected events still exist but won't be included in results unless the start date is manually adjusted after re-launch. Returns 400 if the experiment is already in draft state.
experiments
Experiments Resume Create
Resume a paused experiment. Reactivates the linked feature flag so it is returned by /decide again. Users are re-bucketed deterministically into the same variants they had before the pause, and exposure tracking resumes. Returns 400 if the experiment is not running or is not paused.
experiments
Experiments Retrieve
Retrieve a single experiment by ID, including its current status, metrics, feature flag, and results metadata.
experiments
Experiments Ship Variant Create
Ship a variant and (optionally) end the experiment. Updates the feature flag so the selected variant gets 100% of the variant distribution. By default, existing release conditions on the flag are preserved untouched — the variant is served only to users who already match them. Pass ``release_to_everyone: true`` to also prepend a catch-all release condition that rolls the variant out to 100% of users (overrides any existing release conditions on the flag). Can be called on both running and stopped experiments. If the experiment is still running, it will also be ended (end_date set and status marked as stopped). If the experiment has already ended, only the flag is rewritten - this supports the "end first, ship later" workflow. If an approval policy requires review before changes on the flag take effect, the API returns 409 with a change_request_id. The experiment is NOT ended until the change request is approved and the user retries. Returns 400 if the experiment is in draft state, the variant_key is not found on the flag, or the experiment has no linked feature flag.
experiments
Experiments Stats Retrieve
Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers. This mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator on serializer methods and converts them into proper HTTP 409 Conflict responses with change request details.
experiments
Experiments Timeseries Results Retrieve
Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers. This mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator on serializer methods and converts them into proper HTTP 409 Conflict responses with change request details.
experiments
Experiments Unarchive Create
Unarchive an archived experiment. Restores the experiment to the default list view. Returns 400 if the experiment is not currently archived.
experiments
Experiments Update
Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers. This mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator on serializer methods and converts them into proper HTTP 409 Conflict responses with change request details.
experiments
Exports Content Retrieve
Exports Content Retrieve
exports
Exports Create
Exports Create
exports
Exports List
Exports List
exports
Exports Retrieve
Exports Retrieve
exports
External Data Schemas Cancel Create
External Data Schemas Cancel Create
external_data_schemas
External Data Schemas Create
External Data Schemas Create
external_data_schemas
External Data Schemas Delete Data Destroy
External Data Schemas Delete Data Destroy
external_data_schemas
External Data Schemas Destroy
External Data Schemas Destroy
external_data_schemas
External Data Schemas Incremental Fields Create
External Data Schemas Incremental Fields Create
external_data_schemas
External Data Schemas List
External Data Schemas List
external_data_schemas
External Data Schemas Logs Retrieve
External Data Schemas Logs Retrieve
external_data_schemas
External Data Schemas Partial Update
External Data Schemas Partial Update
external_data_schemas
External Data Schemas Reload Create
External Data Schemas Reload Create
external_data_schemas
External Data Schemas Resync Create
External Data Schemas Resync Create
external_data_schemas
External Data Schemas Retrieve
External Data Schemas Retrieve
external_data_schemas
External Data Schemas Update
External Data Schemas Update
external_data_schemas
External Data Sources Bulk Update Schemas Partial Update
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Cdc Status Retrieve
Live CDC health for an existing source: slot/publication existence and WAL lag. Reads from the source DB via the engine adapter. Returns ``{"enabled": false}`` when CDC is off, or the stored config plus live ``slot_exists`` / ``publication_exists`` / ``lag_bytes`` when on. 400s if the source DB is unreachable so the UI can show a degraded/unreachable state.
external_data_sources
External Data Sources Check Cdc Prerequisites Create
Validate CDC prerequisites against a live Postgres connection. Used by the source wizard to surface ✅/❌ checks before source creation, and by the self-managed setup popup to verify user-created publications.
external_data_sources
External Data Sources Check Cdc Prerequisites For Source Create
Validate CDC prerequisites for an existing source using its stored credentials. The detail=False ``check_cdc_prerequisites`` action is for the creation wizard, where the client still holds the raw connection config (incl. password) in the form. On the Configuration page the source already exists and secret fields are stripped from API responses — so the client can't supply them. This reads the stored (encrypted) credentials from the DB via the adapter instead. Body params: ``cdc_management_mode`` (``"posthog"`` | ``"self_managed"``), ``cdc_slot_name`` (optional), ``cdc_publication_name`` (optional).
external_data_sources
External Data Sources Connect Link Retrieve
Return a secure browser link for connecting a data warehouse source. The link opens a minimal connect page rendering the source's full connection form — OAuth options included — with no table selection and no source creation. The user authenticates in their browser, secrets never pass through the agent, and the agent finishes setup afterwards by passing the stored credential id to data-warehouse-source-setup.
external_data_sources
External Data Sources Connections List
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Create
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Create Webhook Create
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Database Schema Create
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Delete Webhook Create
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Destroy
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Disable Cdc Create
Disable CDC on an existing source. Cancels any running CDC extraction workflow, deletes the extraction schedule, delegates engine-side teardown to the source's adapter (drops slot/publication for Postgres; equivalent for other engines), clears ``cdc_*`` keys from ``job_inputs``, soft-deletes companion CDC tables, and sets all CDC schemas to ``sync_type=None``, ``should_sync=False`` so the user must pick a new sync strategy before they resume.
external_data_sources
External Data Sources Draft Custom Manifest Create
Draft a Custom REST source manifest from API documentation using an LLM. Reads the docs (a URL fetched server-side, or pasted text / OpenAPI spec), asks the model to author a RESTAPIConfig manifest, and validates it against the create-path checks — repairing against validation errors up to a small budget. Returns the manifest for the user to review and tweak in the builder before creating the source; it does NOT create anything. Gated by the `dwh-custom-source-ai-builder` flag, and requires the org to have approved AI data processing, since the docs are sent to the LLM gateway.
external_data_sources
External Data Sources Enable Cdc Create
Enable CDC on an existing source. Provisions engine-side CDC resources via the source's adapter, writes the CDC config into ``source.job_inputs``, and ensures the CDC extraction schedule exists. Re-runs prereq checks server-side so we never trust a stale client-side check. Body params: ``cdc_management_mode`` (``"posthog"`` | ``"self_managed"``), plus engine-specific identifier hints (e.g. ``cdc_slot_name``, ``cdc_publication_name`` for Postgres). Universal tuning fields: ``cdc_auto_drop_slot`` (optional bool), ``cdc_lag_warning_threshold_mb`` (optional int), ``cdc_lag_critical_threshold_mb`` (optional int).
external_data_sources
External Data Sources Jobs Retrieve
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources List
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Partial Update
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Preview Resource Create
Read a bounded sample of rows for one resource of a Custom REST source. Lets a manifest author verify `data_selector`, `primary_key`, and the incremental `cursor_path` against live data before creating the source. Only `source_type: "Custom"` is supported — other source types return 400. The read is bounded (single page per resource, capped row count, short timeouts, no redirects). Manifest, validation, and SSRF problems return 400; a live fetch failure returns 200 with `error` set and empty `rows`.
external_data_sources
External Data Sources Refresh Schemas Create
Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync).
external_data_sources
External Data Sources Reload Create
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Repair Cdc Create
Repair CDC on a source whose replication resources were lost. Only proceeds on evidence of breakage (a persisted broken marker, or a live probe showing the slot/publication missing) — repairing a healthy source would drop its slot and force a full re-sync. Cancels running CDC jobs, recreates the engine-side slot/publication against the stored CDC config, resets every active CDC schema to snapshot mode for a full re-sync (changes since the old slot died are unrecoverable), clears the broken markers, and resumes the paused schedules. Idempotent: safe to retry after a partial failure. Concurrent repairs of the same source are rejected with a 409.
external_data_sources
External Data Sources Retrieve
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Revenue Analytics Config Partial Update
Update the revenue analytics configuration and return the full external data source.
external_data_sources
External Data Sources Setup Create
One-shot data warehouse source setup. Validate credentials, discover available tables, enable them all with sensible sync defaults (incremental where supported, else append, else full refresh), and create the source in a single call — the caller never has to assemble a `schemas` array. For sources that support webhooks (e.g. Stripe), a webhook is auto-registered after creation: on success webhook-capable tables switch to real-time webhook sync (unlocking webhook-only tables); on failure the polling defaults stay in place. For fine-grained table/sync control, use the lower-level `database_schema` + `create` flow instead.
external_data_sources
External Data Sources Source Prefix Create
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Store Credentials Create
Validate and store credentials for a data warehouse source without creating the source. Backs the source connect page: the user enters credentials directly in PostHog, they are checked against a live connection, then stashed encrypted in a temporary store. The returned credential id can be passed to `setup` as {'credential_id': <id>} to create the source — so secrets never travel through an agent conversation. The stash is single-use: it is deleted as soon as `setup` consumes it, and expires after 24 hours if never consumed.
external_data_sources
External Data Sources Stored Credentials List
List credentials stored via the source connect page that haven't been consumed yet. Returns metadata only (id, source type, timestamps) — never the secrets themselves. Stored credentials are temporary: they disappear once consumed by `setup` or when they expire. Newest first, so after a user confirms they've finished the connect page, the first entry for the source type is the one to pass to `setup`.
external_data_sources
External Data Sources Update
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Update Cdc Settings Create
Update CDC tuning fields without enabling/disabling. Lets users edit ``cdc_auto_drop_slot``, ``cdc_lag_warning_threshold_mb``, and ``cdc_lag_critical_threshold_mb`` independently. These fields are universal across engines. Engine-specific identifiers (slot name, management mode, …) are immutable post-enable — switching them requires disable + enable.
external_data_sources
External Data Sources Update Webhook Inputs Create
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Webhook Info Retrieve
Create, Read, Update and Delete External data Sources.
external_data_sources
External Data Sources Wizard Retrieve
Create, Read, Update and Delete External data Sources.
external_data_sources
Feature Flags Activity Retrieve
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags All Activity Retrieve
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags Bulk Delete Create
Bulk delete feature flags by filter criteria or explicit IDs. Accepts either: - {"filters": {...}} - Same filter params as list endpoint (search, active, type, etc.) - {"ids": [...]} - Explicit list of flag IDs (no limit) Returns same format as bulk_delete for UI compatibility. Uses bulk operations for efficiency: database updates are batched and cache invalidation happens once at the end rather than per-flag.
feature_flags
Feature Flags Bulk Keys Retrieve
Get feature flag keys by IDs. Accepts a list of feature flag IDs and returns a mapping of ID to key.
feature_flags
Feature Flags Bulk Update Tags Create
Bulk update tags on multiple objects. PAT access: this action has no ``required_scopes=`` on the decorator — inheriting viewsets must add ``"bulk_update_tags"`` to their ``scope_object_write_actions`` list to accept personal API keys. Without that opt-in, ``APIScopePermission`` rejects PAT requests with "This action does not support personal API key access". Done per-viewset so granting ``<scope>:write`` for one resource doesn't leak access to sibling resources that share this mixin. Accepts: - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]} Actions: - "add": Add tags to existing tags on each object - "remove": Remove specific tags from each object - "set": Replace all tags on each object with the provided list
feature_flags
Feature Flags Create
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags Create Static Cohort For Flag Create
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags Dashboard Create
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags Dependent Flags List
Get other active flags that depend on this flag.
feature_flags
Feature Flags Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
feature_flags
Feature Flags Enrich Usage Dashboard Create
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags Evaluation Reasons Retrieve
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags List
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags Matching Ids Retrieve
Get IDs of all feature flags matching the current filters. Uses the same filtering logic as the list endpoint. Returns only IDs that the user has permission to edit.
feature_flags
Feature Flags My Flags Retrieve
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags Partial Update
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags Remote Config Retrieve
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags Retrieve
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags Status Retrieve
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags Test Evaluation Create
Test feature flag evaluation against a specific user at an optional point in time. This endpoint allows testing how a feature flag would evaluate for a specific user, optionally at a historical timestamp. When a timestamp is provided, both the flag conditions and person properties are evaluated as they existed at that time.
feature_flags
Feature Flags Update
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags User Blast Radius Create
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Feature Flags Versions Retrieve
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags. If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
feature_flags
Field Notes Create
Create, read, update, and resolve toolbar field notes — UI feedback a user points at on their own site, surfaced to coding agents over MCP.
field_notes
Field Notes Destroy
Create, read, update, and resolve toolbar field notes — UI feedback a user points at on their own site, surfaced to coding agents over MCP.
field_notes
Field Notes List
Create, read, update, and resolve toolbar field notes — UI feedback a user points at on their own site, surfaced to coding agents over MCP.
field_notes
Field Notes Partial Update
Create, read, update, and resolve toolbar field notes — UI feedback a user points at on their own site, surfaced to coding agents over MCP.
field_notes
Field Notes Retrieve
Create, read, update, and resolve toolbar field notes — UI feedback a user points at on their own site, surfaced to coding agents over MCP.
field_notes
Field Notes Update
Create, read, update, and resolve toolbar field notes — UI feedback a user points at on their own site, surfaced to coding agents over MCP.
field_notes
File Download Batch Exports Cancel Create
Cancel an ongoing file-download batch export.
batch_exportsfile_download_batch_exports
File Download Batch Exports Create
Create and start a batch export on demand run to download a file.
batch_exportsfile_download_batch_exports
File Download Batch Exports Download Retrieve
Download a file (or a part) from this batch export run. Users can provide a part component with an id or index, or no part component at all: * If part id is included: The file download matching the id is downloaded. * If part index is included: The file download matching the index (as ordered by key) is downloaded. * If no part component is present: If there is only one file downloaded, that is downloaded. Otherwise the first one as sorted by key is downloaded.
batch_exportsfile_download_batch_exports
File Download Batch Exports List
File Download Batch Exports List
batch_exportsfile_download_batch_exports
File Download Batch Exports Logs Retrieve
File Download Batch Exports Logs Retrieve
batch_exportsfile_download_batch_exports
File Download Batch Exports Retrieve
Get a batch export on demand run. If the underlying batch export run has completed, we return keys to the generated file downloads so that users may download them by making a request to /download.
batch_exportsfile_download_batch_exports
File System Count By Path Create
Get count of all files in a folder.
file_system
File System Count Create
Get count of all files in a folder.
file_system
File System Create
File System Create
file_system
File System Destroy
File System Destroy
file_system
File System Link Create
File System Link Create
file_system
File System List
File System List
file_system
File System Log View Create
File System Log View Create
file_system
File System Log View Retrieve
File System Log View Retrieve
file_system
File System Move Create
File System Move Create
file_system
File System Partial Update
File System Partial Update
file_system
File System Retrieve
File System Retrieve
file_system
File System Shortcut Create
File System Shortcut Create
file_system_shortcut
File System Shortcut Destroy
File System Shortcut Destroy
file_system_shortcut
File System Shortcut List
File System Shortcut List
file_system_shortcut
File System Shortcut Partial Update
File System Shortcut Partial Update
file_system_shortcut
File System Shortcut Reorder Create
Set the display order of the current user's shortcuts. `ordered_ids` becomes the new top-to-bottom order; any unknown IDs are rejected.
file_system_shortcut
File System Shortcut Retrieve
File System Shortcut Retrieve
file_system_shortcut
File System Shortcut Update
File System Shortcut Update
file_system_shortcut
File System Undo Delete Create
File System Undo Delete Create
file_system
File System Unfiled Retrieve
File System Unfiled Retrieve
file_system
File System Update
File System Update
file_system
Flag Value Values Retrieve
Get possible values for a feature flag. Query parameters: - key: The flag ID (required) Returns: - Array of objects with 'name' field containing possible values
flag_value
Groups Activity Retrieve
Groups Activity Retrieve
groups
Groups Create
Groups Create
groups
Groups Delete Property Create
Groups Delete Property Create
groups
Groups Find Retrieve
Groups Find Retrieve
groups
Groups List
List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/. Uses forward-only keyset pagination via the `cursor` parameter. The `previous` field in the response envelope is always null.
groups
Groups Property Values Retrieve
Groups Property Values Retrieve
groups
Groups Related Retrieve
Groups Related Retrieve
groups
Groups Types Create Detail Dashboard Update
Groups Types Create Detail Dashboard Update
groups_types
Groups Types Destroy
Groups Types Destroy
groups_types
Groups Types List
Groups Types List
groups_types
Groups Types Metrics Create
Groups Types Metrics Create
groups_types
Groups Types Metrics Destroy
Groups Types Metrics Destroy
groups_types
Groups Types Metrics List
Groups Types Metrics List
groups_types
Groups Types Metrics Partial Update
Groups Types Metrics Partial Update
groups_types
Groups Types Metrics Retrieve
Groups Types Metrics Retrieve
groups_types
Groups Types Metrics Update
Groups Types Metrics Update
groups_types
Groups Types Set Default Columns Update
Groups Types Set Default Columns Update
groups_types
Groups Types Update Metadata Partial Update
Groups Types Update Metadata Partial Update
groups_types
Groups Update Property Create
Groups Update Property Create
groups
List health issues
Lists health issues detected across all of this project's PostHog health checks (outdated SDKs, data warehouse sync failures, missing web analytics events, ingestion warnings, and more). Filter by status, severity, kind, or dismissed state.
health_issues
Health Issues Partial Update
Health Issues Partial Update
health_issues
Health Issues Refresh Create
Health Issues Refresh Create
health_issues
Health Issues Resolve Create
Health Issues Resolve Create
health_issues
Get a health issue
Fetches a single health issue, enriched with the owning check's rendered explanation: a title, a one-line summary of what's wrong, a deep link to the relevant page, and remediation guidance for how to fix it.
health_issues
Summarize active health issues
Returns aggregated counts of active, non-dismissed health issues for the project, broken down by severity and by kind. Use for a quick overview of overall project health before drilling in with the list endpoint.
health_issues
Heatmap Screenshots Content Retrieve
Fetch the rendered screenshot image (JPEG bytes) for a saved heatmap at a given viewport width. Returns 202 with the saved-heatmap metadata while the screenshot is still being generated.
heatmap_screenshots
Heatmaps Events Retrieve
Drill into the individual session interactions behind one or more heatmap coordinates. Pass the 'points' you want to inspect (from the heatmaps list response) to get the underlying per-session events, so you can jump to the session recordings that produced a hotspot.
heatmaps
Heatmaps List
Aggregated heatmap interactions for a page. For type 'click'/'rageclick'/'mousemove' each result is a point with relative x, absolute client-y, and a count. For type 'scrolldepth' the response is scroll-depth buckets instead (cumulative reach down the page).
heatmaps
Hog Flows Asset Content Retrieve
Hog Flows Asset Content Retrieve
hog_flows
Hog Flows Assets Retrieve
Hog Flows Assets Retrieve
hog_flows
Hog Flows Batch Jobs Create
Hog Flows Batch Jobs Create
hog_flows
Hog Flows Batch Jobs List
Hog Flows Batch Jobs List
hog_flows
Hog Flows Bulk Delete Create
Hog Flows Bulk Delete Create
hog_flows
Hog Flows Create
Hog Flows Create
hog_flows
Hog Flows Destroy
Hog Flows Destroy
hog_flows
Hog Flows Graph Partial Update
Hog Flows Graph Partial Update
hog_flows
Hog Flows Invocation Result Retrieve
Hog Flows Invocation Result Retrieve
hog_flows
Hog Flows Invocation Results Retrieve
Hog Flows Invocation Results Retrieve
hog_flows
Hog Flows Invocations Create
Hog Flows Invocations Create
hog_flows
Hog Flows List
Hog Flows List
hog_flows
Hog Flows Logs Retrieve
Hog Flows Logs Retrieve
hog_flows
Hog Flows Metrics Global Retrieve
Hog Flows Metrics Global Retrieve
hog_flows
Hog Flows Metrics Retrieve
Hog Flows Metrics Retrieve
hog_flows
Hog Flows Metrics Totals Retrieve
Hog Flows Metrics Totals Retrieve
hog_flows
Hog Flows Partial Update
Hog Flows Partial Update
hog_flows
Hog Flows Rerun Create
Rerun past invocations of this hog flow from their stored payloads. Same shape and semantics as the hog function rerun endpoint — proxies through to the CDP worker, which reads matching rows from ClickHouse, rehydrates from `invocation_globals`, and re-enqueues onto cyclotron with `is_retry=1`. Because rerun replays historical event/person/group data, it requires `person:read` and `group:read` on top of `hog_flow:write`.
hog_flows
Hog Flows Retrieve
Hog Flows Retrieve
hog_flows
Hog Flows Schedules Create
Hog Flows Schedules Create
hog_flows
Hog Flows Schedules Destroy
Hog Flows Schedules Destroy
hog_flows
Hog Flows Schedules List
Hog Flows Schedules List
hog_flows
Hog Flows Schedules Partial Update
Hog Flows Schedules Partial Update
hog_flows
Hog Flows Update
Hog Flows Update
hog_flows
Hog Flows User Blast Radius Create
Hog Flows User Blast Radius Create
hog_flows
Hog Function Templates List
Hog Function Templates List
hog_function_templateshog_function_templates
Hog Function Templates Retrieve
Hog Function Templates Retrieve
hog_function_templateshog_function_templates
Hog Functions Create
Hog Functions Create
hog_functionshog_functions
Hog Functions Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
hog_functionshog_functions
Hog Functions Enable Backfills Create
Hog Functions Enable Backfills Create
hog_functionshog_functions
Hog Functions Icon Retrieve
Hog Functions Icon Retrieve
hog_functionshog_functions
Hog Functions Icons Retrieve
Hog Functions Icons Retrieve
hog_functionshog_functions
Hog Functions Invocations Create
Hog Functions Invocations Create
hog_functionshog_functions
Hog Functions List
Hog Functions List
hog_functionshog_functions
Hog Functions Logs Retrieve
Hog Functions Logs Retrieve
hog_functionshog_functions
Hog Functions Metrics Retrieve
Hog Functions Metrics Retrieve
hog_functionshog_functions
Hog Functions Metrics Totals Retrieve
Hog Functions Metrics Totals Retrieve
hog_functionshog_functions
Hog Functions Partial Update
Hog Functions Partial Update
hog_functionshog_functions
Hog Functions Rearrange Partial Update
Update the execution order of multiple HogFunctions.
hog_functionshog_functions
Hog Functions Rerun Create
Rerun past invocations of this hog function from their stored payloads. The CDP worker reads matching rows from the `hog_invocation_results` ClickHouse table, rehydrates the invocation from the stored `invocation_globals`, and re-enqueues onto cyclotron. Each rerun run reuses the original `invocation_id` with `is_retry=1` set on the new lifecycle row so the UI can surface that it was a rerun. For source-webhook functions the worker strips `request.headers` from the rehydrated globals before re-enqueuing (see the rerun paginator): those headers carry the inbound sender's credentials, and replaying them through a reconfigured function would let a write-access user exfiltrate stored secrets. Because rerun replays historical event/person/group data, it requires `person:read` and `group:read` on top of `hog_function:write`.
hog_functionshog_functions
Hog Functions Retrieve
Hog Functions Retrieve
hog_functionshog_functions
Hog Functions Update
Hog Functions Update
hog_functionshog_functions
Identity Provider Configs Create
Identity Provider Configs Create
organizationsidentity_provider_configs
Identity Provider Configs Destroy
Identity Provider Configs Destroy
organizationsidentity_provider_configs
Identity Provider Configs List
Identity Provider Configs List
organizationsidentity_provider_configs
Identity Provider Configs Partial Update
Identity Provider Configs Partial Update
organizationsidentity_provider_configs
Identity Provider Configs Retrieve
Identity Provider Configs Retrieve
organizationsidentity_provider_configs
Identity Provider Configs Scim Token Create
Regenerate the SCIM bearer token for this IdP config.
organizationsidentity_provider_configs
Identity Provider Configs Update
Identity Provider Configs Update
organizationsidentity_provider_configs
List ingestion warnings
Lists this project's ingestion warnings — events or person/group updates that were ingested with problems (oversized messages, rejected person merges, invalid data) — grouped by warning type. Each entry carries the warning's category and severity, the total count and a sparkline over the requested time range, and the most recent sample warnings with the affected event/person/group. Filter by category, type, severity or time range to drill into a specific problem.
ingestion_warnings_v2
Insight Variables Create
Insight Variables Create
insight_variables
Insight Variables Destroy
Insight Variables Destroy
insight_variables
Insight Variables List
Insight Variables List
insight_variables
Insight Variables Partial Update
Insight Variables Partial Update
insight_variables
Insight Variables Retrieve
Insight Variables Retrieve
insight_variables
Insight Variables Update
Insight Variables Update
insight_variables
Insights Activity Retrieve
Audit trail for a single insight — every change made to it, by whom, and when. Use this when you want the change history of a specific insight; use the project-wide activity endpoint for a broader view.
insights
Insights All Activity Retrieve
Project-wide audit trail across all insights — who created, edited, deleted, or restored insights, what changed (with before/after diffs), and when. Useful for surfacing what people (or agents) have been working on recently.
insights
Insights Analyze Retrieve
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Insights Bulk Delete Create
Soft-delete insights in bulk by ID. Mirrors the single-insight delete: sets deleted=True, soft-deletes the insights' dashboard tiles, and removes their linked alerts. Insights the requester cannot edit are skipped and reported in `skipped`. Reversible via the bulk_restore endpoint.
insights
Insights Bulk Restore Create
Restore soft-deleted insights in bulk by ID — the inverse of bulk_delete. Sets deleted=False and re-activates the insights' dashboard tiles on dashboards that still exist. Linked alerts are not restored (they are removed on delete). Insights the requester cannot edit are reported in `skipped`.
insights
Insights Bulk Update Tags Create
Bulk update tags on multiple objects. PAT access: this action has no ``required_scopes=`` on the decorator — inheriting viewsets must add ``"bulk_update_tags"`` to their ``scope_object_write_actions`` list to accept personal API keys. Without that opt-in, ``APIScopePermission`` rejects PAT requests with "This action does not support personal API key access". Done per-viewset so granting ``<scope>:write`` for one resource doesn't leak access to sibling resources that share this mixin. Accepts: - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]} Actions: - "add": Add tags to existing tags on each object - "remove": Remove specific tags from each object - "set": Replace all tags on each object with the provided list
insights
Insights Cancel Create
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Insights Create
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Insights Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
insights
Insights Generate Metadata Create
Generate an AI-suggested name and description for an insight based on its query configuration.
insights
Insights List
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Insights My Last Viewed Retrieve
Returns basic details about the last 5 insights viewed by this user. Most recently viewed first.
insights
Insights Partial Update
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Insights Retrieve
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Insights Sharing List
Insights Sharing List
insights
Insights Sharing Passwords Create
Create a new password for the sharing configuration.
insights
Insights Sharing Passwords Destroy
Delete a password from the sharing configuration.
insights
Insights Sharing Refresh Create
Insights Sharing Refresh Create
insights
Insights Suggestions Create
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Insights Suggestions Retrieve
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Insights Thresholds List
Insights Thresholds List
insights
Insights Thresholds Retrieve
Insights Thresholds Retrieve
insights
Insights Trending Retrieve
Returns insights ranked by view count over the last N days (default 7), highest first. Each result includes the same metadata as the standard insights list, plus a `view_count` and up to 3 recent `viewers`. Useful for surfacing the most-used insights in a project.
insights
Insights Update
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
insights
Insights Viewed Create
Record that the current user has just viewed one or more insights. Submitted ids that do not belong to the current project or that point at deleted insights are silently dropped. Returns 201 on success regardless of how many ids were retained.
insights
Integrations Anthropic Managed Agent Envs Retrieve
Integrations Anthropic Managed Agent Envs Retrieve
integrations
Integrations Anthropic Managed Agent Vaults Retrieve
Integrations Anthropic Managed Agent Vaults Retrieve
integrations
Integrations Anthropic Managed Agents Retrieve
Integrations Anthropic Managed Agents Retrieve
integrations
Integrations Authorize Retrieve
Integrations Authorize Retrieve
integrations
Integrations Channels Retrieve
Integrations Channels Retrieve
integrations
Integrations Clickup Lists Retrieve
Integrations Clickup Lists Retrieve
integrations
Integrations Clickup Spaces Retrieve
Integrations Clickup Spaces Retrieve
integrations
Integrations Clickup Workspaces Retrieve
Integrations Clickup Workspaces Retrieve
integrations
Integrations Create
Integrations Create
integrations
Integrations Destroy
Integrations Destroy
integrations
Integrations Domain Connect Apply Url Create
Unified endpoint for generating Domain Connect apply URLs. Accepts a context ("email" or "proxy") and the relevant resource ID. The backend resolves the domain, template variables, and service ID based on context, then builds the signed apply URL.
integrations
Integrations Domain Connect Check Retrieve
Integrations Domain Connect Check Retrieve
integrations
Integrations Email Partial Update
Integrations Email Partial Update
integrations
Integrations Email Verify Create
Integrations Email Verify Create
integrations
Integrations Environment Mapping Partial Update
ViewSet for organization-level integrations. Provides access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc. Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Users can disconnect integrations via the DELETE endpoint.
organizationsintegrations
Integrations Github Branches Retrieve
Integrations Github Branches Retrieve
integrations
Integrations Github Link Existing Create
Reuse a GitHub installation already linked to a sibling team in the same organization.
integrations
Integrations Github Oauth Authorize Create
Mint a User OAuth URL to bootstrap a fresh `code` when the install flow returns without one.
integrations
Integrations Github Prepare Callback Create
Seed GitHub setup callback state without redirecting to GitHub. Used when the user opens an existing installation's settings on github.com (e.g. PostHog Code "Update in GitHub") so the subsequent Setup URL redirect can be validated.
integrations
Integrations Github Repos Refresh Create
Integrations Github Repos Refresh Create
integrations
Integrations Github Repos Retrieve
Integrations Github Repos Retrieve
integrations
Integrations Github Teams Retrieve
Integrations Github Teams Retrieve
integrations
Integrations Google Accessible Accounts Retrieve
Integrations Google Accessible Accounts Retrieve
integrations
Integrations Google Conversion Actions Retrieve
Integrations Google Conversion Actions Retrieve
integrations
Integrations Google Search Console Sites Retrieve
List the Search Console properties the connected Google account has access to.
integrations
Integrations Jira Projects Retrieve
Integrations Jira Projects Retrieve
integrations
Integrations Linear Teams Retrieve
Integrations Linear Teams Retrieve
integrations
Integrations Linkedin Ads Accounts Retrieve
Integrations Linkedin Ads Accounts Retrieve
integrations
Integrations Linkedin Ads Conversion Rules Retrieve
Integrations Linkedin Ads Conversion Rules Retrieve
integrations
Integrations List
Integrations List
integrations
Integrations Request Access Create
Notify project admins that a member is requesting an integration be connected.
integrations
Integrations Retrieve
Integrations Retrieve
integrations
Integrations Twilio Phone Numbers Retrieve
Integrations Twilio Phone Numbers Retrieve
integrations
Invites Bulk Create
Invites Bulk Create
organizationsinvites
Invites Create
Invites Create
organizationsinvites
Invites Delegate Create
Create an onboarding delegation invite: an admin-level invite flagged as a setup delegation. Sends a single dedicated delegation email and records the inviting user as having delegated.
organizationsinvites
Invites Destroy
Invites Destroy
organizationsinvites
Invites List
Invites List
organizationsinvites
Js Snippet Resolve Retrieve
Preview what a given pin would resolve to, without saving it.
js-snippet
Js Snippet Version Partial Update
Update the team's version pin.
js-snippet
Js Snippet Version Retrieve
Return the team's current version pin and resolved version.
js-snippet
Legal Documents Create
Legal Documents Create
organizationslegal_documents
Legal Documents Destroy
Delete an unsigned legal document. The PandaDoc envelope is voided first so the original signer can no longer complete it; only if that succeeds is the row removed, freeing the unique-per-org-per-type constraint so a fresh document can be generated. Returns 503 if the PandaDoc void fails — the row stays in that case and the frontend should prompt the user to retry. Returns 403 for signed documents (legal artifacts; staff can still delete signed rows from Django admin).
organizationslegal_documents
Legal Documents Download Retrieve
Short-lived redirect to the signed PDF in object storage. 404 while the envelope is still out for signature (or if the upload hasn't completed yet). The underlying presigned URL expires in ~60s; clients should hit this endpoint each time they want to view the PDF rather than caching.
organizationslegal_documents
Legal Documents List
Legal Documents List
organizationslegal_documents
Legal Documents Retrieve
Legal Documents Retrieve
organizationslegal_documents
List
List
organizationsorganizations
Get active breakpoints (External API)
External API endpoint for client applications to fetch active breakpoints using Project API key. This endpoint allows external client applications (like Python scripts, Node.js apps, etc.) to fetch the list of active breakpoints so they can instrument their code accordingly. Authentication: Requires a Project API Key in the Authorization header: `Authorization: Bearer phs_<your-project-api-key>`. You can find your Project API Key in PostHog at: Settings → Project → Project API Key
live_debugger_breakpoints
Get breakpoint hits
Retrieve breakpoint hit events from ClickHouse with optional filtering and pagination. Returns hit events containing stack traces, local variables, and execution context from your application's runtime. Security: Breakpoint IDs are filtered to only include those belonging to the current team.
live_debugger_breakpoints
Live Debugger Breakpoints Create
Create, Read, Update and Delete breakpoints for live debugging.
live_debugger_breakpoints
Live Debugger Breakpoints Destroy
Create, Read, Update and Delete breakpoints for live debugging.
live_debugger_breakpoints
Live Debugger Breakpoints List
Create, Read, Update and Delete breakpoints for live debugging.
live_debugger_breakpoints
Live Debugger Breakpoints Partial Update
Create, Read, Update and Delete breakpoints for live debugging.
live_debugger_breakpoints
Live Debugger Breakpoints Retrieve
Create, Read, Update and Delete breakpoints for live debugging.
live_debugger_breakpoints
Live Debugger Breakpoints Update
Create, Read, Update and Delete breakpoints for live debugging.
live_debugger_breakpoints
Llm Analytics Clustering Config List
Team-level clustering configuration (event filters for automated pipelines).
llm_analytics
Llm Analytics Clustering Config Set Event Filters Create
Team-level clustering configuration (event filters for automated pipelines).
llm_analytics
Llm Analytics Clustering Jobs Create
CRUD for clustering job configurations (max 10 per team).
llm_analytics
Llm Analytics Clustering Jobs Destroy
CRUD for clustering job configurations (max 10 per team).
llm_analytics
Llm Analytics Clustering Jobs List
CRUD for clustering job configurations (max 10 per team).
llm_analytics
Llm Analytics Clustering Jobs Partial Update
CRUD for clustering job configurations (max 10 per team).
llm_analytics
Llm Analytics Clustering Jobs Retrieve
CRUD for clustering job configurations (max 10 per team).
llm_analytics
Llm Analytics Clustering Jobs Update
CRUD for clustering job configurations (max 10 per team).
llm_analytics
Llm Analytics Evaluation Config Retrieve
Get the evaluation config for this team
llm_analytics
Llm Analytics Evaluation Config Set Active Key Create
Set the active provider key for evaluations
llm_analytics
Llm Analytics Evaluation Reports Create
CRUD for evaluation report configurations + report run history.
llm_analytics
Llm Analytics Evaluation Reports Destroy
Evaluation report configs are deleted only when their evaluation is deleted. Use PATCH enabled=false to stop delivery.
llm_analytics
Llm Analytics Evaluation Reports Generate Create
Trigger immediate report generation.
llm_analytics
Llm Analytics Evaluation Reports List
CRUD for evaluation report configurations + report run history.
llm_analytics
Llm Analytics Evaluation Reports Partial Update
CRUD for evaluation report configurations + report run history.
llm_analytics
Llm Analytics Evaluation Reports Retrieve
CRUD for evaluation report configurations + report run history.
llm_analytics
Llm Analytics Evaluation Reports Runs List
List report runs (history) for this report.
llm_analytics
Llm Analytics Evaluation Reports Update
CRUD for evaluation report configurations + report run history.
llm_analytics
Llm Analytics Evaluation Summary Create
Generate an AI-powered summary of evaluation results. This endpoint analyzes evaluation runs and identifies patterns in passing and failing evaluations, providing actionable recommendations. Data is fetched server-side by evaluation ID to ensure data integrity. **Use Cases:** - Understand why evaluations are passing or failing - Identify systematic issues in LLM responses - Get recommendations for improving response quality - Review patterns across many evaluation runs at once
AI observabilityllm_analytics
Llm Analytics Models Retrieve
List available models for a provider.
llm_analytics
Llm Analytics Offline Evaluations Experiment Items Create
Llm Analytics Offline Evaluations Experiment Items Create
AI observabilityllm_analytics
Llm Analytics Parser Recipes Create
Llm Analytics Parser Recipes Create
llm_analytics
Llm Analytics Parser Recipes Destroy
Llm Analytics Parser Recipes Destroy
llm_analytics
Llm Analytics Parser Recipes List
Llm Analytics Parser Recipes List
llm_analytics
Llm Analytics Parser Recipes Partial Update
Llm Analytics Parser Recipes Partial Update
llm_analytics
Llm Analytics Parser Recipes Retrieve
Llm Analytics Parser Recipes Retrieve
llm_analytics
Llm Analytics Personal Spend List
Return a structured personal LLM spend analysis for the requesting user. Pass `date_from` / `date_to` (absolute like `2026-04-23` or relative like `-7d`) to bound the window — defaults to the last 30 days, max 90 days. The `product=<ai_product>` query param is required and scopes the tool / model / day / trace breakdowns to a single product; supported values: posthog_code. `by_product` is always returned for cross-product visibility. `by_day` returns a day-ascending spend series for the scoped product. Use `refresh=true` to bypass the 5-minute response cache.
AI observabilityllm_analytics
Llm Analytics Provider Key Validations Create
Validate LLM provider API keys without persisting them
llm_analytics
Llm Analytics Provider Keys Assign Create
Assign this key to evaluations and optionally re-enable them.
llm_analytics
Llm Analytics Provider Keys Create
Llm Analytics Provider Keys Create
llm_analytics
Llm Analytics Provider Keys Dependent Configs Retrieve
Get evaluations using this key and alternative keys for replacement.
llm_analytics
Llm Analytics Provider Keys Destroy
Llm Analytics Provider Keys Destroy
llm_analytics
Llm Analytics Provider Keys List
Llm Analytics Provider Keys List
llm_analytics
Llm Analytics Provider Keys Partial Update
Llm Analytics Provider Keys Partial Update
llm_analytics
Llm Analytics Provider Keys Retrieve
Llm Analytics Provider Keys Retrieve
llm_analytics
Llm Analytics Provider Keys Trial Evaluations Retrieve
List enabled evaluations currently using trial credits for a given provider.
llm_analytics
Llm Analytics Provider Keys Update
Llm Analytics Provider Keys Update
llm_analytics
Llm Analytics Provider Keys Validate Create
Llm Analytics Provider Keys Validate Create
llm_analytics
Llm Analytics Review Queue Items Create
Llm Analytics Review Queue Items Create
llm_analytics
Llm Analytics Review Queue Items Destroy
Llm Analytics Review Queue Items Destroy
llm_analytics
Llm Analytics Review Queue Items List
Llm Analytics Review Queue Items List
llm_analytics
Llm Analytics Review Queue Items Partial Update
Llm Analytics Review Queue Items Partial Update
llm_analytics
Llm Analytics Review Queue Items Retrieve
Llm Analytics Review Queue Items Retrieve
llm_analytics
Llm Analytics Review Queues Create
Llm Analytics Review Queues Create
llm_analytics
Llm Analytics Review Queues Destroy
Llm Analytics Review Queues Destroy
llm_analytics
Llm Analytics Review Queues List
Llm Analytics Review Queues List
llm_analytics
Llm Analytics Review Queues Partial Update
Llm Analytics Review Queues Partial Update
llm_analytics
Llm Analytics Review Queues Retrieve
Llm Analytics Review Queues Retrieve
llm_analytics
Llm Analytics Score Definitions Create
Llm Analytics Score Definitions Create
llm_analytics
Llm Analytics Score Definitions List
Llm Analytics Score Definitions List
llm_analytics
Llm Analytics Score Definitions New Version Create
Llm Analytics Score Definitions New Version Create
llm_analytics
Llm Analytics Score Definitions Partial Update
Llm Analytics Score Definitions Partial Update
llm_analytics
Llm Analytics Score Definitions Retrieve
Llm Analytics Score Definitions Retrieve
llm_analytics
Llm Analytics Summarization Batch Check Create
Check which traces have cached summaries available. This endpoint allows batch checking of multiple trace IDs to see which ones have cached summaries. Returns only the traces that have cached summaries with their titles. **Use Cases:** - Load cached summaries on session view load - Avoid unnecessary LLM calls for already-summarized traces - Display summary previews without generating new summaries
AI observabilityllm_analytics
Llm Analytics Summarization Create
Generate an AI-powered summary of an LLM trace or event. This endpoint analyzes the provided trace/event, generates a line-numbered text representation, and uses an LLM to create a concise summary with line references. **Two ways to use this endpoint:** 1. **By ID (recommended):** Pass `trace_id` or `generation_id` with an optional `date_from`/`date_to`. The backend fetches the data automatically. `summarize_type` is inferred. 2. **By data:** Pass the full trace/event data blob in `data` with `summarize_type`. This is how the frontend uses it. **Summary Format:** - Title (concise, max 10 words) - Mermaid flow diagram showing the main flow - 3-10 summary bullets with line references - "Interesting Notes" section for failures, successes, or unusual patterns - Line references in [L45] or [L45-52] format pointing to relevant sections The response includes the structured summary, the text representation, and metadata.
AI observabilityllm_analytics
Llm Analytics Text Repr Create
Generate a human-readable text representation of an LLM trace event. This endpoint converts AI observability events ($ai_generation, $ai_span, $ai_embedding, or $ai_trace) into formatted text representations suitable for display, logging, or analysis. **Supported Event Types:** - `$ai_generation`: Individual LLM API calls with input/output messages - `$ai_span`: Logical spans with state transitions - `$ai_embedding`: Embedding generation events (text input → vector) - `$ai_trace`: Full traces with hierarchical structure **Options:** - `max_length`: Maximum character count (default: 2000000) - `truncated`: Enable middle-content truncation within events (default: true) - `truncate_buffer`: Characters at start/end when truncating (default: 1000) - `include_markers`: Use interactive markers vs plain text indicators (default: true) - Frontend: set true for `<<<TRUNCATED|base64|...>>>` markers - Backend/LLM: set false for `... (X chars truncated) ...` text - `collapsed`: Show summary vs full trace tree (default: false) - `include_hierarchy`: Include tree structure for traces (default: true) - `max_depth`: Maximum depth for hierarchical rendering (default: unlimited) - `tools_collapse_threshold`: Number of tools before auto-collapsing list (default: 5) - Tool lists >5 items show `<<<TOOLS_EXPANDABLE|...>>>` marker for frontend - Or `[+] AVAILABLE TOOLS: N` for backend when `include_markers: false` - `include_line_numbers`: Prefix each line with line number like L001:, L010: (default: false) **Use Cases:** - Frontend display: `truncated: true, include_markers: true, include_line_numbers: true` - Backend LLM context (summary): `truncated: true, include_markers: false, collapsed: true` - Backend LLM context (full): `truncated: false` The response includes the formatted text and metadata about the rendering.
AI observabilityllm_analytics
Llm Analytics Trace Reviews Create
Llm Analytics Trace Reviews Create
llm_analytics
Llm Analytics Trace Reviews Destroy
Llm Analytics Trace Reviews Destroy
llm_analytics
Llm Analytics Trace Reviews List
Llm Analytics Trace Reviews List
llm_analytics
Llm Analytics Trace Reviews Partial Update
Llm Analytics Trace Reviews Partial Update
llm_analytics
Llm Analytics Trace Reviews Retrieve
Llm Analytics Trace Reviews Retrieve
llm_analytics
Llm Analytics Translate Create
Translate text to target language.
llm_analytics
Llm Prompts Create
Llm Prompts Create
llm_prompts
Llm Prompts List
Llm Prompts List
llm_prompts
Llm Prompts Name Archive Create
Llm Prompts Name Archive Create
llm_prompts
Llm Prompts Name Duplicate Create
Llm Prompts Name Duplicate Create
llm_prompts
Llm Prompts Name Partial Update
Llm Prompts Name Partial Update
llm_prompts
Llm Prompts Name Retrieve
Llm Prompts Name Retrieve
llm_prompts
Llm Prompts Resolve Name Retrieve
Llm Prompts Resolve Name Retrieve
llm_prompts
Llm Skills Create
Llm Skills Create
llm_skills
Llm Skills Import Create
Llm Skills Import Create
llm_skills
Llm Skills List
Llm Skills List
llm_skills
Llm Skills Marketplace Install Command Create
Mint the user's read-only marketplace credential (or rotate it) and return the install command. Per-user: rotating only ever invalidates this user's own credential, never a teammate's.
llm_skills
Llm Skills Marketplace Install Command Retrieve
Report whether the user already has a marketplace credential, without minting one. The token is unrecoverable, so an existing credential returns its mask only — the UI shows "already connected, existing setups keep working" and offers an explicit rotate.
llm_skills
Llm Skills Name Archive Create
Llm Skills Name Archive Create
llm_skills
Llm Skills Name Duplicate Create
Llm Skills Name Duplicate Create
llm_skills
Llm Skills Name Export Retrieve
Llm Skills Name Export Retrieve
llm_skills
Llm Skills Name Files Create
Llm Skills Name Files Create
llm_skills
Llm Skills Name Files Destroy
Llm Skills Name Files Destroy
llm_skills
Llm Skills Name Files Rename Create
Llm Skills Name Files Rename Create
llm_skills
Llm Skills Name Files Retrieve
Llm Skills Name Files Retrieve
llm_skills
Llm Skills Name Partial Update
Llm Skills Name Partial Update
llm_skills
Llm Skills Name Retrieve
Llm Skills Name Retrieve
llm_skills
Llm Skills Resolve Name Retrieve
Llm Skills Resolve Name Retrieve
llm_skills
Logs Alerts Create
Logs Alerts Create
logs
Logs Alerts Destinations Create
Create a notification destination for this alert. One HogFunction is created per alert event kind (firing, resolved, ...) atomically.
logs
Logs Alerts Destinations Delete Create
Delete a notification destination by deleting its HogFunction group atomically.
logs
Logs Alerts Destroy
Logs Alerts Destroy
logs
Logs Alerts Events List
Paginated event history for this alert, newest first. Returns state transitions, errored checks, and user-initiated control-plane rows (reset, enable/disable, snooze/unsnooze, threshold change) — quiet no-op check rows (where state didn't change and there was no error) are filtered out since only the last 10 are kept and they carry no forensic value. Optional `?kind=...` narrows to a single kind.
logs
Logs Alerts List
Logs Alerts List
logs
Logs Alerts Partial Update
Logs Alerts Partial Update
logs
Logs Alerts Reset Create
Reset a broken alert. Clears the consecutive-failure counter and schedules an immediate recheck.
logs
Logs Alerts Retrieve
Logs Alerts Retrieve
logs
Logs Alerts Simulate Create
Simulate a logs alert on historical data using the full state machine. Read-only — no alert check records are created.
logs
Logs Alerts Update
Logs Alerts Update
logs
Logs Attributes Retrieve
Logs Attributes Retrieve
logs
Logs Count Create
Logs Count Create
logs
Logs Count Ranges Create
Logs Count Ranges Create
logs
Logs ExplainLogWithAI Create
Explain a log entry using AI. POST /api/environments/:id/logs/explainLogWithAI/
logs
Logs Export Create
Logs Export Create
logs
Logs Facet Values Create
Logs Facet Values Create
logs
Logs Group By Create
Logs Group By Create
logs
Logs Has Logs Retrieve
Logs Has Logs Retrieve
logs
Logs Patterns Create
Logs Patterns Create
logs
Logs Query Create
Logs Query Create
logs
Logs Sampling Rules Create
Logs Sampling Rules Create
logs
Logs Sampling Rules Destroy
Logs Sampling Rules Destroy
logs
Logs Sampling Rules List
Logs Sampling Rules List
logs
Logs Sampling Rules Partial Update
Logs Sampling Rules Partial Update
logs
Logs Sampling Rules Reorder Create
Atomically reassign priorities so the given ID order maps to ascending priorities (0..n-1).
logs
Logs Sampling Rules Retrieve
Logs Sampling Rules Retrieve
logs
Logs Sampling Rules Simulate Create
Dry-run estimate for how much volume this rule would remove (placeholder response until CH-backed simulation is wired).
logs
Logs Sampling Rules Update
Logs Sampling Rules Update
logs
Logs Services Create
Logs Services Create
logs
Logs Sparkline Create
Logs Sparkline Create
logs
Logs Values Retrieve
Logs Values Retrieve
logs
Logs Views Create
Logs Views Create
logs
Logs Views Destroy
Logs Views Destroy
logs
Logs Views List
Logs Views List
logs
Logs Views Partial Update
Logs Views Partial Update
logs
Logs Views Retrieve
Logs Views Retrieve
logs
Logs Views Update
Logs Views Update
logs
Managed Viewsets Retrieve
Get all views associated with a specific managed viewset. GET /api/environments/{team_id}/managed_viewsets/{kind}/
managed_viewsets
Managed Viewsets Update
Enable or disable a managed viewset by kind. PUT /api/environments/{team_id}/managed_viewsets/{kind}/ with body {"enabled": true/false}
managed_viewsets
List conversion goals
Read the configured conversion goals for the current project — each with its kind, target, last-30d count, integrated vs non-integrated split, and a misconfiguration flag. Read-only.
marketing_analytics
List marketing data sources
Check the platform → data-warehouse side of every native marketing integration: connection state, sync recency, row counts, required-table status, and schema-mapping coverage. Read-only.
marketing_analytics
Diagnose marketing analytics
Aggregate data-source sync health, UTM attribution health, and conversion-goal config into a single per-integration diagnostic with recommended actions. Read-only.
marketing_analytics
Explain a conversion goal
Break down a single conversion goal's events over a period by event name, utm_source, and matched integration, with a small sample of events. Read-only.
marketing_analytics
Suggest conversion goals
Rank existing custom events as conversion-goal candidates by volume, UTM-tag coverage, and unique users, excluding system/autocaptured events. Read-only.
marketing_analytics
Suggest UTM source mappings
Detect unmatched utm_source values from recent events and propose custom_source_mappings entries, alongside the full utm_source catalogue and current mappings. Read-only.
marketing_analytics
Marketing Analytics Test Mapping Create
Marketing Analytics Test Mapping Create
marketing_analytics
Run UTM audit
Cross-reference campaigns with spend from ad platforms against pageview events with UTM parameters to identify tracking issues.
marketing_analytics
Max Tools Create And Query Insight Create
Max Tools Create And Query Insight Create
max_tools
Mcp Analytics Feedback Create
Create a new MCP feedback submission for the current project.
mcp_analytics
Mcp Analytics Feedback List
List MCP feedback submissions for the current project, newest first.
mcp_analytics
Mcp Analytics Intent Clusters Recompute
Trigger an asynchronous recompute of the intent cluster snapshot. The task runs in the background; poll the GET endpoint for progress (status transitions to 'idle' or 'error').
mcp_analytics
Mcp Analytics Intent Clusters Retrieve
Return the most recent intent cluster snapshot for the current project. Returns an empty IDLE snapshot when no clustering run has happened yet.
mcp_analytics
Mcp Analytics Missing Capabilities Create
Create a new missing capability report for the current project.
mcp_analytics
Mcp Analytics Missing Capabilities List
List missing capability reports for the current project, newest first.
mcp_analytics
Mcp Analytics Sessions Activity Overview
Aggregate counters, top tools, agent clients, and the most recent tool calls for the last 30 days, computed in one request. Powers the dashboard's activity view; always computed fresh so polling callers watch data arrive.
mcp_analytics
Mcp Analytics Sessions Generate Intent
Generate (or return the cached) LLM summary of the agent's goal for a session, derived from its recorded $mcp_intents. The first call summarises and persists the result; subsequent calls return the stored summary.
mcp_analytics
Mcp Analytics Sessions Intent Digest
Generate (or return the cached) LLM digest of what agents are trying to do with this MCP server, derived from the most recent recorded $mcp_intents across all sessions. Content-addressed cache: only regenerates when new intents arrive. Powers the dashboard's low-volume activity stage.
mcp_analytics
Mcp Analytics Sessions List
List MCP sessions for the current project, derived by grouping $mcp_tool_call events by $mcp_session_id. Ordered by newest session start first by default.
mcp_analytics
Mcp Analytics Sessions Tool Calls
List a page of the $mcp_tool_call events that belong to a given $session_id, in chronological order.
mcp_analytics
Mcp Server Installations Authorize Retrieve
Start (or re-start) an OAuth flow. Pass ``template_id`` to (re)connect a catalog template, or ``installation_id`` to reconnect an existing custom install using its cached metadata and per-user DCR creds.
mcp_server_installations
Mcp Server Installations Create
Mcp Server Installations Create
mcp_server_installations
Mcp Server Installations Destroy
Mcp Server Installations Destroy
mcp_server_installations
Mcp Server Installations Install Custom Create
Mcp Server Installations Install Custom Create
mcp_server_installations
Mcp Server Installations Install Template Create
Mcp Server Installations Install Template Create
mcp_server_installations
Mcp Server Installations List
Mcp Server Installations List
mcp_server_installations
Mcp Server Installations Partial Update
Mcp Server Installations Partial Update
mcp_server_installations
Mcp Server Installations Proxy Create
Mcp Server Installations Proxy Create
mcp_server_installations
Mcp Server Installations Retrieve
Mcp Server Installations Retrieve
mcp_server_installations
Mcp Server Installations Tools Partial Update
Mcp Server Installations Tools Partial Update
mcp_server_installations
Mcp Server Installations Tools Refresh Create
Mcp Server Installations Tools Refresh Create
mcp_server_installations
Mcp Server Installations Tools Retrieve
Mcp Server Installations Tools Retrieve
mcp_server_installations
Mcp Server Installations Update
Mcp Server Installations Update
mcp_server_installations
Mcp Servers List
Lists curated MCP server templates that users can install with one click. Templates are seeded by PostHog operators and carry shared, encrypted OAuth client credentials. Inactive templates are hidden from the catalog.
mcp_servers
Mcp Tools Create
Invoke an MCP tool by name. This endpoint allows MCP callers to invoke Max AI tools directly without going through the full LangChain conversation flow. Scopes are resolved dynamically per tool via dangerously_get_required_scopes.
mcp_tools
Members Destroy
Members Destroy
organizationsmembers
Members Github Login Retrieve
Members Github Login Retrieve
organizationsmembers
Members List
Members List
organizationsmembers
Members Partial Update
Members Partial Update
organizationsmembers
Members Scoped Api Keys Retrieve
Members Scoped Api Keys Retrieve
organizationsmembers
Members Update
Members Update
organizationsmembers
Messaging Templates Create
Messaging Templates Create
messaging_templates
Messaging Templates Design Partial Update
Messaging Templates Design Partial Update
messaging_templates
Messaging Templates Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
messaging_templates
Messaging Templates List
Messaging Templates List
messaging_templates
Messaging Templates Partial Update
Messaging Templates Partial Update
messaging_templates
Messaging Templates Retrieve
Messaging Templates Retrieve
messaging_templates
Messaging Templates Update
Messaging Templates Update
messaging_templates
Metrics Characterize Create
Characterize a metric anomaly: compare an anomaly window against a baseline, find the onset, and rank which label values moved.
metricsmetrics
Metrics Has Metrics Retrieve
Metrics Has Metrics Retrieve
metricsmetrics
Metrics Query Create
Metrics Query Create
metricsmetrics
Metrics Samples Create
Raw individual emissions for a metric (the events model), newest first — backs the Samples view and the metric->trace pivot.
metricsmetrics
Metrics Values Retrieve
Distinct metric names for the team. Backs the picker UI.
metricsmetrics
Notebooks Activity Retrieve
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks All Activity Retrieve
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Collab Markdown Save Create
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Collab Presence Create
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Collab Save Create
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Collab Stream Retrieve
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Create
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
notebooks
Notebooks Hogql Execute Create
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Kernel Config Create
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Kernel Dataframe Retrieve
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Kernel Execute Create
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Kernel Execute Stream Create
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Kernel Restart Create
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Kernel Start Create
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Kernel Status Retrieve
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Kernel Stop Create
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks List
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Partial Update
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Recording Comments Retrieve
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Retrieve
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Notebooks Sharing List
Notebooks Sharing List
notebooks
Notebooks Sharing Passwords Create
Create a new password for the sharing configuration.
notebooks
Notebooks Sharing Passwords Destroy
Delete a password from the sharing configuration.
notebooks
Notebooks Sharing Refresh Create
Notebooks Sharing Refresh Create
notebooks
Notebooks Update
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
notebooks
Oauth Applications List
ViewSet for listing OAuth applications at the organization level (read-only).
organizationsoauth_applications
Object Media Previews Create
Object Media Previews Create
object_media_previews
Object Media Previews Destroy
Object Media Previews Destroy
object_media_previews
Object Media Previews List
Object Media Previews List
object_media_previews
Object Media Previews Partial Update
Object Media Previews Partial Update
object_media_previews
Object Media Previews Preferred For Event Retrieve
Get the preferred media preview for an event definition. Most recent user-uploaded, then most recent exported asset. Requires event_definition (query param).
object_media_previews
Object Media Previews Retrieve
Object Media Previews Retrieve
object_media_previews
Object Media Previews Update
Object Media Previews Update
object_media_previews
Org Organization Integrations Destroy
ViewSet for organization-level integrations. Provides access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc. Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Users can disconnect integrations via the DELETE endpoint.
organizationsintegrations
Org Organizations Advanced Activity Logs Available Filters Retrieve
Organization-wide view of activity logs across every project in the organization. Mounted at /api/organizations/<organization_id>/advanced_activity_logs/. Restricted to organization admins and owners.
activity_logsadvanced_activity_logs
Org Organizations Advanced Activity Logs Export Create
Organization-wide view of activity logs across every project in the organization. Mounted at /api/organizations/<organization_id>/advanced_activity_logs/. Restricted to organization admins and owners.
activity_logsadvanced_activity_logs
Org Organizations Advanced Activity Logs List
Organization-wide view of activity logs across every project in the organization. Mounted at /api/organizations/<organization_id>/advanced_activity_logs/. Restricted to organization admins and owners.
activity_logsadvanced_activity_logs
Org Organizations Batch Exports Create
Org Organizations Batch Exports Create
batch_exportsbatch_exports
Org Organizations Batch Exports Destroy
Org Organizations Batch Exports Destroy
batch_exportsbatch_exports
Org Organizations Batch Exports List
Org Organizations Batch Exports List
batch_exportsbatch_exports
Org Organizations Batch Exports Logs Retrieve
Org Organizations Batch Exports Logs Retrieve
batch_exportsbatch_exports
Org Organizations Batch Exports Partial Update
Org Organizations Batch Exports Partial Update
batch_exportsbatch_exports
Org Organizations Batch Exports Pause Create
Pause a BatchExport.
batch_exportsbatch_exports
Org Organizations Batch Exports Retrieve
Org Organizations Batch Exports Retrieve
batch_exportsbatch_exports
Org Organizations Batch Exports Run Test Step Create
Org Organizations Batch Exports Run Test Step Create
batch_exportsbatch_exports
Org Organizations Batch Exports Run Test Step New Create
Org Organizations Batch Exports Run Test Step New Create
batch_exportsbatch_exports
Org Organizations Batch Exports Test Retrieve
Org Organizations Batch Exports Test Retrieve
batch_exportsbatch_exports
Org Organizations Batch Exports Unpause Create
Unpause a BatchExport.
batch_exportsbatch_exports
Org Organizations Batch Exports Update
Org Organizations Batch Exports Update
batch_exportsbatch_exports
Org Organizations Integrations List
ViewSet for organization-level integrations. Provides access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc. Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Users can disconnect integrations via the DELETE endpoint.
organizationsintegrations
Org Organizations Integrations Retrieve
ViewSet for organization-level integrations. Provides access to integrations that are scoped to the entire organization (vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc. Creation is handled by the integration installation flows (e.g., Vercel marketplace installation). Users can disconnect integrations via the DELETE endpoint.
organizationsintegrations
Organizations Projects Activity Retrieve
Projects for the current organization.
organizationsprojects
Organizations Projects Add Product Intent Partial Update
Projects for the current organization.
organizationsprojects
Organizations Projects Change Organization Create
Projects for the current organization.
organizationsprojects
Organizations Projects Complete Product Onboarding Partial Update
Projects for the current organization.
organizationsprojects
Organizations Projects Create
Projects for the current organization.
organizationsprojects
Organizations Projects Default Evaluation Contexts Create
Manage default evaluation contexts for a project.
organizationsprojects
Organizations Projects Default Evaluation Contexts Destroy
Manage default evaluation contexts for a project.
organizationsprojects
Organizations Projects Default Evaluation Contexts Retrieve
Manage default evaluation contexts for a project.
organizationsprojects
Organizations Projects Default Release Conditions Retrieve
Manage default release conditions for new feature flags in this project.
organizationsprojects
Organizations Projects Default Release Conditions Update
Manage default release conditions for new feature flags in this project.
organizationsprojects
Organizations Projects Delete Secret Token Backup Partial Update
Projects for the current organization.
organizationsprojects
Organizations Projects Destroy
Projects for the current organization.
organizationsprojects
Organizations Projects Evaluation Context Suggestions Create
Hide an evaluation context name from the flag editor's suggestion list, or restore it. POST hides the name; DELETE restores it. The underlying context row and any flags already using it are never modified — this only controls what gets suggested.
organizationsprojects
Organizations Projects Evaluation Context Suggestions Destroy
Hide an evaluation context name from the flag editor's suggestion list, or restore it. POST hides the name; DELETE restores it. The underlying context row and any flags already using it are never modified — this only controls what gets suggested.
organizationsprojects
Organizations Projects Event Ingestion Restrictions Retrieve
Projects for the current organization.
organizationsprojects
Organizations Projects Experiments Config Partial Update
Manage experiment configuration for this project.
organizationsprojects
Organizations Projects Experiments Config Retrieve
Manage experiment configuration for this project.
organizationsprojects
Organizations Projects Generate Conversations Public Token Create
Projects for the current organization.
organizationsprojects
Organizations Projects Is Generating Demo Data Retrieve
Projects for the current organization.
organizationsprojects
Organizations Projects List
Projects for the current organization.
organizationsprojects
Organizations Projects Logs Config Partial Update
Manage logs product configuration for this project's canonical environment. Mirrors the env-router action so /api/projects/:id/logs_config/ resolves alongside the legacy /api/environments/:id/logs_config/ alias.
organizationsprojects
Organizations Projects Logs Config Retrieve
Manage logs product configuration for this project's canonical environment. Mirrors the env-router action so /api/projects/:id/logs_config/ resolves alongside the legacy /api/environments/:id/logs_config/ alias.
organizationsprojects
Organizations Projects Partial Update
Update one or more of a project's settings. Only the fields included in the request body are changed.
organizationsprojects
Organizations Projects Reset Token Partial Update
Projects for the current organization.
organizationsprojects
Organizations Projects Retrieve
Retrieve a project and its settings.
organizationsprojects
Organizations Projects Rotate Secret Token Partial Update
Projects for the current organization.
organizationsprojects
Organizations Projects Settings As Of Retrieve
Return the project settings as of the provided timestamp. Query params: - at: ISO8601 datetime (required) - scope: optional, one or multiple keys to filter the returned settings
organizationsprojects
Organizations Projects Update
Replace a project and its settings. Prefer the PATCH endpoint for partial updates — PUT requires every writable field to be provided.
organizationsprojects
Partial Update
Partial Update
organizationsorganizations
Persons Activity Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons All Activity Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Batch By Distinct Ids Create
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Batch By Uuids Create
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Bulk Delete Create
This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted.
persons
Persons Cohorts Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Delete Property Create
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Deletion Status List
List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed.
persons
Persons Emails List
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Funnel Create
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Funnel Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Lifecycle Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons List
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Partial Update
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Properties At Time Retrieve
Get person properties as they existed at a specific point in time. This endpoint reconstructs person properties by querying ClickHouse events for $set and $set_once operations up to the specified timestamp. Query parameters: - distinct_id: The distinct_id of the person - timestamp: ISO datetime string for the point in time (e.g., "2023-06-15T14:30:00Z") - include_set_once: Whether to handle $set_once operations (default: false)
personspersons
Persons Properties Timeline Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Reset Person Distinct Id Create
Reset a distinct_id for a deleted person. This allows the distinct_id to be used again.
persons
Persons Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Split Create
Split distinct_ids off a merged person. Two mutually exclusive modes: - **`distinct_ids_to_split`** (recommended for surgical edits): moves only the listed distinct_ids off this person onto new single-id persons. The original person keeps every other distinct_id and its properties. - **`main_distinct_id`**: keeps only the specified distinct_id on this person; moves every *other* distinct_id off onto its own new person. If omitted, the first distinct_id is kept. The original person always retains its properties. To clear individual properties afterward, use the `delete_property` endpoint. The split runs asynchronously: a 201 response means the task was enqueued. Newly-created split-off persons get a deterministic UUID derived from `(team_id, distinct_id)`, so they can be located client-side without polling. If you need to delete a split-off person after this call, prefer looking it up by that deterministic UUID rather than by distinct_id, since the latter still resolves to the original merged person until the async task completes.
persons
Persons Trends Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Update
Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. This means that only the properties listed will be updated, but other properties won't be removed nor updated. If you would like to remove a property use the `delete_property` endpoint.
persons
Persons Update Property Create
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Persons Values Retrieve
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
persons
Plugin Configs Logs List
Plugin Configs Logs List
plugin_configs
Product Enablement Create
Product Enablement Create
product_enablement
Product Tours Create
Product Tours Create
product_tours
Product Tours Destroy
Product Tours Destroy
product_tours
Product Tours Discard Draft Destroy
Discard draft content.
product_tours
Product Tours Draft Partial Update
Save draft content (server-side merge). No side effects triggered.
product_tours
Product Tours Draft Status Retrieve
Lightweight polling endpoint for draft change detection.
product_tours
Product Tours Generate Create
Generate tour step content using AI.
product_tours
Product Tours List
Product Tours List
product_tours
Product Tours Partial Update
Product Tours Partial Update
product_tours
Product Tours Publish Draft Create
Commit draft to live tour. Runs full validation and triggers side effects. Accepts an optional body payload. If provided, merges it into the draft before publishing so the caller can save + publish in a single request.
product_tours
Product Tours Retrieve
Product Tours Retrieve
product_tours
Product Tours Update
Product Tours Update
product_tours
Project Secret Api Keys Create
Project Secret Api Keys Create
project_secret_api_keys
Project Secret Api Keys Destroy
Project Secret Api Keys Destroy
project_secret_api_keys
Project Secret Api Keys List
Project Secret Api Keys List
project_secret_api_keys
Project Secret Api Keys Partial Update
Project Secret Api Keys Partial Update
project_secret_api_keys
Project Secret Api Keys Retrieve
Project Secret Api Keys Retrieve
project_secret_api_keys
Project Secret Api Keys Roll Create
Roll a project secret API key
project_secret_api_keys
Project Secret Api Keys Update
Project Secret Api Keys Update
project_secret_api_keys
Property Access Controls Create
Create or update a property access control rule.
property_access_controls
Property Access Controls Destroy
Delete a property access control rule. The rule is identified by `property_definition_id` plus an optional `organization_member` or `role` query parameter. Omitting both targets deletes the default rule.
property_access_controls
Property Access Controls Retrieve
Get all property access control rules for a property definition.
property_access_controls
Property Definitions Bulk Update Tags Create
Bulk update tags on multiple objects. PAT access: this action has no ``required_scopes=`` on the decorator — inheriting viewsets must add ``"bulk_update_tags"`` to their ``scope_object_write_actions`` list to accept personal API keys. Without that opt-in, ``APIScopePermission`` rejects PAT requests with "This action does not support personal API key access". Done per-viewset so granting ``<scope>:write`` for one resource doesn't leak access to sibling resources that share this mixin. Accepts: - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]} Actions: - "add": Add tags to existing tags on each object - "remove": Remove specific tags from each object - "set": Replace all tags on each object with the provided list
property_definitions
Property Definitions Destroy
Property Definitions Destroy
property_definitions
Property Definitions List
Property Definitions List
property_definitions
Property Definitions Partial Update
Property Definitions Partial Update
property_definitions
Property Definitions Retrieve
Property Definitions Retrieve
property_definitions
Property Definitions Seen Together Retrieve
Allows a caller to provide a list of event names and a single property name Returns a map of the event names to a boolean representing whether that property has ever been seen with that event_name
property_definitions
Property Definitions Update
Property Definitions Update
property_definitions
Proxy Records Create
Create a new managed reverse proxy. Provide the domain you want to proxy through. The response includes the CNAME target you need to add as a DNS record. Once the CNAME is configured, the proxy will be automatically verified and provisioned.
reverse_proxyproxy_records
Proxy Records Destroy
Delete a reverse proxy. For proxies in 'waiting', 'erroring', or 'timed_out' status, the record is deleted immediately. For active proxies, a deletion workflow is started to clean up the provisioned infrastructure.
reverse_proxyproxy_records
Proxy Records Diagnose Create
Run a deep diagnostic on a reverse proxy. Inspects DNS CNAME alignment, the certificate provider's hostname state, CAA records walked up the customer's DNS tree, HTTP-01 challenge reachability, a live event probe, and certificate expiry. Returns a structured report with each check's status and concrete remediation steps (e.g. exact DNS records to add). Use this to debug why a proxy is stuck or erroring.
reverse_proxyproxy_records
Proxy Records List
List all reverse proxies configured for the organization. Returns proxy records along with the maximum number allowed by the current plan.
reverse_proxyproxy_records
Proxy Records Retrieve
Get details of a specific reverse proxy by ID. Returns the full configuration including domain, CNAME target, and current provisioning status.
reverse_proxyproxy_records
Proxy Records Retry Create
Retry provisioning a failed reverse proxy. Only available for proxies in 'erroring' or 'timed_out' status. Resets the proxy to 'waiting' status and restarts the provisioning workflow.
reverse_proxyproxy_records
Public Hog Function Templates List
Public Hog Function Templates List
hog_function_templatespublic_hog_function_templates
Query Check Auth For Async Create
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
query
Query Create
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
query
Query Create With Kind
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
query
Query Destroy
(Experimental)
query
Query Draft Sql Retrieve
DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.
query
Query Log Retrieve
Get query log details from query_log_archive table for a specific query_id, the query must have been issued in last 24 hours.
query
Query Retrieve
(Experimental)
query
Query Upgrade Create
Upgrades a query without executing it. Returns a query with all nodes migrated to the latest version.
query
Get a team's quota-limit state
Return the current quota-limit state for the team identified in the URL, keyed by `QuotaResource` value. Used by the LLM gateway to gate billable products on AI credits exhaustion.
quota_limitsquota_limits
Reminders Create
Reminders Create
remindersreminders
Reminders Destroy
Reminders Destroy
remindersreminders
Reminders List
Reminders List
remindersreminders
Reminders Partial Update
Reminders Partial Update
remindersreminders
Reminders Retrieve
Reminders Retrieve
remindersreminders
Reminders Update
Reminders Update
remindersreminders
Request Ai Access Create
Notify organization admins that a member is requesting PostHog AI be enabled.
organizationsrequest_ai_access
Retrieve
Retrieve
organizationsorganizations
Retrieve Session Summaries Config
Retrieve the team's session summaries configuration (product context used to tailor single-session replay summaries).
session_summaries
Role External References Create
Role External References Create
organizationsrole_external_references
Role External References Destroy
Role External References Destroy
organizationsrole_external_references
Role External References List
Role External References List
organizationsrole_external_references
Role External References Lookup Retrieve
Role External References Lookup Retrieve
organizationsrole_external_references
Roles Create
Roles Create
organizationsroles
Roles Destroy
Roles Destroy
organizationsroles
Roles List
Roles List
organizationsroles
Roles Partial Update
Roles Partial Update
organizationsroles
Roles Retrieve
Roles Retrieve
organizationsroles
Roles Role Memberships Create
Roles Role Memberships Create
organizationsroles
Roles Role Memberships Destroy
Roles Role Memberships Destroy
organizationsroles
Roles Role Memberships List
Roles Role Memberships List
organizationsroles
Roles Role Memberships Retrieve
Roles Role Memberships Retrieve
organizationsroles
Roles Update
Roles Update
organizationsroles
Sandbox Create
API for managing sandbox environments that control network access for task runs.
sandbox-environmentssandbox_environments
Sandbox Custom Images Build Create
Persist the image spec (from the request body or the builder agent's sandbox), run the security scan, and on pass build and publish the image.
sandbox-custom-imagessandbox_custom_images
Sandbox Custom Images Builder Task Create
Revive (or reuse) the image's builder agent session. When the previous session has ended, a fresh one is started seeded with the stored spec — use this to update an existing image.
sandbox-custom-imagessandbox_custom_images
Sandbox Custom Images Create
Create a draft custom image and start its interactive image-builder agent task. The returned builder_task_id points at the conversation.
sandbox-custom-imagessandbox_custom_images
Sandbox Custom Images Destroy
API for custom sandbox base images, built on top of the VM sandbox base via an image-builder agent. Custom images only run on the Modal VM runtime, so every action is gated on the `tasks-modal-vm-sandbox` flag (org-enabled with `user_created` in its origin_products payload).
sandbox-custom-imagessandbox_custom_images
Sandbox Custom Images List
API for custom sandbox base images, built on top of the VM sandbox base via an image-builder agent. Custom images only run on the Modal VM runtime, so every action is gated on the `tasks-modal-vm-sandbox` flag (org-enabled with `user_created` in its origin_products payload).
sandbox-custom-imagessandbox_custom_images
Sandbox Custom Images Retrieve
API for custom sandbox base images, built on top of the VM sandbox base via an image-builder agent. Custom images only run on the Modal VM runtime, so every action is gated on the `tasks-modal-vm-sandbox` flag (org-enabled with `user_created` in its origin_products payload).
sandbox-custom-imagessandbox_custom_images
Sandbox Destroy
API for managing sandbox environments that control network access for task runs.
sandbox-environmentssandbox_environments
Sandbox List
API for managing sandbox environments that control network access for task runs.
sandbox-environmentssandbox_environments
Sandbox Partial Update
API for managing sandbox environments that control network access for task runs.
sandbox-environmentssandbox_environments
Sandbox Retrieve
API for managing sandbox environments that control network access for task runs.
sandbox-environmentssandbox_environments
Saved Create
Create a saved heatmap for a page URL. For type 'screenshot' (the default) this enqueues a headless render of the page at each target width; poll the saved heatmap or its content endpoint until status is 'completed'. Provide 'widths' to control which viewport widths are rendered.
saved
Saved Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
saved
Saved List
List saved heatmaps for the project. A saved heatmap pins a page URL and a set of viewport widths, and (for type 'screenshot') renders the page so heatmap data can be overlaid on it.
saved
Saved Partial Update
Update a saved heatmap (e.g. rename, change widths, or soft-delete via 'deleted'). Changing the URL of a 'screenshot' heatmap triggers a re-render.
saved
Saved Query Column Annotations Create
Read and edit semantic descriptions of data-modelling views and columns surfaced to the AI agent. List can be filtered to one view with `?saved_query_id=<uuid>`. Any create or update is treated as a user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic enrichment. Create upserts on `(saved_query, column_name)`; the view cannot be changed after creation.
saved_query_column_annotations
Saved Query Column Annotations Destroy
Read and edit semantic descriptions of data-modelling views and columns surfaced to the AI agent. List can be filtered to one view with `?saved_query_id=<uuid>`. Any create or update is treated as a user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic enrichment. Create upserts on `(saved_query, column_name)`; the view cannot be changed after creation.
saved_query_column_annotations
Saved Query Column Annotations List
Read and edit semantic descriptions of data-modelling views and columns surfaced to the AI agent. List can be filtered to one view with `?saved_query_id=<uuid>`. Any create or update is treated as a user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic enrichment. Create upserts on `(saved_query, column_name)`; the view cannot be changed after creation.
saved_query_column_annotations
Saved Query Column Annotations Partial Update
Read and edit semantic descriptions of data-modelling views and columns surfaced to the AI agent. List can be filtered to one view with `?saved_query_id=<uuid>`. Any create or update is treated as a user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic enrichment. Create upserts on `(saved_query, column_name)`; the view cannot be changed after creation.
saved_query_column_annotations
Saved Query Column Annotations Retrieve
Read and edit semantic descriptions of data-modelling views and columns surfaced to the AI agent. List can be filtered to one view with `?saved_query_id=<uuid>`. Any create or update is treated as a user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic enrichment. Create upserts on `(saved_query, column_name)`; the view cannot be changed after creation.
saved_query_column_annotations
Saved Query Column Annotations Update
Read and edit semantic descriptions of data-modelling views and columns surfaced to the AI agent. List can be filtered to one view with `?saved_query_id=<uuid>`. Any create or update is treated as a user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic enrichment. Create upserts on `(saved_query, column_name)`; the view cannot be changed after creation.
saved_query_column_annotations
Saved Regenerate Create
Re-run screenshot generation for a saved heatmap of type 'screenshot'. Clears existing renders and re-renders at every target width; status returns to 'processing'.
saved
Saved Retrieve
Get a single saved heatmap by its short_id, including per-width render status.
saved
Scheduled Changes Create
Create, read, update and delete scheduled changes.
scheduled_changes
Scheduled Changes Destroy
Create, read, update and delete scheduled changes.
scheduled_changes
Scheduled Changes List
Create, read, update and delete scheduled changes.
scheduled_changes
Scheduled Changes Partial Update
Create, read, update and delete scheduled changes.
scheduled_changes
Scheduled Changes Retrieve
Create, read, update and delete scheduled changes.
scheduled_changes
Scheduled Changes Update
Create, read, update and delete scheduled changes.
scheduled_changes
Schema Property Groups Create
Schema Property Groups Create
schema_property_groups
Schema Property Groups Destroy
Schema Property Groups Destroy
schema_property_groups
Schema Property Groups List
Schema Property Groups List
schema_property_groups
Schema Property Groups Partial Update
Schema Property Groups Partial Update
schema_property_groups
Schema Property Groups Retrieve
Schema Property Groups Retrieve
schema_property_groups
Schema Property Groups Update
Schema Property Groups Update
schema_property_groups
Get SDK health report for a project
Returns a pre-digested health assessment of the PostHog SDKs the project is using. Covers which SDKs are current vs outdated (smart-semver rules with grace periods and traffic-percentage thresholds), per-version breakdown, and a human-readable reason for each assessment. Use this to diagnose SDK version issues, surface upgrade recommendations, or check overall SDK health.
sdk_healthsdk_health
Session Group Summaries Create
API for retrieving and managing stored group session summaries.
session_group_summaries
Session Group Summaries Destroy
API for retrieving and managing stored group session summaries.
session_group_summaries
Session Group Summaries List
API for retrieving and managing stored group session summaries.
session_group_summaries
Session Group Summaries Partial Update
API for retrieving and managing stored group session summaries.
session_group_summaries
Session Group Summaries Retrieve
API for retrieving and managing stored group session summaries.
session_group_summaries
Session Group Summaries Update
API for retrieving and managing stored group session summaries.
session_group_summaries
Session Recording Playlists Create
Session Recording Playlists Create
replaysession_recording_playlists
Session Recording Playlists Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
replaysession_recording_playlists
Session Recording Playlists List
Override list to include synthetic playlists. Synthetics have no DB row, so we compute each one's position in the merged sort and split the requested page between synthetics and a DB queryset slice. The merge/rank/sort is all in-memory, so each phase is wrapped in a span and the input sizes are recorded as span attributes — a slow response on a team with many playlists then shows up as a wide span against a large db_count.
replaysession_recording_playlists
Session Recording Playlists Partial Update
Session Recording Playlists Partial Update
replaysession_recording_playlists
Session Recording Playlists Recordings Create
Session Recording Playlists Recordings Create
replaysession_recording_playlists
Session Recording Playlists Recordings Destroy
Session Recording Playlists Recordings Destroy
replaysession_recording_playlists
Session Recording Playlists Recordings Retrieve
Session Recording Playlists Recordings Retrieve
replaysession_recording_playlists
Session Recording Playlists Retrieve
Session Recording Playlists Retrieve
replaysession_recording_playlists
Session Recording Playlists Update
Session Recording Playlists Update
replaysession_recording_playlists
Session Recordings Bulk Delete Create
Delete a batch of session recordings by session ID. Deletion is permanent and cannot be undone. IDs that don't match an existing recording are skipped and counted in `total_requested` but not `deleted_count`.
replaysession_recordings
Session Recordings Destroy
Session Recordings Destroy
replaysession_recordings
Session Recordings List
Session Recordings List
replaysession_recordings
Session Recordings Partial Update
Session Recordings Partial Update
replaysession_recordings
Session Recordings Retrieve
Session Recordings Retrieve
replaysession_recordings
Session Recordings Sharing List
Session Recordings Sharing List
session_recordings
Session Recordings Sharing Passwords Create
Create a new password for the sharing configuration.
session_recordings
Session Recordings Sharing Passwords Destroy
Delete a password from the sharing configuration.
session_recordings
Session Recordings Sharing Refresh Create
Session Recordings Sharing Refresh Create
session_recordings
Session Recordings Update
Session Recordings Update
replaysession_recordings
Sessions Property Definitions Retrieve
Sessions Property Definitions Retrieve
sessions
Sessions Values Retrieve
Sessions Values Retrieve
sessions
Signals Processing List
Return current processing state including pause status.
signals
Signals Processing Pause Destroy
View and control signal processing pipeline state for a team.
signals
Signals Processing Pause Update
View and control signal processing pipeline state for a team.
signals
Append an artefact to a report
Append an artefact to a report (see artefact_type for the writable types). Everything is append-only: log entries (code reference, commit, task run, note) accumulate, while status types (safety / actionability / priority judgments, repo selection, suggested reviewers) are latest-wins — appending a new version supersedes the previous one as the report's canonical status. Content is validated against the type's schema.
signals
Delete an artefact
Delete an artefact, addressed by id. Deleting the latest row of a status type reverts the report's canonical status to the previous version (latest-wins over what remains).
signals
Fetch the diff for a commit artefact
Fetch the unified diff of a `commit` artefact's branch against the repository default branch via the team's GitHub integration — using the branch's current tip so the diff reflects the latest state of the work, not just the single recorded commit.
signals
List a report's artefacts
List every artefact on a report — the full work log: signal findings (the evidence behind the report), status judgments (safety / actionability / priority, repo selection, suggested reviewers — the newest row of each status type is canonical), and log entries (code references, commits, task runs, notes). `suggested_reviewers` content is enriched with PostHog user info at read time.
signals
Replace an artefact's content
Replace the content of an existing artefact, addressed by id. The new content is validated against the artefact's type schema. Editing the latest row of a status type changes the report's canonical status (latest-wins); to re-assess while keeping history, append a new artefact instead. Attribution is creation-time only — edits don't reassign it.
signals
Get a single artefact
Get one artefact by id, content parsed (and reviewers enriched) the same way as the list.
signals
Signals Reports Bulk State Create
Transition many reports to a new state in one call. Each id is processed independently: a report whose transition isn't allowed from its current status is reported as `skipped` (a 409 on the single-report endpoint) and the rest still go through. Returns one result per requested id (in request order, after de-duplication) plus per-outcome counts. The whole call is 200 even on partial failure — inspect `results` / the counts to see what happened.
signals
Signals Reports List
Signals Reports List
signals
Edit a report's title or summary
Edit the human-facing title and/or summary (description) of a signal report, addressed by id. Both fields are optional — supply only the ones you want to change; at least one is required. Every other report field (status, weights, judgments) is managed by the signals pipeline and cannot be set here. Returns the full updated report.
signals
Signals Reports Retrieve
Signals Reports Retrieve
signals
List a report's signals
Fetch all signals for a report from ClickHouse, including full metadata.
signals
Signals Reports State Create
Transition a report to a new state. The model validates allowed transitions. The request body is validated by SignalReportStateRequestSerializer — only the fields it declares (state, dismissal_reason, dismissal_note, snooze_for) are read, and only snooze_for is ever forwarded to transition_to. Any other key is ignored, so internal transition_to kwargs (reset_weight, error, ...) can't be injected. Body: { "state": "suppressed" | "potential", # Optional dismissal feedback (honored when state == "suppressed" or "potential"): "dismissal_reason": "<canonical reason code, see SIGNAL_REPORT_DISMISSAL_REASON_CHOICES>", "dismissal_note": "free-form text", # Optional, only honored for state == "potential": "snooze_for": <number of additional signals before re-promotion>, }
signals
Create a scout config
Register the config for a `signals-scout-*` skill immediately, without waiting for the coordinator to auto-register it — optionally setting `run_interval_minutes`, `enabled`, and `emit` in the same call. The skill must already exist on this project. Upsert: if a config already exists for the skill, the provided fields are applied to it.
signals
Delete a scout config
Delete one scout config by its `id`, removing the per-(team, skill) schedule/emit row outright. The point is cleaning up an orphaned config whose `signals-scout-*` skill was archived or deleted — it lingers in `list` with an empty `description`, never runs (the coordinator skips it and the skill can't load), but can't otherwise be removed over the API. Deletion is activity-logged. Note: if the skill still exists, the coordinator re-creates a default-schedule config on its next tick — to retire a live scout, archive its skill (or set `enabled=false` to make it inert) rather than deleting the config.
signals
List scout configs
List the per-(team, skill) scout configs for this project — schedule (`run_interval_minutes`), `enabled`, and `emit` posture per scout. A freshly authored scout skill appears here once its config is registered, either explicitly via create or by the coordinator's next tick.
signals
Run a scout now
Dispatch one on-demand run of this scout immediately, regardless of its schedule. Useful to test a scout right after authoring it, or to refresh its findings on demand. The run executes asynchronously on the worker and inherits every guard the scheduled path has: it is forbidden if scouts are not enabled for the project (403), and skipped if the project is over its Signals credits quota or daily run budget (429) or a run for this scout is already in progress (409). A manual run counts against the same daily run budget as scheduled runs, so repeated manual runs of the same scout can exhaust the project's daily allowance. A manual run does not change the scout's schedule or `last_run_at`. A disabled scout can still be run this way (to test before enabling). Returns immediately with the workflow id — poll the scout's runs for the result.
signals
Sync scout configs
Materialize the scout fleet for this project on demand (idempotent): seed the canonical `signals-scout-*` skills, create a default-schedule config for any scout lacking one, and return all scout configs. Normally the Temporal coordinator does this on its next tick; this action exists so setup flows (e.g. the wizard's self-driving program) can hand the user a tunable fleet immediately.
signals
Update a scout config
Tune one scout: change its schedule (`run_interval_minutes`), `enabled`, or `emit` (dry-run) posture. `skill_name` is fixed. Enabling records `enabled_by` and is activity-logged since it drives spend.
signals
Edit an existing report for a run
Rewrite a report's title/summary, append a note, and/or set its suggested reviewers. Can target ANY of the project's inbox reports, not just scout-authored ones — so the edit is attributed to this scout. Setting reviewers is how you rescue a report that surfaced routed to no one: it replaces the reviewer list and re-runs autostart, so a report missing a qualifying reviewer can open a draft PR. Title/summary edits are best-effort: the pipeline may later re-research them.
signals
Author a full report for a run
The second emit channel: author a complete `SignalReport` directly instead of emitting a weak signal. The report passes the safety judge, then surfaces at the status the scout's `actionability` call implies (or is suppressed). Backing `evidence` is written as bound signals so the report behaves like a pipeline report. NOT idempotent — a retry authors a second report; use `reports` to find a prior report and `edit-report` to update it instead.
signals
Emit a finding for a run
Fire `emit_signal` with `source_product = signals_scout`. The `finding_id` is baked into the deterministic `Signal.source_id = run:<id>:finding:<id>` for traceability, but this is NOT idempotent — a second call with the same `finding_id` emits a second signal, so do not retry an emit that may have already succeeded.
signals
List project members for reviewer routing
Return the people who can review work on this project — one row per member with access to it, each with their `user_uuid`, `email`, `first_name`/`last_name`, and resolved GitHub `login` (null when they have no linked GitHub identity). The cold-start reviewer-routing path: when a finding's owner can't be read off a fetched entity's `created_by` and there's no cached `reviewer:<area>` memory or inbox precedent, list members, match the owner by email/name, then put their resolved `github_login` in `suggested_reviewers` on `emit-report` / `edit-report`. Pass `search` to narrow a large roster; the result is capped at 200. Strictly team-scoped.
signals
Get scout metadata
Return the project's scout metadata: whether it is enrolled, the current announcement banner (e.g. an alpha run-limit notice, or null when unset), and the enforced run limits with current usage. Limits reflect what the coordinator actually applies at dispatch, so a user can see the real throttle rather than what they assume they set. All values come from the `signals-scout` flag payload, so the banner and caps can change with no deploy.
signals
Get the current project profile
Return the team's deterministic project profile. For the internal scout token the response reflects the newest non-expired cached row or a freshly-built one (lazy compute on cache miss); `force_refresh=true` skips the cache and rebuilds from authoritative sources. Public read callers (session auth or a `signal_scout:read` PAK) get the newest cached profile, or 404 if none has been built yet — they never trigger a rebuild. Read this at the start of a run to orient on the team's product mix, integrations, warehouse sources, signal coverage, and existing inbox surface.
signals
List the inbox reports a run's findings linked to
Best-effort reverse of the report -> signals link. For each finding the run emitted, resolve the inbox `SignalReport` (if any) its underlying signal grouped into by walking the deterministic `source_id` back through the signal store. `report` is null when the finding hasn't grouped into a report yet, was de-duplicated away, or its signal was deleted. Lets the scout UI surface which inbox report a finding contributed to — the reverse of the report's evidence list. Strictly team-scoped — a run UUID belonging to another team returns 404.
signals
List the inbox reports many runs' findings linked to
Batched form of the per-run emission-reports endpoint. For every finding the requested runs emitted, resolve the inbox `SignalReport` (if any) its signal grouped into — all in a single ClickHouse round-trip rather than one query per run, which is what made the findings page slow to open. `report` is null when a finding hasn't grouped yet, was de-duplicated, or its signal was deleted. Strictly team-scoped — run ids belonging to another team contribute no rows.
signals
List a run's emitted findings
Return the findings a `SignalScoutRun` emitted to the inbox, newest first — one row per emit with its `description` (the finding text as surfaced), `weight`, `confidence`, `severity`, and the deterministic `source_id` that joins back to the underlying signal. Lets a team and its agents see *what* a run surfaced without parsing `emitted_finding_ids` or scanning the signal store. Strictly team-scoped — a run UUID belonging to another team returns 404.
signals
List emitted findings for many runs at once
Batched form of the per-run emissions endpoint: return the findings every requested `SignalScoutRun` emitted, flattened newest-first, in a single request. Each row carries its `run_id`, so the caller can regroup by run. The findings UI uses this to load the whole recent window in one round-trip instead of one request per run. Strictly team-scoped — run ids belonging to another team contribute no rows (no per-run 404; one stale id never fails the batch).
signals
Summarise recently emitted findings across the fleet
Return a cheap fleet-wide tally of the findings the scout troop emitted in the recent window — the total count, the number of distinct scouts behind them, and the latest emission time. Backs the 'Scout findings' callout so it renders from one query instead of the client paging through the whole runs window. Counts only runs that emitted at least one finding (`emitted_count > 0`) within the last `window_hours` (default 72), capped to the most recent 120 emitted runs so the count matches what the findings list renders. Strictly team-scoped.
signals
Search recent agent runs
Return the most recent `SignalScoutRun` summaries for this project, newest first. Used by the headless scout to dedupe against work other runs already covered. ILIKE matches on `summary`. `date_from` / `date_to` are a half-open window on `created_at` (`>= date_from`, `< date_to`); pass `date_to` on subsequent calls to walk past the 100-row cap. Pass `emitted=true` to see only runs that surfaced at least one finding. Pass `skill_name` (optionally with `skill_version`) to scope to a single scout. Results capped at 100.
signals
List recent emitted findings across all runs
Return the team's recently emitted scout findings across *every* run, newest first — the cross-run counterpart to the per-run `emissions` action. Each row carries its `run_id`, so you can regroup by run without first listing runs and fanning out one `emissions` call each. Pass `skill_name` to scope to a single scout, and `date_from` / `date_to` (a half-open window on `emitted_at`) to bound or paginate — set `date_to` to the oldest emission's `emitted_at` to walk back past the limit. Pure Postgres, no ClickHouse round-trip. Capped at 200 rows (default 50).
signals
Get a run by ID
Return the full `SignalScoutRun` row. Status, timing, and error flow from the linked `tasks.TaskRun`. Strictly team-scoped — a UUID belonging to another team returns 404.
signals
Forget a scratchpad entry by key
Delete an entry by key. Returns `deleted=false` if no row matched.
signals
Remember a scratchpad entry
Upsert a memory keyed on `(team, key)`. Re-using a key updates the existing entry in place.
signals
Search the scout scratchpad
Return `SignalScratchpad` entries for this project, newest-first. ILIKE matches on `content` and `key`. `date_from` / `date_to` are a half-open window on `updated_at` (`>= date_from`, `< date_to`); pass `date_to` (the `updated_at` of the oldest entry seen) on subsequent calls to walk past the cap. Pass `keys_only=true` to scan keys without pulling entry bodies, or `content_max_chars` to cap each `content` to a preview — both keep a wide orientation scan from returning every entry's full prose. Results capped at 500.
signals
Signals Source Configs Create
Signals Source Configs Create
signals
Signals Source Configs Destroy
Signals Source Configs Destroy
signals
Signals Source Configs List
Signals Source Configs List
signals
Signals Source Configs Partial Update
Signals Source Configs Partial Update
signals
Signals Source Configs Retrieve
Signals Source Configs Retrieve
signals
Signals Source Configs Update
Signals Source Configs Update
signals
Single Session Summaries List
List stored AI-generated session summaries for the team, one row per session (latest summary kept). Use to discover which sessions have been summarized and to filter for sessions with specific problems — `has_exceptions=true`, `outcome=failure`, or a custom `session_ids` narrowing. Returns lightweight rows without the full summary JSON; use the retrieve endpoint for the per-segment / per-action detail.
single_session_summaries
Single Session Summaries Retrieve
Get the latest stored AI summary for a single session by `session_id`. Returns the full `summary` JSON (segments with named timeline, per-action `abandonment` / `confusion` / `exception` flags, segment outcomes, headline `session_outcome`, optional `sentiment`), the `exception_event_ids` array, the `extra_summary_context` (e.g. `focus_area`) used at generation time, and the `run_metadata` (LLM model used, whether visual confirmation was applied). 404 if no summary has been generated for this session yet — to trigger generation, use the existing `session-recording-summarize` flow rather than this endpoint.
single_session_summaries
Subscriptions Create
Subscriptions Create
subscriptionssubscriptions
List subscription deliveries
Paginated delivery history for a subscription. Requires premium subscriptions.
subscriptionssubscriptions
Retrieve subscription delivery
Fetch one delivery row by id.
subscriptionssubscriptions
Subscriptions Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
subscriptionssubscriptions
Subscriptions List
Subscriptions List
subscriptionssubscriptions
Subscriptions Partial Update
Subscriptions Partial Update
subscriptionssubscriptions
Subscriptions Retrieve
Subscriptions Retrieve
subscriptionssubscriptions
Subscriptions Summary Quota Retrieve
Subscriptions Summary Quota Retrieve
subscriptionssubscriptions
Subscriptions Test Delivery Create
Subscriptions Test Delivery Create
subscriptionssubscriptions
Subscriptions Update
Subscriptions Update
subscriptionssubscriptions
Surveys Activity Retrieve
Surveys Activity Retrieve
surveys
Surveys All Activity Retrieve
Surveys All Activity Retrieve
surveys
Surveys Archived Response Uuids Retrieve
Get list of archived response UUIDs for HogQL filtering. Returns list of UUIDs that the frontend can use to filter out archived responses in HogQL queries.
surveys
Surveys Create
Surveys Create
surveys
Surveys Destroy
Surveys Destroy
surveys
Surveys Duplicate To Projects Create
Duplicate a survey to multiple projects in a single transaction. Accepts a list of target team IDs and creates a copy of the survey in each project. Uses an all-or-nothing approach - if any duplication fails, all changes are rolled back.
surveys
Surveys Generate Translations Create
Surveys Generate Translations Create
surveys
Surveys Global Stats Retrieve
Get aggregated response statistics across all surveys. Args: date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z) date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z) Returns: Aggregated statistics across all surveys including total counts and rates
surveys
Surveys Launch
Launch a survey by setting `start_date` to the current time. No-op if the survey is already launched (start_date set in the past) — returns the existing state unchanged. Does not affect archived surveys or surveys with an end_date in the past; unarchive or extend the end_date first.
surveys
Surveys List
Surveys List
surveys
Surveys Partial Update
Surveys Partial Update
surveys
Surveys Question Labels
Return a slim list of question labels for the team's surveys. Used by the frontend to resolve `$survey_response_<question_id>` property keys into human-readable question text without loading the full survey payload.
surveys
Surveys Responses Archive Create
Archive a single survey response.
surveys
Surveys Responses Count Retrieve
Get response counts for all surveys. Args: exclude_archived: Optional boolean to exclude archived responses (default: false, includes archived) survey_ids: Optional comma-separated list of survey IDs to filter by Returns: Dictionary mapping survey IDs to response counts
surveys
Surveys Responses List
List survey responses for a specific survey, with question text resolved server-side so callers do not have to map opaque `$survey_response_<id>` keys. Each row carries `distinct_id`, `session_id`, `submitted_at`, and an `extra` block (device, browser, OS, geoip, current_url, iteration) so agents can cross-pivot to recordings, persons, or paths in a single follow-up call. For person properties at event time, follow up with `persons-get` using the returned `distinct_id` — keeps scopes scoped. Use `question_id` + `score_lte` to fetch NPS detractors and similar score-filtered cohorts.
surveys
Surveys Responses Unarchive Create
Unarchive a single survey response.
surveys
Surveys Retrieve
Surveys Retrieve
surveys
Surveys Stats Retrieve
Get survey response statistics for a specific survey. Args: date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z) date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z) exclude_archived: Optional boolean to exclude archived responses (default: false, includes archived) include_per_question_stats: Optional boolean to include per-question response counts and distributions Returns: Survey statistics including event counts, unique respondents, and conversion rates
surveys
Surveys Stop
Stop a survey by setting `end_date` to the current time. No new responses are accepted after this; existing responses remain available. No-op if the survey already has an end_date in the past.
surveys
Surveys Summarize Responses Create
Summarize survey responses. When `question_index` or `question_id` is provided, returns a per-question theme summary using cached `survey.question_summaries` when fresh. When neither is provided, returns the survey-wide headline summary (delegates to summary_headline). Pass `force_refresh=true` in the body to bypass caches.
surveys
Surveys Summary Headline Create
Surveys Summary Headline Create
surveys
Surveys Update
Surveys Update
surveys
Taggers Create
Taggers Create
taggers
Taggers Destroy
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
taggers
Taggers List
Taggers List
taggers
Taggers Partial Update
Taggers Partial Update
taggers
Taggers Retrieve
Taggers Retrieve
taggers
Taggers Test Hog Create
Test Hog tagger code against sample events without saving.
taggers
Taggers Update
Taggers Update
taggers
Task Automations Create
API for managing scheduled task automations.
task-automationstask_automations
Task Automations Destroy
API for managing scheduled task automations.
task-automationstask_automations
Task Automations List
API for managing scheduled task automations.
task-automationstask_automations
Task Automations Partial Update
API for managing scheduled task automations.
task-automationstask_automations
Task Automations Retrieve
API for managing scheduled task automations.
task-automationstask_automations
Task Automations Run Create
API for managing scheduled task automations.
task-automationstask_automations
Resolve or create a public channel
Returns the existing public channel with the (normalized) name, creating it if needed.
task_channels
Delete a public channel
API for task channels — the shared feeds tasks are kicked off in. Listing lazily provisions the requester's personal "#me" channel; creation is resolve-or-create by normalized name so clients can map channel-like surfaces onto backend channels.
task_channels
List channels
All live public channels plus the requester's personal #me channel (created on first list).
task_channels
Rename a public channel
API for task channels — the shared feeds tasks are kicked off in. Listing lazily provisions the requester's personal "#me" channel; creation is resolve-or-create by normalized name so clients can map channel-like surfaces onto backend channels.
task_channels
List mentions of the requester
Thread messages that @-mention the requester, newest first, restricted to tasks they can see.
task_mentions
Tasks Create
API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
taskstasks
Tasks Destroy
API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
taskstasks
List tasks
Get a list of tasks for the current project, with optional filtering by origin product, stage, organization, repository, and created_by.
taskstasks
Tasks Partial Update
API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
taskstasks
Beacon presence for a device watching this task
Idempotent upsert: marks the calling user + `device_id` as actively watching this task for the next ~60 seconds. While at least one device for the user has a non-expired presence row for this task, the push fanout will skip ALL of that user's other registered devices for task notifications — the contract is 'if any device is demonstrably watching, suppress the others'. Clients call this every ~30s while the task screen is foregrounded. `device_id` is the UUID of the caller's UserPushToken row.
taskstasks
Beacon presence for a device watching this task
Idempotent upsert: marks the calling user + `device_id` as actively watching this task for the next ~60 seconds. While at least one device for the user has a non-expired presence row for this task, the push fanout will skip ALL of that user's other registered devices for task notifications — the contract is 'if any device is demonstrably watching, suppress the others'. Clients call this every ~30s while the task screen is foregrounded. `device_id` is the UUID of the caller's UserPushToken row.
taskstasks
List distinct task repositories
Return the set of repositories referenced by non-deleted, non-internal tasks in the current project. Used to populate repository filter pickers without being constrained by task list pagination.
taskstasks
Get repository readiness
Get autonomy readiness details for a specific repository in the current project.
taskstasks
Get task
Retrieve a single task by ID.
taskstasks
Run task
Create a new task run and kick off the workflow.
taskstasks
Append log entries
Append one or more log entries to the task run log array
task-runstaskstasks
Upload artifacts for a task run
Persist task artifacts to S3 and attach them to the run manifest.
task-runstaskstasks
Download an artifact through the backend
Streams artifact content for a task run artifact after validating that it belongs to the run.
task-runstaskstasks
Finalize direct uploads for task run artifacts
Verify directly uploaded S3 objects and attach them to the run artifact manifest.
task-runstaskstasks
Prepare direct uploads for task run artifacts
Reserve S3 object keys for task artifacts and return presigned POST forms for direct uploads.
task-runstaskstasks
Generate presigned URL for an artifact
Returns a temporary, signed URL that can be used to download a specific artifact.
task-runstaskstasks
Send command to task run
Queue user_message JSON-RPC commands through the task workflow and forward sandbox control commands to the agent server. Supports user_message, cancel, close, permission_response, and set_config_option commands.
task-runstaskstasks
Get sandbox connection token
Generate a JWT token for direct connection to the sandbox. Valid for 24 hours.
task-runstaskstasks
Create task run
Create a new run for a specific task without starting execution.
task-runstaskstasks
List task runs
Get a list of runs for a specific task.
task-runstaskstasks
Get task run logs
Fetch the logs for a task run as JSONL. If the run resumes from another (state.resume_from_run_id), each ancestor's log is concatenated first (oldest ancestor → ... → this run) so resume consumers see a single continuous history and can find the most recent git_checkpoint event regardless of which run emitted it.
task-runstaskstasks
Update task run
API for managing task runs. Each run represents an execution of a task.
task-runstaskstasks
Relay run message to Slack
Queue a Slack relay workflow to post a run message into the mapped Slack thread.
task-runstaskstasks
Resume task run in cloud
Resume an existing task run in a cloud sandbox. Terminates any existing workflow and starts a new one.
task-runstaskstasks
Get task run
Retrieve a single run for a specific task.
task-runstaskstasks
Get filtered task run session logs
Fetch session log entries for a task run with optional filtering by timestamp, event type, and limit.
task-runstaskstasks
Set run output
Update the output field for a task run (e.g., PR URL, commit SHA, etc.)
task-runstaskstasks
Start task run
Start an existing cloud run after any initial run-scoped attachments have been uploaded.
task-runstaskstasks
Tasks Runs Stream Retrieve
Server-Sent Events stream of task run events. Events carry an `id:` line (a Redis stream id) usable as a resume cursor. The server caps each connection at 900 seconds: it emits `event: end` with `data: {"type": "rotated"}` and closes. This does NOT mean the run finished — reconnect with the `Last-Event-ID` header set to the last received event id to resume without gaps or duplicates. Only treat the stream as complete when the run itself reaches a terminal status. `?start=latest` consumers must also carry `Last-Event-ID` across reconnects: reconnecting without it re-resolves to the then-current latest event, silently skipping anything published while disconnected. **SDK consumers**: do not call the generated fetch wrapper for this path — it will buffer the entire stream. Use the URL builder (`getTasksRunsStreamRetrieveUrl`) with a streaming `fetch`/`EventSource`-style consumer and the `Last-Event-ID` header instead.
task-runstaskstasks
Get task run stream read token
Generate a run-scoped JWT that authorizes reading this task run's live event stream via the agent-proxy.
task-runstaskstasks
Resolve a Slack thread to its task, runs, and Temporal workflows
PostHog-internal debug tool. Resolves a Slack permalink to the linked task, its runs, the task-processing and mention-dispatch Temporal workflow ids/URLs, and presigned log URLs.
taskstasks
Finalize staged direct uploads for task attachments
Verify staged S3 uploads and cache their metadata so they can be attached to the next run created for this task.
taskstasks
Prepare staged direct uploads for task attachments
Reserve S3 object keys for task attachments before creating a new run and return presigned POST forms for direct uploads.
taskstasks
Fetch task summaries by ID
Returns summary for the requested tasks: `id`, `title`, `repository`, `created_at`, `updated_at`, and the latest run's `status` and `environment`.
taskstasks
Post a thread message
API for a task's thread — the human-only side conversation around a task. Messages reach the agent only via the explicit send_to_agent action, gated to the task author.
tasks
Delete own thread message
API for a task's thread — the human-only side conversation around a task. Messages reach the agent only via the explicit send_to_agent action, gated to the task author.
tasks
List thread messages
The task's thread in chronological order.
tasks
Send a thread message to the agent
Task author only: forwards the message into the task's latest live run.
tasks
Tasks Update
API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
taskstasks
Warm a task sandbox
Warm a full idling Run for a Code-app cloud task while the user composes: boot a sandbox, clone the repo, check out the branch, and start the agent, then idle awaiting the first message. On submit the normal create+run path transparently reuses and activates this Run; abandoned warms are reaped by the Run's inactivity timeout. Best-effort: returns an empty body when the feature flag is off, the warm pool is full, or the GitHub integration doesn't belong to the team.
taskstasks
Tracing Spans Aggregate Create
Tracing Spans Aggregate Create
tracing
Tracing Spans Attribute Breakdown Create
Tracing Spans Attribute Breakdown Create
tracing
Tracing Spans Attributes Retrieve
Tracing Spans Attributes Retrieve
tracing
Tracing Spans Count Create
Tracing Spans Count Create
tracing
Tracing Spans Duration Histogram Create
Tracing Spans Duration Histogram Create
tracing
Tracing Spans Has Spans Retrieve
Tracing Spans Has Spans Retrieve
tracing
Tracing Spans Query Create
Tracing Spans Query Create
tracing
Tracing Spans Service Names Retrieve
Tracing Spans Service Names Retrieve
tracing
Tracing Spans Sparkline Create
Tracing Spans Sparkline Create
tracing
Tracing Spans Symbol Stats Create
Tracing Spans Symbol Stats Create
tracing
Tracing Spans Trace Create
Tracing Spans Trace Create
tracing
Tracing Spans Tree Create
Tracing Spans Tree Create
tracing
Tracing Spans Values Retrieve
Tracing Spans Values Retrieve
tracing
Tracing Views Create
Tracing Views Create
tracing
Tracing Views Destroy
Tracing Views Destroy
tracing
Tracing Views List
Tracing Views List
tracing
Tracing Views Partial Update
Tracing Views Partial Update
tracing
Tracing Views Retrieve
Tracing Views Retrieve
tracing
Tracing Views Update
Tracing Views Update
tracing
Update
Update
organizationsorganizations
Update Session Summaries Config
Update the team's session summaries configuration (product context used to tailor single-session replay summaries).
session_summaries
Uploaded Media Create
When object storage is available this API allows upload of media which can be used, for example, in text cards on dashboards. Uploaded media must have a content type beginning with 'image/' and be less than 4MB.
uploaded_media
User Home Settings Partial Update
Update the authenticated user's pinned sidebar tabs and/or homepage for the current team. Pass `@me` as the UUID. Send `tabs` to replace the pinned tab list, `homepage` to set the home destination (any PostHog URL — dashboard, insight, search results, scene). Either field may be omitted to leave it unchanged; sending `homepage: null` or `{}` clears the homepage.
user_home_settingsuser_home_settings
User Home Settings Retrieve
Get the authenticated user's pinned sidebar tabs and configured homepage for the current team. Pass `@me` as the UUID.
user_home_settingsuser_home_settings
User Interview Topics Add Interviewee Create
Add a single interviewee to this topic. Email-shaped identifiers (including the `Display Name <email@host>` form) are appended to `interviewee_emails`; everything else is appended to `interviewee_distinct_ids`. Idempotent — adding an identifier that's already present leaves the topic unchanged. Returns the updated topic.
user_interview_topics
User Interview Topics Create
Planned user interview topics: who we want to target and what we want to ask about.
user_interview_topics
User Interview Topics Destroy
Planned user interview topics: who we want to target and what we want to ask about.
user_interview_topics
User Interview Topics Generate Links Create
Generate one public interview link per targeted interviewee. Materializes an IntervieweeContext row for every identifier on the topic (without overwriting existing per-person context), and an enabled SharingConfiguration with a unique access token. The URL resolves to the public interview viewer with no PostHog auth required.
user_interview_topics
User Interview Topics Interviewees Bulk Create
Create up to 500 interviewee context rows for a topic in a single request. Rows whose (topic, interviewee_identifier) already exists are skipped — the response surfaces an `inserted_count`, a `skipped_count`, and the `skipped_identifiers` so the caller can reconcile. Items must have unique `interviewee_identifier` values within the batch.
user_interview_topics
User Interview Topics Interviewees Create
Per-interviewee extra context for a user interview topic. At most one row per (topic, interviewee_identifier).
user_interview_topics
User Interview Topics Interviewees Destroy
Per-interviewee extra context for a user interview topic. At most one row per (topic, interviewee_identifier).
user_interview_topics
User Interview Topics Interviewees List
Per-interviewee extra context for a user interview topic. At most one row per (topic, interviewee_identifier).
user_interview_topics
User Interview Topics Interviewees Partial Update
Per-interviewee extra context for a user interview topic. At most one row per (topic, interviewee_identifier).
user_interview_topics
User Interview Topics Interviewees Retrieve
Per-interviewee extra context for a user interview topic. At most one row per (topic, interviewee_identifier).
user_interview_topics
User Interview Topics Interviewees Update
Per-interviewee extra context for a user interview topic. At most one row per (topic, interviewee_identifier).
user_interview_topics
User Interview Topics Links Csv Create
Same materialization as generate_links, returned as a downloadable CSV. Intended for users who want to mail-merge the per-person interview links into their own email tooling.
user_interview_topics
User Interview Topics List
Planned user interview topics: who we want to target and what we want to ask about.
user_interview_topics
User Interview Topics Partial Update
Planned user interview topics: who we want to target and what we want to ask about.
user_interview_topics
User Interview Topics Preview Invite Create
Render the invite email exactly as a specific targeted interviewee would receive it — personalized subject and body — without sending anything and without creating or reading any share links. Pass `interviewee_identifier` to preview for a particular person, or omit it to preview for the first targeted interviewee. The body always shows an illustrative placeholder link (`is_preview_link: true`), never a live interview URL.
user_interview_topics
User Interview Topics Remove Interviewee Create
Remove an interviewee from this topic. Drops the identifier from both `interviewee_emails` and `interviewee_distinct_ids`, and disables any active SharingConfiguration linked to an IntervieweeContext for that identifier on this topic so the removed person can no longer open their interview link. Idempotent — removing an identifier that isn't present is a no-op. Returns the updated topic.
user_interview_topics
User Interview Topics Retrieve
Planned user interview topics: who we want to target and what we want to ask about.
user_interview_topics
User Interview Topics Send Invites Create
Generate (if needed) and email a personalized public interview link to every targeted interviewee on this topic whose identifier is an email address. Distinct-ID-only interviewees are skipped and surfaced in the response. Each invite is keyed on the underlying SharingConfiguration so re-runs after token rotation produce a fresh send.
user_interview_topics
User Interview Topics Test Link Retrieve
Return the calling user's personal dogfood interview link for this topic, plus the latest test interview they have recorded against it. Lazily get-or-creates a per-caller IntervieweeContext + enabled SharingConfiguration the first time it's called, then returns the same stable URL on subsequent calls. The caller's identifier is intentionally not added to the topic's targeting arrays — each user dogfoods under their own row, so test calls never mint a public share token on someone else's behalf.
user_interview_topics
User Interview Topics Update
Planned user interview topics: who we want to target and what we want to ask about.
user_interview_topics
User Interviews Create
User Interviews Create
user_interviews
User Interviews Destroy
User Interviews Destroy
user_interviews
User Interviews List
User Interviews List
user_interviews
User Interviews Partial Update
User Interviews Partial Update
user_interviews
User Interviews Retrieve
User Interviews Retrieve
user_interviews
Search interview responses by semantic similarity
Embed `query` with the same model used to index interview transcripts and summaries, then return the top matches by cosine distance. Each match is a single (interview, document_type) pair — an interview can appear up to twice if both its transcript and summary score above other interviews. Useful for surfacing relevant interview snippets in natural language, without exact keyword matches.
user_interviews
User Interviews Update
User Interviews Update
user_interviews
Users Cancel Email Change Request Partial Update
Users Cancel Email Change Request Partial Update
usersusers
Users Credentials Review Complete Create
Mark the user as having reviewed their existing credentials. Idempotent. Flips `requires_credential_review` to False so the post-login interstitial isn't shown again. Does not modify any credentials; the user revokes individual Personal API Keys and passkeys via their existing endpoints from the same screen.
usersusers
Users Destroy
Users Destroy
usersusers
Users Github Login Retrieve
Users Github Login Retrieve
usersusers
Users Hedgehog Config Partial Update
Users Hedgehog Config Partial Update
usersusers
Users Hedgehog Config Retrieve
Users Hedgehog Config Retrieve
usersusers
List branches for a personal GitHub installation repository
List branches for a repository accessible to a personal GitHub installation.
usersusers
Disconnect a personal GitHub integration
Remove a specific GitHub installation by its installation_id.
usersusers
Users Integrations Github Prepare Callback Create
Seed personal GitHub manage callback state before opening installation settings on GitHub.
usersusers
Refresh repositories for a personal GitHub installation
Refresh repositories accessible to a specific GitHub installation.
usersusers
List repositories for a personal GitHub installation
List repositories accessible to a specific GitHub installation (paginated, cached).
usersusers
Start GitHub personal integration linking
Start GitHub linking: either full App install or OAuth-only (user-to-server). ``**_kwargs`` absorbs ``parent_lookup_uuid`` from the nested ``/api/users/{uuid}/integrations/`` router (same pattern as ``local_evaluation`` under projects). Usually returns ``install_url`` pointing at ``/installations/new`` so the user can pick any GitHub org (new or already connected). GitHub's install page handles both cases: orgs where the app is installed show "Configure" (no admin needed), orgs where it isn't show "Install" (needs admin). **OAuth fast path:** when the current project already has a team-level GitHub installation, and the user has no ``UserIntegration`` for that installation yet, we skip the org picker and redirect straight to ``/login/oauth/authorize`` so the user only authorizes themselves. ``connect_from`` is preserved for first-party clients so they return to the originating client immediately. In both cases the response key is ``install_url`` for compatibility with callers.
usersusers
List the user's personal integrations of a given kind
Return the authenticated user's personal integrations of a given ``kind`` (``github`` or ``slack``). The response shape varies per kind because the underlying ``UserIntegration`` rows carry different identity fields — GitHub rows expose ``installation_id`` / ``account`` / ``uses_shared_installation``; Slack rows expose ``slack_user_id`` / ``slack_team_id`` / ``slack_team_name``. Kind-specific destroy and start actions remain split so their distinct semantics (e.g. Slack's lack of "uninstall on last reference") stay explicit at the URL layer. Default of ``kind=github`` is load-bearing: mobile (``apps/mobile/...``) and the Code SDK (``packages/api-client/...``) both call this endpoint without a query param today and rely on receiving GitHub rows.
usersusers
Unlink a Slack identity
Remove a Slack identity link by Slack user id. Idempotent and flag-agnostic — users must always be able to unlink even after the feature flag is turned off.
usersusers
List Slack workspaces this user could link to
Return Slack workspaces in the user's organizations that they have not yet linked. The settings UI uses this list to decide whether to show a "Link my Slack account" button (non-empty list) and what to offer in the picker when several are connectable.
usersusers
Start Slack identity link from settings
Mint a Sign-in-with-Slack invite URL initiated from settings, without Slack-DM context. The returned URL takes the user through PostHog login (already satisfied here), then to Slack OAuth, then back to our callback which writes the ``UserIntegration`` row. Without body params, falls back to the user's ``current_team`` and that team's first Slack ``Integration`` — works when there's exactly one linkable workspace. With ``team_id`` + ``slack_team_id``, links against the exact pair (what the frontend uses when a picker is shown). Refuses if the target team has no matching Slack workspace, if the feature flag is off for the workspace, or if the user is already linked to it.
usersusers
Users List
Users List
usersusers
Users Login Sessions Destroy
Revoke a single login session belonging to the current user. Self-only. Requires recent auth (TimeSensitiveActionPermission) so a stolen cookie can't weaponize revocation, and is blocked while impersonating via ImpersonationBlockedPathsMiddleware.
usersusers
Users Login Sessions List
List the cookie-auth login sessions for the current user. Self-only — never another user.
usersusers
Users Login Sessions Revoke Others Create
Revoke every login session for the current user except the one making this request. Self-only. Requires recent auth (TimeSensitiveActionPermission) so a stolen cookie can't weaponize the "log out everywhere else" lock-out, and is blocked while impersonating.
usersusers
Users Onboarding Skip Create
Mark the current user as having exited onboarding with a non-delegated reason. Idempotent: the skip timestamp is only set on the first successful call. Callers wanting to delegate setup to a teammate must use the dedicated /organizations/{id}/invites/delegate/ endpoint, which atomically creates the invite and sets reason="delegated". This endpoint rejects that reason so state can't be faked without a real invite.
usersusers
Users Partial Update
Update one or more of the authenticated user's profile fields or settings.
usersusers
Register a push notification token
Idempotent upsert: if the (user, token) pair already exists, `platform` and `last_seen_at` are refreshed. Otherwise a new row is created.
usersusers
Unregister a push notification token
Delete the row matching `(user, token)`. Returns 204 even if no row matches so the mobile client can call this unconditionally when the user opts out.
usersusers
Users Request Email Verification Create
Users Request Email Verification Create
usersusers
Users Retrieve
Retrieve a user's profile and settings. Pass `@me` as the UUID to fetch the authenticated user; non-staff callers may only access their own account.
usersusers
Users Scene Personalisation Create
Users Scene Personalisation Create
usersusers
Users Signal Autonomy Create
Per-user signal autonomy config (singleton keyed by user). GET /api/users/<id>/signal_autonomy/ → current config (or 404) POST /api/users/<id>/signal_autonomy/ → create or update DELETE /api/users/<id>/signal_autonomy/ → remove (opt out)
usersusers
Users Signal Autonomy Destroy
Per-user signal autonomy config (singleton keyed by user). GET /api/users/<id>/signal_autonomy/ → current config (or 404) POST /api/users/<id>/signal_autonomy/ → create or update DELETE /api/users/<id>/signal_autonomy/ → remove (opt out)
usersusers
Users Signal Autonomy Retrieve
Per-user signal autonomy config (singleton keyed by user). GET /api/users/<id>/signal_autonomy/ → current config (or 404) POST /api/users/<id>/signal_autonomy/ → create or update DELETE /api/users/<id>/signal_autonomy/ → remove (opt out)
usersusers
Users Start 2fa Setup Retrieve
Users Start 2fa Setup Retrieve
usersusers
Users Two Factor Backup Codes Create
Generate new backup codes, invalidating any existing ones
usersusers
Users Two Factor Disable Create
Disable 2FA and remove all related devices
usersusers
Users Two Factor Start Setup Retrieve
Users Two Factor Start Setup Retrieve
usersusers
Users Two Factor Status Retrieve
Get current 2FA status including backup codes if enabled
usersusers
Users Two Factor Validate Create
Users Two Factor Validate Create
usersusers
Users Update
Replace the authenticated user's profile and settings. Pass `@me` as the UUID to update the authenticated user. Prefer the PATCH endpoint for partial updates — PUT requires every writable field to be provided.
usersusers
Users Validate 2fa Create
Users Validate 2fa Create
usersusers
Users Verify Email Create
Users Verify Email Create
usersusers
Vision Actions Create
CRUD for Replay Vision actions — scheduled "and then…" automations over a scanner's observations.
vision
Vision Actions Destroy
CRUD for Replay Vision actions — scheduled "and then…" automations over a scanner's observations.
vision
Vision Actions List
CRUD for Replay Vision actions — scheduled "and then…" automations over a scanner's observations.
vision
Vision Actions Partial Update
CRUD for Replay Vision actions — scheduled "and then…" automations over a scanner's observations.
vision
Vision Actions Retrieve
CRUD for Replay Vision actions — scheduled "and then…" automations over a scanner's observations.
vision
Vision Actions Runs List
Read-only run history for a single vision action (nested under /vision/actions/{action_id}/runs/).
vision
Vision Actions Runs Retrieve
Read-only run history for a single vision action (nested under /vision/actions/{action_id}/runs/).
vision
Vision Observations Label Create
Set or update the observation's shared label: whether the scanner scored the session correctly, plus optional feedback on what it got wrong. One label per observation, shared across the team; these labels feed prompt improvement. Requires session recording edit access.
vision
Vision Observations Label Destroy
Remove the observation's shared label. Requires session recording edit access.
vision
Vision Observations List
Read-only access to a session's observations across every scanner the caller can read, for the replay-page dock.
vision
Vision Observations Retrieve
Read-only access to a session's observations across every scanner the caller can read, for the replay-page dock.
vision
Vision Observations Retry Create
Delete a failed observation and re-run its scanner on the same recording. Returns 202 with the workflow handle.
vision
Vision Scanners Create
CRUD for Replay Vision scanners.
vision
Vision Scanners Creators Retrieve
Distinct creators across the team's scanners — feeds the `Created by` filter dropdown.
vision
Vision Scanners Destroy
CRUD for Replay Vision scanners.
vision
Vision Scanners Estimate Create
Estimate the observation volume a proposed scanner would generate, for the pre-save cost preview.
vision
Vision Scanners List
CRUD for Replay Vision scanners.
vision
Vision Scanners Observations Label Create
Set or update the observation's shared label: whether the scanner scored the session correctly, plus optional feedback on what it got wrong. One label per observation, shared across the team; these labels feed prompt improvement. Requires session recording edit access.
vision
Vision Scanners Observations Label Destroy
Remove the observation's shared label. Requires session recording edit access.
vision
Vision Scanners Observations List
Read-only access to observations produced by a scanner.
vision
Vision Scanners Observations Retrieve
Read-only access to observations produced by a scanner.
vision
Vision Scanners Observations Retry Create
Delete a failed observation and re-run its scanner on the same recording. Returns 202 with the workflow handle.
vision
Vision Scanners Observations Stats Retrieve
Aggregate counts and per-scanner-type distributions over the filtered observation set. Same filters as the list endpoint apply.
vision
Vision Scanners Observe Create
Apply this scanner to one specific session, on demand. Returns 202 with the workflow handle.
vision
Vision Scanners Partial Update
CRUD for Replay Vision scanners.
vision
Vision Scanners Prompt Suggestions Apply Create
Apply this suggestion: write its prompt to the scanner (bumping the scanner version) and mark the suggestion applied. Only the current pending suggestion can be applied. Requires session recording edit access.
vision
Vision Scanners Prompt Suggestions Current Retrieve
The scanner's newest prompt suggestion plus whether it is stale (the ratings changed since it was generated) and how many rated observations are available.
vision
Vision Scanners Prompt Suggestions Dismiss Create
Dismiss this suggestion without applying it. Only the current pending suggestion can be dismissed. Requires session recording edit access.
vision
Vision Scanners Prompt Suggestions Generate Create
Generate a fresh prompt suggestion from the team's current ratings. The previous pending suggestion becomes history (superseded). Requires at least one rated observation and session recording edit access.
vision
Vision Scanners Prompt Suggestions List
AI prompt-rewrite suggestions for a scanner, generated from the team's thumbs up/down ratings.
vision
Vision Scanners Retrieve
CRUD for Replay Vision scanners.
vision
Vision Scanners Stats Retrieve
Team-wide scanner counts — independent of list filters, so the overview stays stable.
vision
Vision Scanners Suggest Tags Create
Suggest classifier tags grounded in the scanner's own observations and the org's product data.
vision
Visual Review Repos Baselines Retrieve
Snapshots overview for a repo: every identifier with a current baseline (latest non-superseded master/main run per run_type), plus tolerate counts, active quarantine state, and a 30-day stability sparkline. Capped at 5000 entries — sets `truncated` and returns the most recently active when exceeded. Filtering / faceting / search are all done client-side; this endpoint takes no filter query params.
visual_review
Visual Review Repos Create
Create a new repo.
visual_review
Visual Review Repos List
List all projects for the team.
visual_review
Visual Review Repos Partial Update
Update a repo's settings.
visual_review
Visual Review Repos Quarantine Create
Quarantine a snapshot identifier for a specific run type.
visual_review
Visual Review Repos Quarantine Expire Create
Expire all active quarantine entries for an identifier.
visual_review
Visual Review Repos Quarantine List
List quarantined identifiers. Without filter: active only. With identifier: full history.
visual_review
Visual Review Repos Retrieve
Get a repo by ID.
visual_review
Visual Review Repos Runs Counts Retrieve
Review state counts for runs in this repo.
visual_review
Visual Review Repos Runs List
List runs in this repo, optionally filtered by review state and free-text search.
visual_review
Visual Review Repos Snapshots List
Deduped baseline timeline for a snapshot identity. Newest first.
visual_review
Visual Review Repos Thumbnails Retrieve
Serve a snapshot thumbnail by identifier. Returns WebP with ETag caching.
visual_review
Visual Review Runs Add Snapshots Create
Add a batch of snapshots to a pending run (shard-based flow).
visual_review
Visual Review Runs Approve Create
Mark snapshots reviewed (DB only). Records the per-snapshot "Accept change" decision. Does not commit the baseline or change the GitHub gate — call finalize to ship the run.
visual_review
Visual Review Runs Complete Create
Complete a run: detect removals, verify uploads, trigger diff processing.
visual_review
Visual Review Runs Counts Retrieve
Review state counts for the runs list.
visual_review
Visual Review Runs Create
Create a new run from a CI manifest.
visual_review
Visual Review Runs Finalize Create
Finalize a fully-reviewed run: commit the approved baseline and green the gate. Commits exactly the snapshots approved in the DB (tolerated ones keep their baseline) and only succeeds once every changed/new snapshot is resolved. With approve_all=true, any still-pending changed/new snapshot is approved first. With commit_to_github=false the server returns the signed baseline YAML instead of committing it.
visual_review
Visual Review Runs List
List runs for the team, optionally filtered by review state, PR number, commit SHA, branch, or free-text search.
visual_review
Visual Review Runs Recompute Create
Re-evaluate quarantine and counts, update commit status, and optionally rerun the CI job.
visual_review
Visual Review Runs Retrieve
Get run status and summary.
visual_review
Visual Review Runs Snapshot History List
Recent change history for a snapshot identifier across runs.
visual_review
Visual Review Runs Snapshots List
Get a run's snapshots with diff results, excluding quarantined ones by default.
visual_review
Visual Review Runs Tolerate Create
Mark a changed snapshot as a known tolerated alternate.
visual_review
Visual Review Runs Tolerated Hashes List
List known tolerated hashes for a snapshot identifier.
visual_review
Warehouse Column Annotations Create
Read and edit semantic descriptions of warehouse tables and columns surfaced to the AI agent. List can be filtered to one table with `?table_id=<uuid>`. Any create or update is treated as a user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic enrichment. Create upserts on `(table, column_name)`; the table cannot be changed after creation.
warehouse_column_annotations
Warehouse Column Annotations Destroy
Read and edit semantic descriptions of warehouse tables and columns surfaced to the AI agent. List can be filtered to one table with `?table_id=<uuid>`. Any create or update is treated as a user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic enrichment. Create upserts on `(table, column_name)`; the table cannot be changed after creation.
warehouse_column_annotations
Warehouse Column Annotations List
Read and edit semantic descriptions of warehouse tables and columns surfaced to the AI agent. List can be filtered to one table with `?table_id=<uuid>`. Any create or update is treated as a user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic enrichment. Create upserts on `(table, column_name)`; the table cannot be changed after creation.
warehouse_column_annotations
Warehouse Column Annotations Partial Update
Read and edit semantic descriptions of warehouse tables and columns surfaced to the AI agent. List can be filtered to one table with `?table_id=<uuid>`. Any create or update is treated as a user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic enrichment. Create upserts on `(table, column_name)`; the table cannot be changed after creation.
warehouse_column_annotations
Warehouse Column Annotations Retrieve
Read and edit semantic descriptions of warehouse tables and columns surfaced to the AI agent. List can be filtered to one table with `?table_id=<uuid>`. Any create or update is treated as a user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic enrichment. Create upserts on `(table, column_name)`; the table cannot be changed after creation.
warehouse_column_annotations
Warehouse Column Annotations Update
Read and edit semantic descriptions of warehouse tables and columns surfaced to the AI agent. List can be filtered to one table with `?table_id=<uuid>`. Any create or update is treated as a user edit (`is_user_edited=True`), which protects the row from being overwritten by automatic enrichment. Create upserts on `(table, column_name)`; the table cannot be changed after creation.
warehouse_column_annotations
Warehouse Column Statistics List
Read per-column data statistics (null fraction, min/max, row count) for warehouse tables. Statistics are computed automatically after a sync and surfaced to the AI agent so it can write better queries. They are system-owned and read-only here. List can be filtered to one table with `?table_id=<uuid>`.
warehouse_column_statistics
Warehouse Column Statistics Retrieve
Read per-column data statistics (null fraction, min/max, row count) for warehouse tables. Statistics are computed automatically after a sync and surfaced to the AI agent so it can write better queries. They are system-owned and read-only here. List can be filtered to one table with `?table_id=<uuid>`.
warehouse_column_statistics
Warehouse Dag List
Return this team's DAG as a set of edges and nodes
warehouse_dag
Warehouse Model Paths List
Warehouse Model Paths List
warehouse_model_paths
Warehouse Model Paths Retrieve
Warehouse Model Paths Retrieve
warehouse_model_paths
Warehouse Saved Queries Activity Retrieve
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Warehouse Saved Queries Ancestors Create
Return the ancestors of this saved query. By default, we return the immediate parents. The `level` parameter can be used to look further back into the ancestor tree. If `level` overshoots (i.e. points to only ancestors beyond the root), we return an empty list.
warehouse_saved_queries
Warehouse Saved Queries Cancel Create
Cancel a running saved query workflow.
warehouse_saved_queries
Warehouse Saved Queries Create
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Warehouse Saved Queries Dependencies Retrieve
Return the count of immediate upstream and downstream dependencies for this saved query.
warehouse_saved_queries
Warehouse Saved Queries Descendants Create
Return the descendants of this saved query. By default, we return the immediate children. The `level` parameter can be used to look further ahead into the descendants tree. If `level` overshoots (i.e. points to only descendants further than a leaf), we return an empty list.
warehouse_saved_queries
Warehouse Saved Queries Destroy
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Warehouse Saved Queries List
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Warehouse Saved Queries Materialize Create
Enable materialization for this saved query with a 24-hour sync frequency.
warehouse_saved_queries
Warehouse Saved Queries Partial Update
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Warehouse Saved Queries Resume Schedules Create
Resume paused materialization schedules for multiple matviews. Accepts a list of view IDs in the request body: {"view_ids": ["id1", "id2", ...]} This endpoint is idempotent - calling it on already running or non-existent schedules is safe.
warehouse_saved_queries
Warehouse Saved Queries Retrieve
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Warehouse Saved Queries Revert Materialization Create
Undo materialization, revert back to the original view. (i.e. delete the materialized table and the schedule)
warehouse_saved_queries
Warehouse Saved Queries Run Create
Run this saved query.
warehouse_saved_queries
Warehouse Saved Queries Run History Retrieve
Return the recent run history (up to 5 most recent) for this materialized view.
warehouse_saved_queries
Warehouse Saved Queries Update
Create, Read, Update and Delete Warehouse Tables.
warehouse_saved_queries
Warehouse Saved Query Folders Create
Warehouse Saved Query Folders Create
warehouse_saved_query_folders
Warehouse Saved Query Folders Destroy
Warehouse Saved Query Folders Destroy
warehouse_saved_query_folders
Warehouse Saved Query Folders List
Warehouse Saved Query Folders List
warehouse_saved_query_folders
Warehouse Saved Query Folders Partial Update
Warehouse Saved Query Folders Partial Update
warehouse_saved_query_folders
Warehouse Saved Query Folders Retrieve
Warehouse Saved Query Folders Retrieve
warehouse_saved_query_folders
Warehouse Tables Create
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Warehouse Tables Destroy
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Warehouse Tables File Create
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Warehouse Tables List
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Warehouse Tables Partial Update
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Refresh table schema from source
Re-introspect a self-managed (manually linked) warehouse table's schema from its underlying source files and overwrite its stored column list. Use when the source schema has evolved (e.g. new columns in the underlying Delta/Parquet/CSV files) but queries still can't see the new columns, because PostHog serves a cached column snapshot until the table is refreshed. Not for tables managed by an external data source sync — those refresh on their own schedule.
warehouse_tables
Warehouse Tables Retrieve
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Warehouse Tables Update
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Warehouse Tables Update Schema Create
Create, Read, Update and Delete Warehouse Tables.
warehouse_tables
Warehouse View Link Create
Create, Read, Update and Delete View Columns.
warehouse_view_link
Warehouse View Link Destroy
Create, Read, Update and Delete View Columns.
warehouse_view_link
Warehouse View Link List
Create, Read, Update and Delete View Columns.
warehouse_view_link
Warehouse View Link Partial Update
Create, Read, Update and Delete View Columns.
warehouse_view_link
Warehouse View Link Retrieve
Create, Read, Update and Delete View Columns.
warehouse_view_link
Warehouse View Link Update
Create, Read, Update and Delete View Columns.
warehouse_view_link
Warehouse View Link Validate Create
Create, Read, Update and Delete View Columns.
warehouse_view_link
Warehouse View Links Create
Create, Read, Update and Delete View Columns.
warehouse_view_links
Warehouse View Links Destroy
Create, Read, Update and Delete View Columns.
warehouse_view_links
Warehouse View Links List
Create, Read, Update and Delete View Columns.
warehouse_view_links
Warehouse View Links Partial Update
Create, Read, Update and Delete View Columns.
warehouse_view_links
Warehouse View Links Retrieve
Create, Read, Update and Delete View Columns.
warehouse_view_links
Warehouse View Links Update
Create, Read, Update and Delete View Columns.
warehouse_view_links
Warehouse View Links Validate Create
Create, Read, Update and Delete View Columns.
warehouse_view_links
Acknowledge an achievement celebration
Clears a pending celebration for the given track and stage once the client has shown it, so it isn't celebrated again. Idempotent.
web_analytics_achievements
Get Web analytics achievements overview
Returns the achievement track definitions (thresholds resolved for the requesting user's streak-cadence arm), the user's and team's progress, and any newly unlocked stages awaiting an in-session celebration.
web_analytics_achievements
Get Web analytics achievements preferences
Returns the requesting user's per-project Web analytics achievements preferences.
web_analytics_achievements
Record a Web analytics interaction
Idempotently increments the requesting user's first-party counter for an in-product Web analytics interaction (slicing data, or opening a session recording), which drives the Explorer and Detective achievement tracks.
web_analytics_achievements
Record a Web analytics visit
Idempotently records that the requesting user opened Web analytics today (team-local date) and schedules a debounced achievement recompute. Intended to be called once per session.
web_analytics_achievements
Update Web analytics achievements preferences
Sets the requesting user's per-project Web analytics achievements preferences.
web_analytics_achievements
Weekly web analytics recap
The 'Wrapped'-style weekly recap: everything in the weekly digest (visitors, pageviews, sessions, bounce rate, average session duration with period-over-period comparisons, top pages, top sources, and goals) plus a single derived weekly persona and a short list of screenshot-worthy highlights for the period.
web_analyticsweb_analytics
Summarize web analytics
Summarizes a project's web analytics over a lookback window (default 7 days): unique visitors, pageviews, sessions, bounce rate, and average session duration with period-over-period comparisons, plus the top 5 pages, top 5 traffic sources, and goal conversions.
web_analyticsweb_analytics
Web Experiments Create
Web Experiments Create
web_experiments
Web Experiments Destroy
Web Experiments Destroy
web_experiments
Web Experiments List
Web Experiments List
web_experiments
Web Experiments Partial Update
Web Experiments Partial Update
web_experiments
Web Experiments Retrieve
Web Experiments Retrieve
web_experiments
Web Experiments Update
Web Experiments Update
web_experiments
Web Vitals Retrieve
Get web vitals for a specific pathname. Toolbar accesses this via OAuth (handled by TeamAndOrgViewSetMixin.get_authenticators).
web_vitals
Welcome Current Retrieve
Aggregated payload for the invited-user welcome screen.
organizationswelcome
Wizard Sessions Create
Upsert a wizard session. The `session_id` key is the idempotency anchor — reposting the same `session_id` replaces the existing row. Returns 201 on create, 200 on update.
wizard
Wizard Sessions Latest Retrieve
Return the single most-recent wizard session for a workflow (and optional skill), or 204 if none exists. Unlike `list`, this is a point lookup the app shell uses to decide whether to open the live SSE stream — it never returns a collection, and 'no run' is a 204 rather than a 404 so clients don't conflate it with a missing endpoint.
wizard
Wizard Sessions List
List wizard sessions for the project, ordered by started_at desc. This should only be called by the PostHog Wizard. Optional filters: ?workflow_id=<id> and ?skill_id=<id>.
wizard
Wizard Sessions Retrieve
Retrieve a single wizard session by its session_id.
wizard
Wizard Sessions Stream Retrieve
Server-Sent Events stream of wizard session updates for a (workflow_id, skill_id) pair. On connect, the current latest session (if any) is emitted as the first event; subsequent upserts are streamed in real time. The server closes the connection after 900 seconds with an `event: end` line so the client (EventSource) can reconnect. **SDK consumers**: do not call the generated fetch wrapper for this path — it will buffer the entire infinite stream. Use the URL builder (`getWizardSessionsStreamRetrieveUrl`) with the browser's `EventSource` API instead.
wizard
FAQ

PostHog integration, answered

How do AI agents use PostHog through Open Connector?
Your user connects PostHog once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes PostHog tools to your agent over MCP or a typed API, with credentials injected server-side on each call.
Is this a PostHog MCP server?
Yes. Open Connector can serve PostHog as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call PostHog actions with credentials injected server-side.
Where do PostHog credentials live?
In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

Give your agents PostHog — keep the keys.

Open source, self-hostable, with PostHog credentials that never leave your infrastructure. Run it from source today.

View source on GitHubHow the MCP gateway works →