Skip to main content
POST
Create website tracked event

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_website_tracked_event.

site_sid
string
required

Website site sid (sg_si_...), the event's site.

Required string length: 18
Pattern: ^sg_si_
event
string
required

The name the site's script sends (trial_started), 1..64 characters of letters, digits, space, _ . : -; matched without letter case; immutable.

Maximum string length: 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9 _.:-]*$
label
string
required

What the event is called in the feed (Trial started).

Required string length: 1 - 120
is_conversion
boolean

Count it as a conversion. Default false.

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required