Fields schema overview

1 min

{
  "name": "field_name",
  "type": "number",
  "auto": true,
  "display_name": "Display Name",
  "public_read": false,
  "description": "Description of field",
  "created_by": "zaius",
  "primary_key": true
}

property	description
name	Name of the field.
type	Field data type. Options are number, timestamp, text, boolean.
auto	(Read-only) Marks the field as one that is auto-populated by Optimizely Data Platform (ODP).
display_name	The user-friendly name used in ODP.
public_read	(Optional) Enable access with the public API key. The default value is false.
description	Description of the field.
created_by	(Read-only) Specifies what or who created the field. Current values are zaius and account.
primary_key	Marks the field as identifying for the containing object. Only allowed during object creation.