¶ Event Descriptions and Data Structures
- Description: Logs when a user registers on the platform.
- Example JSON:
{
"type": "register",
"data": {
"email": "user@email.com",
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: Records a user's login, particularly noting if a session refresh token was used.
- Example JSON:
{
"type": "login",
"data": {
"refresh": true,
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: This event captures when a user selects an option from the site request chooser.
- Example JSON:
{
"type": "new_site_request_chooser_select",
"data": {
"id": "userAiSite",
"title": "Use AI to create a starting point",
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: This event logs when a user requests the creation of a new site.
- Example JSON:
{
"type": "new_site_request",
"data": {
"name": "My Name",
"profession": "Landscape Architect From Turin",
"siteType": "Individual",
"type": "user",
"websiteUrl": null,
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: This event logs the generation of a new AI-created site, listing all URLs generated during the session.
- Example JSON:
{
"type": "new_ai_site_generated",
"data": {
"websites": [
"https://editor.starfish.ws/v2/serve/vbid-f678e5b3-29ff-46f9-aa1c-c51302f6b64d-PAGES/vbid-f678e5b3-29ff-46f9-aa1c-c51302f6b64d",
"...",
"https://editor.starfish.ws/v2/serve/vbid-cf059801-071f-4abe-80da-c0bdbe626d3b-PAGES/vbid-cf059801-071f-4abe-80da-c0bdbe626d3b"
],
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: Logs the event when a user opens the site editor.
- Example JSON:
{
"type": "editor_opened",
"data": {
"vbid": "vbid-d7acf1f9-eea4-44eb-89cd-31969a9fb008-PAGES/vbid-d7acf1f9-eea4-44eb-89cd-31969a9fb008",
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: This event captures when a user accesses the eCommerce functionalities of the platform.
- Example JSON:
{
"type": "ecommerce_opened",
"data": {
"companyId": "clvw3r0070014x9uwik6b8gwt",
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: Records when a user opens the Content Management System.
- Example JSON:
{
"type": "cms_opened",
"data": {
"companyId": "clvw3r0070014x9uwik6b8gwt",
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: Logs when a user adds a new section to their site, indicating the section category and any cloning details.
- Example JSON:
{
"type": "section_added",
"data": {
"category": "About",
"clonedSection": "vbid-6520eb25-9522-46ae-81e0-e384edbe0114",
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: This event records when the hosting settings panel is accessed by a user.
- Example JSON:
{
"type": "hosting_opened",
"data": {
"source": "console",
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: Captures when a user previews their site from the editor.
- Example JSON:
{
"type": "preview_site",
"data": {
"source": "editor",
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: Logs when a user click ‘publish’ button.
- Example JSON:
{
"type": "publish",
"data": {
"source": "editor",
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: Indicates that the publishing process for a site has been successfully completed.
- Example JSON:
{
"type": "publish_completed",
"data": {
"vbid": "vbid-b6529388-a45f-4c11-b02c-c407d923f997-PAGES",
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"deployedBucket": "deploy_bucket_name",
"deployPath": "deploy_path",
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: Records when a user selects a subscription plan.
- Example JSON:
{
"type": "plan_selected",
"data": {
"source": "editor",
"plan": "My plan",
"planId": "n0jZfQ1715864966855",
"annual": false,
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: Logs when a purchase button for a plan is clicked.
- Example JSON:
{
"type": "purchase_button_clicked",
"data": {
"source": "editor",
"plan": "My plan",
"planId": "n0jZfQ1715864966855",
"annual": false,
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}
- Description: This event captures when a user selects a hosting solution.
- Example JSON:
{
"type": "hosting_solution_selected",
"data": {
"source": "editor",
"label": "Host with Cosmos",
"id": "cosmos",
"user": {
"id": "some-user-id",
"name": "User Name",
"email": "user@email.com",
"labelId": "label-id"
},
"timestamp": 1911111111,
"time": "2028-01-01 11:01:54"
}
}