{ "opencollection": "1.0.0", "info": { "name": "PostHog actions property_definitions API", "version": "1.0.0" }, "items": [ { "info": { "name": "property_definitions", "type": "folder" }, "items": [ { "info": { "name": "property_definitions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/", "params": [ { "name": "event_names", "value": "", "type": "query", "description": "If sent, response value will have `is_seen_on_filtered_events` populated. JSON-encoded" }, { "name": "exclude_core_properties", "value": "", "type": "query", "description": "Whether to exclude core properties" }, { "name": "exclude_hidden", "value": "", "type": "query", "description": "Whether to exclude properties marked as hidden" }, { "name": "excluded_properties", "value": "", "type": "query", "description": "JSON-encoded list of excluded properties" }, { "name": "filter_by_event_names", "value": "", "type": "query", "description": "Whether to return only properties for events in `event_names`" }, { "name": "group_type_index", "value": "", "type": "query", "description": "What group type is the property for. Only should be set if `type=group`" }, { "name": "is_feature_flag", "value": "", "type": "query", "description": "Whether to return only (or excluding) feature flag properties" }, { "name": "is_numerical", "value": "", "type": "query", "description": "Whether to return only (or excluding) numerical property definitions" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "properties", "value": "", "type": "query", "description": "Comma-separated list of properties to filter" }, { "name": "search", "value": "", "type": "query", "description": "Searches properties by name" }, { "name": "type", "value": "", "type": "query", "description": "What property definitions to return\n\n* `event` - event\n* `person` - person\n* `group` - group\n* `session` - session" }, { "name": "verified", "value": "", "type": "query", "description": "Filter by verified status. True returns only verified, false returns only unverified." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "property_definitions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this property definition." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "property_definitions_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this property definition." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "property_definitions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this property definition." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "property_definitions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this property definition." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "property_definitions_bulk_update_tags_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/bulk_update_tags/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk update tags on multiple objects.\n\nAccepts:\n- {\"ids\": [...], \"action\": \"add\"|\"remove\"|\"set\", \"tags\": [\"tag1\", \"tag2\"]}\n\nActions:\n- \"add\": Add tags to existing tags on each object\n- \"remove\": Remove specific tags from each object\n- \"set\": Replace all tags on each object with the provided list" }, { "info": { "name": "property_definitions_seen_together_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/seen_together/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Allows a caller to provide a list of event names and a single property name\nReturns a map of the event names to a boolean representing whether that property has ever been seen with that event_name" } ] } ], "bundled": true }