Event definitions

Event

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

List all event definitions

Path Parameters

  • project_id
    string

Query Parameters

  • limit
    integer
  • offset
    integer

Response


Request

GET /api/projects/:project_id/event_definitions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/projects/:project_id/event_definitions/

Response

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "volume_30_day": -2147483648,
      "query_usage_30_day": -2147483648,
      "created_at": "2019-08-24T14:15:22Z",
      "last_seen_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "tags": [
        null
      ],
      "is_action": "string",
      "action_id": 0,
      "is_calculating": true,
      "last_calculated_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "email": "user@example.com",
        "is_email_verified": true
      },
      "post_to_slack": false
    }
  ]
}

Retrieve event definitions

Path Parameters

  • id
    string
  • project_id
    string

Response


Request

GET /api/projects/:project_id/event_definitions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/projects/:project_id/event_definitions/:id/

Response

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "volume_30_day": -2147483648,
  "query_usage_30_day": -2147483648,
  "created_at": "2019-08-24T14:15:22Z",
  "last_seen_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "tags": [
    null
  ],
  "is_action": "string",
  "action_id": 0,
  "is_calculating": true,
  "last_calculated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "email": "user@example.com",
    "is_email_verified": true
  },
  "post_to_slack": false
}

Update event definitions

Path Parameters

  • id
    string
  • project_id
    string

Request Parameters

  • name
    string
  • volume_30_day
    integer
  • query_usage_30_day
    integer
  • created_at
    string
  • last_seen_at
    string
  • tags
    array
  • post_to_slack
    boolean

Response


Request

PATCH /api/projects/:project_id/event_definitions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/projects/:project_id/event_definitions/:id/\
	-d name="string"

Response

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "volume_30_day": -2147483648,
  "query_usage_30_day": -2147483648,
  "created_at": "2019-08-24T14:15:22Z",
  "last_seen_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "tags": [
    null
  ],
  "is_action": "string",
  "action_id": 0,
  "is_calculating": true,
  "last_calculated_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "email": "user@example.com",
    "is_email_verified": true
  },
  "post_to_slack": false
}

Delete event definitions

Path Parameters

  • id
    string
  • project_id
    string

Request

DELETE /api/projects/:project_id/event_definitions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/projects/:project_id/event_definitions/:id/

Response

No response

Questions?

Was this page useful?