Activity

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

List all activity log

Required API key scopes

activity_log:read

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

  • cursor
    string

    The pagination cursor value.

Response


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/

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": {
          "property1": null,
          "property2": null
        }
      },
      "unread": true,
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "was_impersonated": true,
      "is_system": true,
      "activity": "string",
      "item_id": "string",
      "scope": "string",
      "detail": null,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create activity log bookmark activity notification

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

  • user
  • organization_id
    string
  • was_impersonated
    boolean
  • is_system
    boolean
  • activity
    string
  • item_id
    string
  • scope
    string
  • detail
  • created_at
    string

Request

POST /api/projects/:project_id/activity_log/bookmark_activity_notification
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/projects/:project_id/activity_log/bookmark_activity_notification/\
	-d user=undefined,\
	-d activity="string",\
	-d scope="string"

Response

Status 200 No response body

Retrieve activity log important changes

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request

GET /api/projects/:project_id/activity_log/important_changes
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/important_changes/

Response

Status 200 No response body

Questions?

Was this page useful?