Editor Data

๐Ÿ“˜

The platform object is available from the editor UI and within the site overview and site preview pages (if logged in).

Account

platform.data.account

Information about the account logged into the platform. This can be accessed within the editor and dashboard.

PropertyDescription
nameThe account that is using the editor/dashboard.
typeThe type of account that is using the editor/dashboard. Will have a value of either STAFF or CLIENT.
permissionGroup.nameAn object containing the name of the permission group a STAFF member is assigned to.
Note: Custom groups will return the ID of a permission group. Use the List Custom Team Groups API to collect the name of the group.

Site

platform.data.site

The site that is being edited. This can only be accessed within the editor.

PropertyDescription
nameThe site that is being edited.
externalUIDThe externalUID of the site (if assigned).
plan.idThe id of the plan for this site.
plan.nameThe name of the plan for this site.