PostHog

PostHog activity_log API

The activity_log API from PostHog — 1 operation(s) for activity_log.

GitHub OpenAPI

Documentation

📖
Documentation
https://posthog.com/docs/api
📖
GettingStarted
https://posthog.com/docs/api
📖
Authentication
https://posthog.com/docs/api#authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/openapi/posthog-activity-log-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/asyncapi/posthog-webhooks-asyncapi.yml

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/graphql/posthog-graphql.md

OpenAPI Specification

posthog-activity-log-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: PostHog actions activity_log API
  version: 1.0.0
  description: ''
tags:
- name: activity_log
paths:
  /api/projects/{project_id}/activity_log/:
    get:
      operationId: activity_log_list
      parameters:
      - in: query
        name: item_id
        schema:
          type: string
          minLength: 1
        description: Filter by the ID of the affected resource.
      - in: query
        name: page
        schema:
          type: integer
          minimum: 1
        description: Page number for pagination. When provided, uses page-based pagination ordered by most recent first.
      - in: query
        name: page_size
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          default: 100
        description: 'Number of results per page (default: 100, max: 1000). Only used with page-based pagination.'
      - $ref: '#/components/parameters/ProjectIdPath'
      - in: query
        name: scope
        schema:
          enum:
          - Cohort
          - FeatureFlag
          - Person
          - Group
          - Insight
          - Plugin
          - PluginConfig
          - HogFunction
          - HogFlow
          - DataManagement
          - EventDefinition
          - PropertyDefinition
          - Notebook
          - Endpoint
          - EndpointVersion
          - Dashboard
          - Replay
          - Experiment
          - ExperimentHoldout
          - ExperimentSavedMetric
          - Survey
          - EarlyAccessFeature
          - SessionRecordingPlaylist
          - Comment
          - Team
          - Project
          - ErrorTrackingIssue
          - DataWarehouseSavedQuery
          - LegalDocument
          - Organization
          - OrganizationDomain
          - OrganizationMembership
          - Role
          - UserGroup
          - BatchExport
          - BatchImport
          - Integration
          - Annotation
          - Tag
          - TaggedItem
          - Subscription
          - PersonalAPIKey
          - ProjectSecretAPIKey
          - User
          - Action
          - AlertConfiguration
          - Threshold
          - AlertSubscription
          - ExternalDataSource
          - ExternalDataSchema
          - LLMTrace
          - WebAnalyticsFilterPreset
          - CustomerProfileConfig
          - Log
          - LogsAlertConfiguration
          - LogsExclusionRule
          - ProductTour
          - Ticket
          type: string
          minLength: 1
        description: 'Filter by a single activity scope, e.g. "FeatureFlag", "Insight", "Dashboard", "Experiment".


          * `Cohort` - Cohort

          * `FeatureFlag` - FeatureFlag

          * `Person` - Person

          * `Group` - Group

          * `Insight` - Insight

          * `Plugin` - Plugin

          * `PluginConfig` - PluginConfig

          * `HogFunction` - HogFunction

          * `HogFlow` - HogFlow

          * `DataManagement` - DataManagement

          * `EventDefinition` - EventDefinition

          * `PropertyDefinition` - PropertyDefinition

          * `Notebook` - Notebook

          * `Endpoint` - Endpoint

          * `EndpointVersion` - EndpointVersion

          * `Dashboard` - Dashboard

          * `Replay` - Replay

          * `Experiment` - Experiment

          * `ExperimentHoldout` - ExperimentHoldout

          * `ExperimentSavedMetric` - ExperimentSavedMetric

          * `Survey` - Survey

          * `EarlyAccessFeature` - EarlyAccessFeature

          * `SessionRecordingPlaylist` - SessionRecordingPlaylist

          * `Comment` - Comment

          * `Team` - Team

          * `Project` - Project

          * `ErrorTrackingIssue` - ErrorTrackingIssue

          * `DataWarehouseSavedQuery` - DataWarehouseSavedQuery

          * `LegalDocument` - LegalDocument

          * `Organization` - Organization

          * `OrganizationDomain` - OrganizationDomain

          * `OrganizationMembership` - OrganizationMembership

          * `Role` - Role

          * `UserGroup` - UserGroup

          * `BatchExport` - BatchExport

          * `BatchImport` - BatchImport

          * `Integration` - Integration

          * `Annotation` - Annotation

          * `Tag` - Tag

          * `TaggedItem` - TaggedItem

          * `Subscription` - Subscription

          * `PersonalAPIKey` - PersonalAPIKey

          * `ProjectSecretAPIKey` - ProjectSecretAPIKey

          * `User` - User

          * `Action` - Action

          * `AlertConfiguration` - AlertConfiguration

          * `Threshold` - Threshold

          * `AlertSubscription` - AlertSubscription

          * `ExternalDataSource` - ExternalDataSource

          * `ExternalDataSchema` - ExternalDataSchema

          * `LLMTrace` - LLMTrace

          * `WebAnalyticsFilterPreset` - WebAnalyticsFilterPreset

          * `CustomerProfileConfig` - CustomerProfileConfig

          * `Log` - Log

          * `LogsAlertConfiguration` - LogsAlertConfiguration

          * `LogsExclusionRule` - LogsExclusionRule

          * `ProductTour` - ProductTour

          * `Ticket` - Ticket'
      - in: query
        name: scopes
        schema:
          type: array
          items:
            enum:
            - Cohort
            - FeatureFlag
            - Person
            - Group
            - Insight
            - Plugin
            - PluginConfig
            - HogFunction
            - HogFlow
            - DataManagement
            - EventDefinition
            - PropertyDefinition
            - Notebook
            - Endpoint
            - EndpointVersion
            - Dashboard
            - Replay
            - Experiment
            - ExperimentHoldout
            - ExperimentSavedMetric
            - Survey
            - EarlyAccessFeature
            - SessionRecordingPlaylist
            - Comment
            - Team
            - Project
            - ErrorTrackingIssue
            - DataWarehouseSavedQuery
            - LegalDocument
            - Organization
            - OrganizationDomain
            - OrganizationMembership
            - Role
            - UserGroup
            - BatchExport
            - BatchImport
            - Integration
            - Annotation
            - Tag
            - TaggedItem
            - Subscription
            - PersonalAPIKey
            - ProjectSecretAPIKey
            - User
            - Action
            - AlertConfiguration
            - Threshold
            - AlertSubscription
            - ExternalDataSource
            - ExternalDataSchema
            - LLMTrace
            - WebAnalyticsFilterPreset
            - CustomerProfileConfig
            - Log
            - LogsAlertConfiguration
            - LogsExclusionRule
            - ProductTour
            - Ticket
            type: string
            description: '* `Cohort` - Cohort

              * `FeatureFlag` - FeatureFlag

              * `Person` - Person

              * `Group` - Group

              * `Insight` - Insight

              * `Plugin` - Plugin

              * `PluginConfig` - PluginConfig

              * `HogFunction` - HogFunction

              * `HogFlow` - HogFlow

              * `DataManagement` - DataManagement

              * `EventDefinition` - EventDefinition

              * `PropertyDefinition` - PropertyDefinition

              * `Notebook` - Notebook

              * `Endpoint` - Endpoint

              * `EndpointVersion` - EndpointVersion

              * `Dashboard` - Dashboard

              * `Replay` - Replay

              * `Experiment` - Experiment

              * `ExperimentHoldout` - ExperimentHoldout

              * `ExperimentSavedMetric` - ExperimentSavedMetric

              * `Survey` - Survey

              * `EarlyAccessFeature` - EarlyAccessFeature

              * `SessionRecordingPlaylist` - SessionRecordingPlaylist

              * `Comment` - Comment

              * `Team` - Team

              * `Project` - Project

              * `ErrorTrackingIssue` - ErrorTrackingIssue

              * `DataWarehouseSavedQuery` - DataWarehouseSavedQuery

              * `LegalDocument` - LegalDocument

              * `Organization` - Organization

              * `OrganizationDomain` - OrganizationDomain

              * `OrganizationMembership` - OrganizationMembership

              * `Role` - Role

              * `UserGroup` - UserGroup

              * `BatchExport` - BatchExport

              * `BatchImport` - BatchImport

              * `Integration` - Integration

              * `Annotation` - Annotation

              * `Tag` - Tag

              * `TaggedItem` - TaggedItem

              * `Subscription` - Subscription

              * `PersonalAPIKey` - PersonalAPIKey

              * `ProjectSecretAPIKey` - ProjectSecretAPIKey

              * `User` - User

              * `Action` - Action

              * `AlertConfiguration` - AlertConfiguration

              * `Threshold` - Threshold

              * `AlertSubscription` - AlertSubscription

              * `ExternalDataSource` - ExternalDataSource

              * `ExternalDataSchema` - ExternalDataSchema

              * `LLMTrace` - LLMTrace

              * `WebAnalyticsFilterPreset` - WebAnalyticsFilterPreset

              * `CustomerProfileConfig` - CustomerProfileConfig

              * `Log` - Log

              * `LogsAlertConfiguration` - LogsAlertConfiguration

              * `LogsExclusionRule` - LogsExclusionRule

              * `ProductTour` - ProductTour

              * `Ticket` - Ticket'
        description: Filter by multiple activity scopes, comma-separated. Values must be valid ActivityScope enum values. E.g. "FeatureFlag,Insight".
      - in: query
        name: user
        schema:
          type: string
          format: uuid
        description: Filter by user UUID who performed the action.
      tags:
      - activity_log
      security:
      - PersonalAPIKeyAuth:
        - activity_log:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedActivityLogList'
          description: ''
      x-explicit-tags:
      - activity_logs
      - platform_features
components:
  schemas:
    BlankEnum:
      enum:
      - ''
    ActivityLog:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        user:
          $ref: '#/components/schemas/UserBasic'
        unread:
          type: boolean
          description: is the date of this log item newer than the user's bookmark
          readOnly: true
        organization_id:
          type: string
          format: uuid
          nullable: true
        was_impersonated:
          type: boolean
          nullable: true
        is_system:
          type: boolean
          nullable: true
        client:
          type: string
          nullable: true
          maxLength: 32
        activity:
          type: string
          maxLength: 79
        item_id:
          type: string
          nullable: true
          maxLength: 72
        scope:
          type: string
          maxLength: 79
        detail:
          nullable: true
        created_at:
          type: string
          format: date-time
      required:
      - activity
      - id
      - scope
      - unread
      - user
    UserBasic:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        uuid:
          type: string
          format: uuid
          readOnly: true
        distinct_id:
          type: string
          nullable: true
          maxLength: 200
        first_name:
          type: string
          maxLength: 150
        last_name:
          type: string
          maxLength: 150
        email:
          type: string
          format: email
          title: Email address
          maxLength: 254
        is_email_verified:
          type: boolean
          nullable: true
        hedgehog_config:
          type: object
          additionalProperties: true
          nullable: true
          readOnly: true
        role_at_organization:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/RoleAtOrganizationEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
      required:
      - email
      - hedgehog_config
      - id
      - uuid
    RoleAtOrganizationEnum:
      enum:
      - engineering
      - data
      - product
      - founder
      - leadership
      - marketing
      - sales
      - other
      type: string
      description: '* `engineering` - Engineering

        * `data` - Data

        * `product` - Product Management

        * `founder` - Founder

        * `leadership` - Leadership

        * `marketing` - Marketing

        * `sales` - Sales / Success

        * `other` - Other'
    PaginatedActivityLogList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/ActivityLog'
    NullEnum:
      enum:
      - null
  parameters:
    ProjectIdPath:
      in: path
      name: project_id
      required: true
      schema:
        type: string
      description: Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
  securitySchemes:
    PersonalAPIKeyAuth:
      type: http
      scheme: bearer
x-tagGroups:
- name: All endpoints
  tags:
  - LLM Analytics
  - actions
  - activity_log
  - activity_logs
  - advanced_activity_logs
  - alerts
  - annotations
  - approval_policies
  - batch_exports
  - cdp
  - change_requests
  - code
  - code-invites
  - cohorts
  - comments
  - conversations
  - core
  - customer_analytics
  - customer_journeys
  - customer_profile_configs
  - dashboard_templates
  - dashboards
  - data_color_themes
  - data_modeling_jobs
  - data_warehouse
  - dataset_items
  - datasets
  - desktop_recordings
  - domains
  - early_access_feature
  - early_access_features
  - elements
  - endpoints
  - environments
  - error_tracking
  - evaluation_runs
  - evaluations
  - event_definitions
  - event_filter
  - event_schemas
  - events
  - experiment_holdouts
  - experiment_saved_metrics
  - experiments
  - exports
  - external_data_schemas
  - external_data_sources
  - feature_flags
  - file_system
  - file_system_shortcut
  - flag_value
  - groups
  - groups_types
  - health_issues
  - heatmap_screenshots
  - heatmaps
  - hog_flows
  - hog_function_templates
  - hog_functions
  - insight_variables
  - insights
  - integrations
  - invites
  - js-snippet
  - legal_documents
  - lineage
  - live_debugger_breakpoints
  - llm_analytics
  - llm_prompts
  - llm_skills
  - logs
  - managed_viewsets
  - max
  - max_tools
  - mcp_server_installations
  - mcp_servers
  - mcp_store
  - mcp_tools
  - members
  - notebooks
  - oauth_applications
  - object_media_previews
  - organizations
  - persisted_folder
  - persons
  - platform_features
  - plugin_configs
  - product_analytics
  - product_tours
  - project_secret_api_keys
  - projects
  - property_definitions
  - proxy_records
  - public_hog_function_templates
  - query
  - replay
  - reverse_proxy
  - role_external_references
  - roles
  - sandbox-environments
  - sandbox_environments
  - saved
  - schema_property_groups
  - sdk_doctor
  - session_group_summaries
  - session_recording_playlists
  - session_recordings
  - session_summaries
  - sessions
  - signals
  - subscriptions
  - surveys
  - taggers
  - task-automations
  - task-runs
  - task_automations
  - tasks
  - uploaded_media
  - user_home_settings
  - user_interviews
  - users
  - visual_review
  - warehouse_dag
  - warehouse_model_paths
  - warehouse_saved_queries
  - warehouse_saved_query_folders
  - warehouse_tables
  - warehouse_view_link
  - warehouse_view_links
  - web_analytics
  - web_experiments
  - web_vitals
  - welcome
  - workflows