Optimizely Schema API

Manage the ODP schema including domain objects and their fields.

Documentation GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /schema/objects List object types in the data platform schema · List schema objects #

Ask an LLM

“What object types are defined in my Optimizely Data Platform schema?”

“How do I see all schema objects with their fields and configuration?”

Tell an agent

List all schema object types.

Show every object in the data platform schema with its fields.

GET /schema/objects/{object_type} Get one object type's schema definition · Get a schema object #

Ask an LLM

“How do I see the fields defined on one schema object type?”

“What does the schema for a particular object type look like?”

Tell an agent

Get the schema for object type {object_type}.

Show the fields of the {object_type} object.

POST /schema/objects/{object_type} Create a new object type in the schema · Create a schema object #

Ask an LLM

“How do I add a custom object type to the data platform schema?”

“Can I give a new schema object a display name and description?”

Tell an agent

Create schema object {object_type} with display name {display_name}.

Add object type {object_type} described as {description}.

POST /schema/objects/{object_type}/fields Add a field to a schema object · Create a schema field #

Ask an LLM

“How do I add a new field to an existing object type?”

“What data type do I have to specify when creating a schema field?”

Tell an agent

Add field {name} of type {type} to object {object_type}.

Create field {name} labeled {display_name} on {object_type}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/optimizely:optimizely-schema-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Optimizely Data Platform REST Schema API
  description: The Optimizely Data Platform (ODP) REST API enables developers to integrate customer data with the Optimizely Data Platform. It provides endpoints for managing customer profiles, sending events, managing objects, and querying schema information. The API supports real-time data ingestion and retrieval using both public and private API keys, allowing developers to build personalized experiences powered by comprehensive customer intelligence.
  version: '3.0'
  contact:
    name: Optimizely Support
    url: https://support.optimizely.com
  termsOfService: https://www.optimizely.com/legal/terms/
servers:
- url: https://api.zaius.com/v3
  description: Optimizely Data Platform API v3 Server
security:
- publicApiKey: []
tags:
- name: Schema
  description: Manage the ODP schema including domain objects and their fields.
paths:
  /schema/objects:
    get:
      operationId: listSchemaObjects
      summary: List schema objects
      description: Returns a list of all domain object types defined in the ODP schema, including their fields and configurations.
      tags:
      - Schema
      security:
      - privateApiKey: []
      responses:
        '200':
          description: Successfully retrieved schema objects
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SchemaObject'
        '401':
          description: Authentication credentials are missing or invalid
  /schema/objects/{object_type}:
    get:
      operationId: getSchemaObject
      summary: Get a schema object
      description: Retrieves the schema definition for a specific domain object type.
      tags:
      - Schema
      security:
      - privateApiKey: []
      parameters:
      - $ref: '#/components/parameters/objectType'
      responses:
        '200':
          description: Successfully retrieved the schema object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaObject'
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Schema object not found
    post:
      operationId: createSchemaObject
      summary: Create a schema object
      description: Creates a new domain object type in the ODP schema.
      tags:
      - Schema
      security:
      - privateApiKey: []
      parameters:
      - $ref: '#/components/parameters/objectType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SchemaObjectInput'
      responses:
        '201':
          description: Schema object successfully created
        '400':
          description: Invalid schema object definition
        '401':
          description: Authentication credentials are missing or invalid
  /schema/objects/{object_type}/fields:
    post:
      operationId: createSchemaField
      summary: Create a schema field
      description: Adds a new field to an existing domain object type in the ODP schema.
      tags:
      - Schema
      security:
      - privateApiKey: []
      parameters:
      - $ref: '#/components/parameters/objectType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SchemaFieldInput'
      responses:
        '201':
          description: Schema field successfully created
        '400':
          description: Invalid field definition
        '401':
          description: Authentication credentials are missing or invalid
        '404':
          description: Schema object not found
components:
  schemas:
    SchemaField:
      type: object
      description: A field definition within a domain object type
      properties:
        name:
          type: string
          description: Field name
        display_name:
          type: string
          description: Human-readable display name
        type:
          type: string
          description: Data type of the field
          enum:
          - string
          - number
          - boolean
          - timestamp
        description:
          type: string
          description: Description of the field
    SchemaFieldInput:
      type: object
      description: Input for creating a schema field
      required:
      - name
      - display_name
      - type
      properties:
        name:
          type: string
          description: Field name
        display_name:
          type: string
          description: Human-readable display name
        type:
          type: string
          description: Data type of the field
          enum:
          - string
          - number
          - boolean
          - timestamp
        description:
          type: string
          description: Description of the field
    SchemaObject:
      type: object
      description: A domain object type definition in the ODP schema
      properties:
        name:
          type: string
          description: Name of the object type
        display_name:
          type: string
          description: Human-readable display name
        description:
          type: string
          description: Description of the object type
        fields:
          type: array
          description: Fields defined on the object type
          items:
            $ref: '#/components/schemas/SchemaField'
    SchemaObjectInput:
      type: object
      description: Input for creating a domain object type
      required:
      - display_name
      properties:
        display_name:
          type: string
          description: Human-readable display name
        description:
          type: string
          description: Description of the object type
  parameters:
    objectType:
      name: object_type
      in: path
      required: true
      description: The type of object (e.g., products, orders)
      schema:
        type: string
  securitySchemes:
    publicApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Public API Key (Tracker ID) for sending data to ODP. May be exposed publicly on the internet.
    privateApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Private API Key for querying data from ODP. Must be kept confidential and used only in backend services.
externalDocs:
  description: Optimizely Data Platform API Documentation
  url: https://docs.developers.optimizely.com/optimizely-data-platform/reference/introduction

Optimizely Schema API

Operations 4

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification