web_analytics_bot_rules

Create a custom bot rule

Add one bot rule to the project. A rule combines one or more single-property conditions with AND or OR. A pattern is rejected if it cannot run, because a broken rule would break every query that classifies traffic for the project.

post/api/projects/{project_id}/web_analytics_bot_rules/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/web_analytics_bot_rules/
  • Auth: HTTP bearer

Path parameters

project_idstring required

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

Request body

idstring required

Stable id for the rule. Pass it to the delete endpoint.

namestring required

Label reported by the Bot name property when the rule matches. Also the operator for a rule on a bot PostHog does not know.

categorystring

Reported by the Traffic category property. Defaults to 'custom'. A built-in category such as ai_crawler or search_crawler relabels the traffic type too.

combinerstring

How the conditions combine: 'AND' flags an event only when every condition matches, 'OR' when any one of them does.

Response

idstring required

Stable id for the rule. Pass it to the delete endpoint.

namestring required

Label reported by the Bot name property when the rule matches. Also the operator for a rule on a bot PostHog does not know.

categorystring

Reported by the Traffic category property. Defaults to 'custom'. A built-in category such as ai_crawler or search_crawler relabels the traffic type too.

combinerstring

How the conditions combine: 'AND' flags an event only when every condition matches, 'OR' when any one of them does.

Changes

No recorded changes to this operation across all 1 revision of this API.