Property definitions

Property

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

List all property definitions

Path Parameters

  • project_id
    string

Query Parameters

  • event_names
    string
  • excluded_properties
    string
  • filter_by_event_names
    boolean
  • group_type_index
    integer
  • is_feature_flag
    boolean
  • is_numerical
    boolean
  • limit
    integer
  • offset
    integer
  • properties
    string
  • search
    string
  • type
    string
    Default: event
    One of: "event""person""group"

Response


Request

GET /api/projects/:project_id/property_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/property_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",
      "is_numerical": true,
      "query_usage_30_day": -2147483648,
      "property_type": "DateTime",
      "tags": [
        null
      ],
      "is_seen_on_filtered_events": "string"
    }
  ]
}

Retrieve property definitions

Path Parameters

  • id
    string
  • project_id
    string

Response


Request

GET /api/projects/:project_id/property_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/property_definitions/:id/

Response

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "is_numerical": true,
  "query_usage_30_day": -2147483648,
  "property_type": "DateTime",
  "tags": [
    null
  ],
  "is_seen_on_filtered_events": "string"
}

Update property definitions

Path Parameters

  • id
    string
  • project_id
    string

Request Parameters

  • name
    string
  • is_numerical
    boolean
  • query_usage_30_day
    integer
  • property_type
    string
    One of: "DateTime""String""Numeric""Boolean"
  • tags
    array

Response


Request

PATCH /api/projects/:project_id/property_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/property_definitions/:id/\
	-d name="string"

Response

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "is_numerical": true,
  "query_usage_30_day": -2147483648,
  "property_type": "DateTime",
  "tags": [
    null
  ],
  "is_seen_on_filtered_events": "string"
}

Delete property definitions

Path Parameters

  • id
    string
  • project_id
    string

Request

DELETE /api/projects/:project_id/property_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/property_definitions/:id/

Response

No response

Questions?

Was this page useful?