Property
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
List all property definitions
Path Parameters
- project_idstring
Query Parameters
- event_namesstring
- excluded_propertiesstring
- filter_by_event_namesboolean
- group_type_indexinteger
- is_feature_flagboolean
- is_numericalboolean
- limitinteger
- offsetinteger
- propertiesstring
- searchstring
- typestringDefault:
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,"property_type": "DateTime","tags": [null],"is_seen_on_filtered_events": "string"}]}
Retrieve property definitions
Path Parameters
- idstring
- project_idstring
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,"property_type": "DateTime","tags": [null],"is_seen_on_filtered_events": "string"}
Update property definitions
Path Parameters
- idstring
- project_idstring
Request Parameters
- namestring
- is_numericalboolean
- property_typestringOne of:
"DateTime"
"String"
"Numeric"
"Boolean"
- tagsarray
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,"property_type": "DateTime","tags": [null],"is_seen_on_filtered_events": "string"}
Delete property definitions
Path Parameters
- idstring
- project_idstring
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 responseRetrieve property definitions seen together
Allows a caller to provide a list of event names and a single property name Returns a map of the event names to a boolean representing whether that property has ever been seen with that event_name
Path Parameters
- project_idstring
Response
Request
GET
/api /projects /:project_id /property_definitions /seen_together
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/seen_together/
Response
RESPONSE
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","name": "string","is_numerical": true,"property_type": "DateTime","tags": [null],"is_seen_on_filtered_events": "string"}