naftiko: 1.0.0-alpha2 info: label: PostHog API description: PostHog API API capability. tags: - Posthog - API created: '2026-05-06' modified: '2026-05-06' capability: consumes: - type: http namespace: posthog baseUri: https://api.example.com description: PostHog API HTTP API. authentication: type: bearer token: '{{POSTHOG_TOKEN}}' resources: - name: api-code-invites-check-access path: /api/code/invites/check-access/ operations: - name: code-invites-check-access-retrieve method: GET description: Check access outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-code-invites-redeem path: /api/code/invites/redeem/ operations: - name: code-invites-redeem-create method: POST description: Redeem invite code outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-alerts path: /api/environments/{environment_id}/alerts/ operations: - name: environments-alerts-list method: GET description: GET /api/environments/{environment_id}/alerts/ inputParameters: - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-alerts-create method: POST description: POST /api/environments/{environment_id}/alerts/ outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-alerts-id path: /api/environments/{environment_id}/alerts/{id}/ operations: - name: environments-alerts-retrieve method: GET description: GET /api/environments/{environment_id}/alerts/{id}/ inputParameters: - name: checks_date_from in: query type: string description: Relative date string for the start of the check history window (e.g. '-24h', '-7d', '-14d'). Returns checks created after this time. Max retention is 14 days. - name: checks_date_to in: query type: string description: Relative date string for the end of the check history window (e.g. '-1h', '-1d'). Defaults to now if not specified. - name: checks_limit in: query type: integer description: Maximum number of check results to return (default 5, max 500). Applied after date filtering. - name: checks_offset in: query type: integer description: Number of newest checks to skip (0-based). Use with checks_limit for pagination. Default 0. - name: id in: path type: string required: true description: A UUID string identifying this alert configuration. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-alerts-update method: PUT description: PUT /api/environments/{environment_id}/alerts/{id}/ inputParameters: - name: id in: path type: string required: true description: A UUID string identifying this alert configuration. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-alerts-partial-update method: PATCH description: PATCH /api/environments/{environment_id}/alerts/{id}/ inputParameters: - name: id in: path type: string required: true description: A UUID string identifying this alert configuration. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-alerts-destroy method: DELETE description: DELETE /api/environments/{environment_id}/alerts/{id}/ inputParameters: - name: id in: path type: string required: true description: A UUID string identifying this alert configuration. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-alerts-simulate path: /api/environments/{environment_id}/alerts/simulate/ operations: - name: environments-alerts-simulate-create method: POST description: Simulate a detector on an insight's historical data. Read-only — no AlertCheck records are created. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports path: /api/environments/{environment_id}/batch_exports/ operations: - name: environments-batch-exports-list method: GET description: GET /api/environments/{environment_id}/batch_exports/ inputParameters: - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-batch-exports-create method: POST description: POST /api/environments/{environment_id}/batch_exports/ outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-ba path: /api/environments/{environment_id}/batch_exports/{batch_export_id}/backfills/ operations: - name: environments-batch-exports-backfills-list method: GET description: ViewSet for BatchExportBackfill models. Allows creating and reading backfills, but not updating or deleting them. inputParameters: - name: batch_export_id in: path type: string required: true - name: cursor in: query type: string description: The pagination cursor value. - name: ordering in: query type: string description: Which field to use when ordering the results. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-batch-exports-backfills-create method: POST description: Create a new backfill for a BatchExport. inputParameters: - name: batch_export_id in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-ba path: /api/environments/{environment_id}/batch_exports/{batch_export_id}/backfills/{id}/ operations: - name: environments-batch-exports-backfills-retrieve method: GET description: ViewSet for BatchExportBackfill models. Allows creating and reading backfills, but not updating or deleting them. inputParameters: - name: batch_export_id in: path type: string required: true - name: id in: path type: string required: true description: A UUID string identifying this batch export backfill. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-ba path: /api/environments/{environment_id}/batch_exports/{batch_export_id}/backfills/{id}/cancel/ operations: - name: environments-batch-exports-backfills-cancel-crea method: POST description: Cancel a batch export backfill. inputParameters: - name: batch_export_id in: path type: string required: true - name: id in: path type: string required: true description: A UUID string identifying this batch export backfill. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-ba path: /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/ operations: - name: environments-batch-exports-runs-list method: GET description: GET /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/ inputParameters: - name: batch_export_id in: path type: string required: true - name: cursor in: query type: string description: The pagination cursor value. - name: ordering in: query type: string description: Which field to use when ordering the results. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-ba path: /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/ operations: - name: environments-batch-exports-runs-retrieve method: GET description: GET /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/ inputParameters: - name: batch_export_id in: path type: string required: true - name: id in: path type: string required: true description: A UUID string identifying this batch export run. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-ba path: /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/cancel/ operations: - name: environments-batch-exports-runs-cancel-create method: POST description: Cancel a batch export run. inputParameters: - name: batch_export_id in: path type: string required: true - name: id in: path type: string required: true description: A UUID string identifying this batch export run. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-ba path: /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/logs/ operations: - name: environments-batch-exports-runs-logs-retrieve method: GET description: GET /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/logs/ inputParameters: - name: after in: query type: string description: Only return entries after this ISO 8601 timestamp. - name: batch_export_id in: path type: string required: true - name: before in: query type: string description: Only return entries before this ISO 8601 timestamp. - name: id in: path type: string required: true description: A UUID string identifying this batch export run. - name: instance_id in: query type: string description: Filter logs to a specific execution instance. - name: level in: query type: string description: 'Comma-separated log levels to include, e.g. ''WARN,ERROR''. Valid levels: DEBUG, LOG, INFO, WARN, ERROR.' - name: limit in: query type: integer description: Maximum number of log entries to return (1-500, default 50). - name: search in: query type: string description: Case-insensitive substring search across log messages. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-ba path: /api/environments/{environment_id}/batch_exports/{batch_export_id}/runs/{id}/retry/ operations: - name: environments-batch-exports-runs-retry-create method: POST description: 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. inputParameters: - name: batch_export_id in: path type: string required: true - name: id in: path type: string required: true description: A UUID string identifying this batch export run. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-id path: /api/environments/{environment_id}/batch_exports/{id}/ operations: - name: environments-batch-exports-retrieve method: GET description: GET /api/environments/{environment_id}/batch_exports/{id}/ inputParameters: - name: id in: path type: string required: true description: A UUID string identifying this batch export. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-batch-exports-update method: PUT description: PUT /api/environments/{environment_id}/batch_exports/{id}/ inputParameters: - name: id in: path type: string required: true description: A UUID string identifying this batch export. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-batch-exports-partial-update method: PATCH description: PATCH /api/environments/{environment_id}/batch_exports/{id}/ inputParameters: - name: id in: path type: string required: true description: A UUID string identifying this batch export. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-batch-exports-destroy method: DELETE description: DELETE /api/environments/{environment_id}/batch_exports/{id}/ inputParameters: - name: id in: path type: string required: true description: A UUID string identifying this batch export. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-id path: /api/environments/{environment_id}/batch_exports/{id}/logs/ operations: - name: environments-batch-exports-logs-retrieve method: GET description: GET /api/environments/{environment_id}/batch_exports/{id}/logs/ inputParameters: - name: after in: query type: string description: Only return entries after this ISO 8601 timestamp. - name: before in: query type: string description: Only return entries before this ISO 8601 timestamp. - name: id in: path type: string required: true description: A UUID string identifying this batch export. - name: instance_id in: query type: string description: Filter logs to a specific execution instance. - name: level in: query type: string description: 'Comma-separated log levels to include, e.g. ''WARN,ERROR''. Valid levels: DEBUG, LOG, INFO, WARN, ERROR.' - name: limit in: query type: integer description: Maximum number of log entries to return (1-500, default 50). - name: search in: query type: string description: Case-insensitive substring search across log messages. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-id path: /api/environments/{environment_id}/batch_exports/{id}/pause/ operations: - name: environments-batch-exports-pause-create method: POST description: Pause a BatchExport. inputParameters: - name: id in: path type: string required: true description: A UUID string identifying this batch export. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-id path: /api/environments/{environment_id}/batch_exports/{id}/run_test_step/ operations: - name: environments-batch-exports-run-test-step-create method: POST description: POST /api/environments/{environment_id}/batch_exports/{id}/run_test_step/ inputParameters: - name: id in: path type: string required: true description: A UUID string identifying this batch export. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-id path: /api/environments/{environment_id}/batch_exports/{id}/unpause/ operations: - name: environments-batch-exports-unpause-create method: POST description: Unpause a BatchExport. inputParameters: - name: id in: path type: string required: true description: A UUID string identifying this batch export. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-ru path: /api/environments/{environment_id}/batch_exports/run_test_step_new/ operations: - name: environments-batch-exports-run-test-step-new-cre method: POST description: POST /api/environments/{environment_id}/batch_exports/run_test_step_new/ outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-batch-exports-te path: /api/environments/{environment_id}/batch_exports/test/ operations: - name: environments-batch-exports-test-retrieve method: GET description: GET /api/environments/{environment_id}/batch_exports/test/ outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-dashboards path: /api/environments/{environment_id}/dashboards/ operations: - name: environments-dashboards-list method: GET description: GET /api/environments/{environment_id}/dashboards/ inputParameters: - name: format in: query type: string - name: limit in: query type: integer description: Number of results to return per page. - name: offset in: query type: integer description: The initial index from which to return the results. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-dashboards-create method: POST description: POST /api/environments/{environment_id}/dashboards/ inputParameters: - name: format in: query type: string outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-dashboards-dashb path: /api/environments/{environment_id}/dashboards/{dashboard_id}/collaborators/ operations: - name: environments-dashboards-collaborators-list method: GET description: GET /api/environments/{environment_id}/dashboards/{dashboard_id}/collaborators/ inputParameters: - name: dashboard_id in: path type: integer required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: environments-dashboards-collaborators-create method: POST description: POST /api/environments/{environment_id}/dashboards/{dashboard_id}/collaborators/ inputParameters: - name: dashboard_id in: path type: integer required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-dashboards-dashb path: /api/environments/{environment_id}/dashboards/{dashboard_id}/collaborators/{user__uuid}/ operations: - name: environments-dashboards-collaborators-destroy method: DELETE description: DELETE /api/environments/{environment_id}/dashboards/{dashboard_id}/collaborators/{user__uuid}/ inputParameters: - name: dashboard_id in: path type: integer required: true - name: user__uuid in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-dashboards-dashb path: /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/ operations: - name: environments-dashboards-sharing-list method: GET description: GET /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/ inputParameters: - name: dashboard_id in: path type: integer required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-dashboards-dashb path: /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/passwords/ operations: - name: environments-dashboards-sharing-passwords-create method: POST description: Create a new password for the sharing configuration. inputParameters: - name: dashboard_id in: path type: integer required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-dashboards-dashb path: /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/passwords/{password_id}/ operations: - name: environments-dashboards-sharing-passwords-destro method: DELETE description: Delete a password from the sharing configuration. inputParameters: - name: dashboard_id in: path type: integer required: true - name: password_id in: path type: string required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-dashboards-dashb path: /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/refresh/ operations: - name: environments-dashboards-sharing-refresh-create method: POST description: POST /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/refresh/ inputParameters: - name: dashboard_id in: path type: integer required: true outputRawFormat: json outputParameters: - name: result type: object value: $. - name: api-environments-environment-id-dashboards-id path: /api/environments/{environment_id}/dashboards/{id}/ operations: - name: environments-dashboards-retrieve method: GET description: GET /api/environments/{environment_id}/dashboards/{id}/ inputParameters: - name: filters_override in: query type: string description: JSON object to override dashboard filters for this request only (not persisted). Top-level keys replace; nested values are not deep-merged — pass the complete v - name: format in: query type: string - name: id in: path type: integer required: true description: A unique integer value identifying this dashboard. - name: variables_override in: query type: string description: 'JSON object to override dashboard variables for this request only (not persisted). Format: {"": {"code_name": "", "variableId": "": {"code_name": "", "variableId": "": {"code_name": "", "variableId": "": {"code_name": "", "variableId": "": {"code_name": "", "variableId": "": {"code_name": "", "variableId": "