Permission Setup Review
python scripts/_prepare_workspace.py is an optional setup helper for the PostHog API Skill skill. It may apply broad filesystem permissions for compatibility. Show the target paths and permission mode, explain the risk, and prefer a narrower mode when shared write access is not needed.
PostHog API Skill
Interact with PostHog via its REST API. Two types of endpoints:
- Public (POST-only, project API key): capture events, evaluate flags — no rate limits
- Private (personal API key): query, CRUD for all resources — rate limited
Setup
- Get personal API key: https://us.posthog.com/settings/user-api-keys
- Get project ID: https://us.posthog.com/settings/project#variables
- Set env vars:
export POSTHOG_API_KEY="phx_..."
export POSTHOG_PROJECT_ID="12345"
export POSTHOG_PROJECT_API_KEY="phc_..." # optional, for capture/flags
# For EU Cloud:
# export POSTHOG_HOST="https://eu.posthog.com"
# export POSTHOG_INGEST_HOST="https://eu.i.posthog.com"
- Verify:
bash scripts/posthog.sh whoami
Helper Script
scripts/posthog.sh wraps common operations. Run bash scripts/posthog.sh help for full usage.
Examples
# Capture an event
bash scripts/posthog.sh capture "signup" "user_123" '{"plan":"pro"}'
# Evaluate feature flags
bash scripts/posthog.sh evaluate-flags "user_123"
# HogQL query — top events last 7 days
bash scripts/posthog.sh query "SELECT event, count() FROM events WHERE timestamp >= now() - INTERVAL 7 DAY GROUP BY event ORDER BY count() DESC LIMIT 20"
# List persons
bash scripts/posthog.sh list-persons 10 | jq '.results[] | {name, distinct_ids}'
# List feature flags
bash scripts/posthog.sh list-flags | jq '.results[] | {id, key, active}'
# Create a feature flag
echo '{"key":"new-dashboard","name":"New Dashboard","active":true,"filters":{"groups":[{"rollout_percentage":50}]}}' | \
bash scripts/posthog.sh create-flag
# List dashboards
bash scripts/posthog.sh list-dashboards | jq '.results[] | {id, name}'
Key Concepts
Two API types
- Public endpoints (
/i/v0/e/, /batch/, /flags): Use project API key in body. No auth header. No rate limits.
- Private endpoints (
/api/projects/:project_id/...): Use personal API key via Authorization: Bearer. Rate limited.
HogQL Queries
The query endpoint (POST /api/projects/:project_id/query/) is the most powerful way to extract data. Uses SQL-like HogQL syntax against tables: events, persons, sessions, groups, plus data warehouse tables.
Always include time ranges and LIMIT. Use timestamp-based pagination for large exports.
Rate Limits (private endpoints)
| Type |
Limit |
| Analytics (insights, persons, recordings) |
240/min, 1200/hr |
| Query endpoint |
2400/hr |
| Feature flag local evaluation |
600/min |
| Other CRUD |
480/min, 4800/hr |
Limits apply per organization. On 429: back off and retry.
Domains
| Cloud |
Public |
Private |
| US |
us.i.posthog.com |
us.posthog.com |
| EU |
eu.i.posthog.com |
eu.posthog.com |
Events API (deprecated)
The /api/projects/:project_id/events/ endpoint is deprecated. Use HogQL queries or batch exports instead.
Direct curl
# Private endpoint
curl -H "Authorization: Bearer $POSTHOG_API_KEY" \
"$POSTHOG_HOST/api/projects/$POSTHOG_PROJECT_ID/feature_flags/"
# HogQL query
curl -H "Authorization: Bearer $POSTHOG_API_KEY" \
-H "Content-Type: application/json" \
-X POST -d '{"query":{"kind":"HogQLQuery","query":"SELECT count() FROM events WHERE timestamp >= now() - INTERVAL 1 DAY"}}' \
"$POSTHOG_HOST/api/projects/$POSTHOG_PROJECT_ID/query/"
# Capture event (public)
curl -H "Content-Type: application/json" \
-X POST -d '{"api_key":"'$POSTHOG_PROJECT_API_KEY'","event":"test","distinct_id":"u1"}' \
"$POSTHOG_INGEST_HOST/i/v0/e/"
Full API Reference
See references/api-endpoints.md for complete endpoint listing with parameters, body schemas, scopes, and response formats.
Sections: Public Endpoints (Capture, Batch, Flags), Private Endpoints (Persons, Feature Flags, Insights, Dashboards, Annotations, Cohorts, Experiments, Surveys, Actions, Session Recordings, Users, Definitions), Query API (HogQL).
1---2name: posthog-23description: Interact with PostHog analytics via its REST API. Capture events, evaluate feature flags, query data with HogQL, manage persons, insights, dashboards, experiments, surveys, cohorts, annotations, and session recordings. Use when the user mentions "PostHog", "PostHog API", "PostHog events", "PostHog feature flags", "PostHog insights", "PostHog query", "HogQL", "PostHog persons", "PostHog dashboards", "PostHog experiments", "PostHog surveys", "PostHog cohorts", "PostHog recordings", "capture events PostHog", or "PostHog analytics".4---56789### Permission Setup Review1011`python scripts/_prepare_workspace.py` is an optional setup helper for the `PostHog API Skill` skill. It may apply broad filesystem permissions for compatibility. Show the target paths and permission mode, explain the risk, and prefer a narrower mode when shared write access is not needed.1213# PostHog API Skill1415Interact with PostHog via its REST API. Two types of endpoints:16- **Public** (POST-only, project API key): capture events, evaluate flags — no rate limits17- **Private** (personal API key): query, CRUD for all resources — rate limited1819## Setup20211. Get personal API key: https://us.posthog.com/settings/user-api-keys222. Get project ID: https://us.posthog.com/settings/project#variables233. Set env vars:24 ```bash25 export POSTHOG_API_KEY="phx_..."26 export POSTHOG_PROJECT_ID="12345"27 export POSTHOG_PROJECT_API_KEY="phc_..." # optional, for capture/flags28 # For EU Cloud:29 # export POSTHOG_HOST="https://eu.posthog.com"30 # export POSTHOG_INGEST_HOST="https://eu.i.posthog.com"31 ```324. Verify: `bash scripts/posthog.sh whoami`3334## Helper Script3536`scripts/posthog.sh` wraps common operations. Run `bash scripts/posthog.sh help` for full usage.3738### Examples3940```bash41# Capture an event42bash scripts/posthog.sh capture "signup" "user_123" '{"plan":"pro"}'4344# Evaluate feature flags45bash scripts/posthog.sh evaluate-flags "user_123"4647# HogQL query — top events last 7 days48bash scripts/posthog.sh query "SELECT event, count() FROM events WHERE timestamp >= now() - INTERVAL 7 DAY GROUP BY event ORDER BY count() DESC LIMIT 20"4950# List persons51bash scripts/posthog.sh list-persons 10 | jq '.results[] | {name, distinct_ids}'5253# List feature flags54bash scripts/posthog.sh list-flags | jq '.results[] | {id, key, active}'5556# Create a feature flag57echo '{"key":"new-dashboard","name":"New Dashboard","active":true,"filters":{"groups":[{"rollout_percentage":50}]}}' | \58 bash scripts/posthog.sh create-flag5960# List dashboards61bash scripts/posthog.sh list-dashboards | jq '.results[] | {id, name}'62```6364## Key Concepts6566### Two API types67- **Public endpoints** (`/i/v0/e/`, `/batch/`, `/flags`): Use project API key in body. No auth header. No rate limits.68- **Private endpoints** (`/api/projects/:project_id/...`): Use personal API key via `Authorization: Bearer`. Rate limited.6970### HogQL Queries71The query endpoint (`POST /api/projects/:project_id/query/`) is the most powerful way to extract data. Uses SQL-like HogQL syntax against tables: `events`, `persons`, `sessions`, `groups`, plus data warehouse tables.7273Always include time ranges and LIMIT. Use timestamp-based pagination for large exports.7475### Rate Limits (private endpoints)76| Type | Limit |77|------|-------|78| Analytics (insights, persons, recordings) | 240/min, 1200/hr |79| Query endpoint | 2400/hr |80| Feature flag local evaluation | 600/min |81| Other CRUD | 480/min, 4800/hr |8283Limits apply per organization. On 429: back off and retry.8485### Domains86| Cloud | Public | Private |87|-------|--------|---------|88| US | `us.i.posthog.com` | `us.posthog.com` |89| EU | `eu.i.posthog.com` | `eu.posthog.com` |9091### Events API (deprecated)92The `/api/projects/:project_id/events/` endpoint is deprecated. Use HogQL queries or batch exports instead.9394## Direct curl9596```bash97# Private endpoint98curl -H "Authorization: Bearer $POSTHOG_API_KEY" \99 "$POSTHOG_HOST/api/projects/$POSTHOG_PROJECT_ID/feature_flags/"100101# HogQL query102curl -H "Authorization: Bearer $POSTHOG_API_KEY" \103 -H "Content-Type: application/json" \104 -X POST -d '{"query":{"kind":"HogQLQuery","query":"SELECT count() FROM events WHERE timestamp >= now() - INTERVAL 1 DAY"}}' \105 "$POSTHOG_HOST/api/projects/$POSTHOG_PROJECT_ID/query/"106107# Capture event (public)108curl -H "Content-Type: application/json" \109 -X POST -d '{"api_key":"'$POSTHOG_PROJECT_API_KEY'","event":"test","distinct_id":"u1"}' \110 "$POSTHOG_INGEST_HOST/i/v0/e/"111```112113## Full API Reference114115See [references/api-endpoints.md](references/api-endpoints.md) for complete endpoint listing with parameters, body schemas, scopes, and response formats.116117Sections: Public Endpoints (Capture, Batch, Flags), Private Endpoints (Persons, Feature Flags, Insights, Dashboards, Annotations, Cohorts, Experiments, Surveys, Actions, Session Recordings, Users, Definitions), Query API (HogQL).