Optimizely · Schema

ContentItem

A content item such as a page, block, or media file

A/B TestingContent ManagementCustomer DataE-CommerceExperimentationFeature FlagsMarketing

Properties

Name	Type	Description
contentLink	object	Reference to this content item
name	string	Display name of the content item
language	object	Language information for this content item
existingLanguages	array	List of available language versions
masterLanguage	object	The master language of this content item
contentType	array	Content type hierarchy
parentLink	object	Reference to the parent content item
routeSegment	string	URL segment for routing
url	string	Public URL of the content
changed	string	Timestamp when the content was last changed
created	string	Timestamp when the content was created
startPublish	string	Timestamp when the content was published
status	string	Publication status of the content

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ContentItem",
  "title": "ContentItem",
  "type": "object",
  "description": "A content item such as a page, block, or media file",
  "properties": {
    "contentLink": {
      "type": "object",
      "description": "Reference to this content item",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Numeric content ID"
        },
        "workId": {
          "type": "integer",
          "description": "Work ID for versioning"
        },
        "guidValue": {
          "type": "string",
          "format": "uuid",
          "description": "GUID for the content item"
        },
        "providerName": {
          "type": "string",
          "description": "Content provider name"
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "URL to access this content via the API"
        }
      }
    },
    "name": {
      "type": "string",
      "description": "Display name of the content item"
    },
    "language": {
      "type": "object",
      "description": "Language information for this content item",
      "properties": {
        "link": {
          "type": "string",
          "format": "uri",
          "description": "Language-specific URL"
        },
        "displayName": {
          "type": "string",
          "description": "Display name of the language"
        },
        "name": {
          "type": "string",
          "description": "Language code"
        }
      }
    },
    "existingLanguages": {
      "type": "array",
      "description": "List of available language versions",
      "items": {
        "type": "object",
        "properties": {
          "link": {
            "type": "string",
            "format": "uri",
            "description": "URL for the language version"
          },
          "displayName": {
            "type": "string",
            "description": "Display name of the language"
          },
          "name": {
            "type": "string",
            "description": "Language code"
          }
        }
      }
    },
    "masterLanguage": {
      "type": "object",
      "description": "The master language of this content item",
      "properties": {
        "link": {
          "type": "string",
          "format": "uri",
          "description": "URL for the master language version"
        },
        "displayName": {
          "type": "string",
          "description": "Display name of the master language"
        },
        "name": {
          "type": "string",
          "description": "Master language code"
        }
      }
    },
    "contentType": {
      "type": "array",
      "description": "Content type hierarchy",
      "items": {
        "type": "string"
      }
    },
    "parentLink": {
      "type": "object",
      "description": "Reference to the parent content item",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Parent content ID"
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "URL to access the parent content"
        }
      }
    },
    "routeSegment": {
      "type": "string",
      "description": "URL segment for routing"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Public URL of the content"
    },
    "changed": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the content was last changed"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the content was created"
    },
    "startPublish": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the content was published"
    },
    "status": {
      "type": "string",
      "description": "Publication status of the content"
    }
  }
}