Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideLegal TermsGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

All data in Optimizely Data Platform (ODP) is stored in collections called objects (what many think of as a database table).

Objects are composed of fields. Fields link objects together using relations.

Objects definition

{
  "name": "object_name",
  "display_name": "Display Name",
  "public_read": false,
  "alias": "object_alias",
  "fields": [],
  "relations": []
}
PropertyDescription
namePlural name for the object.
display_nameUser-friendly name that displays in ODP.
public_read(Optional) Enable access with the API public key. The default value is false.
aliasSingular name for the object.
fieldsCollection of Field objects constituting the Object.
relationsCollection of Relation objects.