STstatable
Sites

Create a goal

Owner or admin only. A duplicate name is 409 goal_exists.

post/sites/{id}/goals

Request

Request body

namestring required
pathstring

URL path to match.

operator'e' | 'b' | 'c' | 'r'

e = equals, b = begins with, c = contains, r = regular expression. A regex is RE2 (no lookaround, no backreferences); one that does not compile is refused with 400 invalid_request.

event_namestring

Match a custom event instead of a path.

scroll_depthinteger

Percent scrolled. Only with event_name "engagement".

Response

The created goal.

idinteger required
host_idinteger required
namestring required
pathstring
operatorstring
event_namestring
scroll_depthinteger
created_atstring date-time
updated_atstring date-time

Changes

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