Activity

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

GET
GET
POST
GET

List all org organizations advanced activity logs

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.

Required API key scopes

activity_log:read

Query parameters

  • activities
    array
    Default:
  • clients
    array
    Default:
  • detail_filters
    string
  • end_date
    string
  • follow
    boolean
    Default: false
  • hogql_filter
    string
  • include_values
    boolean
    Default: false
  • ip_addresses
    array
    Default:
  • is_system
    boolean | null
  • item_ids
    array
    Default:
  • ordering
    string
    Default: -created_at
    One of: "-created_at""created_at"
  • page
    integer
  • page_size
    integer
    Default: 100
  • schema
    string
    One of: "ocsf"
  • scopes
    array
    Default:
  • search_text
    string
  • start_date
    string
  • team_ids
    array
    Default:
  • users
    array
    Default:
  • was_impersonated
    boolean | null

Response


Example request

GET /api/organizations/:organization_id/advanced_activity_logs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/advanced_activity_logs/

Example response

Status 200
RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "user": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "unread": true,
      "team_id": 2147483647,
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "was_impersonated": true,
      "is_system": true,
      "client": "string",
      "ip_address": "string",
      "activity": "string",
      "item_id": "string",
      "scope": "string",
      "detail": null,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "count": 123
}

Retrieve org organizations advanced activity logs available filters

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.

Required API key scopes

activity_log:read

Response


Example request

GET /api/organizations/:organization_id/advanced_activity_logs/available_filters
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/advanced_activity_logs/available_filters/

Example response

Status 200
RESPONSE
{
  "static_filters": {
    "users": [
      {}
    ],
    "scopes": [
      {}
    ],
    "activities": [
      {}
    ],
    "clients": [
      {}
    ]
  },
  "detail_fields": {}
}

Create org organizations advanced activity logs export

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.

Request parameters

  • user
  • team_id
    integer | null
  • organization_id
    string | null
  • was_impersonated
    boolean | null
  • is_system
    boolean | null
  • client
    string | null
  • ip_address
    string | null
  • activity
    string
  • item_id
    string | null
  • scope
    string
  • detail
  • created_at
    string

Response


Example request

POST /api/organizations/:organization_id/advanced_activity_logs/export
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/advanced_activity_logs/export/\
	-d user=undefined,\
	-d activity="string",\
	-d scope="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "user": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "unread": true,
  "team_id": 2147483647,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "was_impersonated": true,
  "is_system": true,
  "client": "string",
  "ip_address": "string",
  "activity": "string",
  "item_id": "string",
  "scope": "string",
  "detail": null,
  "created_at": "2019-08-24T14:15:22Z"
}

List all activity log

Required API key scopes

activity_log:read

Query parameters

  • item_id
    string
  • ordering
    string
    Default: -created_at
    One of: "-created_at""created_at"
  • page
    integer
  • page_size
    integer
    Default: 100
  • scope
    string
    One of: "Cohort""CrossProjectDashboard""DevGatewayToken""FeatureFlag""Person""Group""Insight""Plugin""PluginConfig""HogFunction""HogFlow""DataManagement""EventDefinition""PropertyDefinition""Notebook""GeneratedWidget""Canvas""Endpoint""EndpointVersion""Dashboard""Replay""Experiment""ExperimentHoldout""ExperimentSavedMetric""Survey""EarlyAccessFeature""SessionRecordingPlaylist""ReplayScanner""VisionAlertConfiguration""Comment""Team""Project""ErrorTrackingIssue""DataWarehouseExpression""DataWarehouseSavedQuery""LegalDocument""Organization""OrganizationDomain""IdentityProviderConfig""OrganizationMembership""Role""UserGroup""BatchExport""BatchImport""ExportedAsset""Integration""Annotation""Tag""TaggedItem""Subscription""PersonalAPIKey""ProjectSecretAPIKey""OAuthApplication""User""Action""AccountView""AlertConfiguration""Threshold""AlertSubscription""ExternalDataSource""ExternalDataSchema""Evaluation""EvaluationDirectory""LLMPrompt""LLMPromptLabel""LLMSkill""LLMTrace""AIGatewayCredit""WebAnalyticsFilterPreset""CustomerProfileConfig""Log""LogsAlertConfiguration""PlatformAlertConfiguration""LogsExclusionRule""LogsRetentionRule""TracesRetentionRule""DashboardWidget""ProductTour""Ticket""KnowledgeSource""KnowledgeLibrary""InstanceSetting""SignalReport""SignalScoutConfig""SignalTeamConfig""StreamlitApp""Metric""TableCertification""DataQualityCheck""DataQualityCheckSchedule""WarehouseSuggestion""AccessControl""DataWarehouseTable""DataWarehouseJoin""Billing""Loop""StamphogRepoConfig""ReviewRepository""ReviewProjectSettings""ReviewInstallationClaim"
  • scopes
    array
  • user
    string

Response


Example request

GET /api/projects/:project_id/activity_log
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/activity_log/

Example response

Status 200
RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "user": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "unread": true,
      "team_id": 2147483647,
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "was_impersonated": true,
      "is_system": true,
      "client": "string",
      "ip_address": "string",
      "activity": "string",
      "item_id": "string",
      "scope": "string",
      "detail": null,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "count": 123
}