Optimizely · Schema

Campaign

A campaign that groups experiments under a shared objective

A/B TestingContent ManagementCustomer DataE-CommerceExperimentationFeature FlagsMarketing

Properties

Name	Type	Description
id	integer	Unique identifier for the campaign
project_id	integer	The project this campaign belongs to
name	string	Human-readable name of the campaign
status	string	Current status of the campaign
experiment_ids	array	List of experiment IDs in this campaign
page_ids	array	List of page IDs the campaign targets
created	string	Timestamp when the campaign was created
last_modified	string	Timestamp when the campaign was last modified

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Campaign",
  "title": "Campaign",
  "type": "object",
  "description": "A campaign that groups experiments under a shared objective",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique identifier for the campaign"
    },
    "project_id": {
      "type": "integer",
      "format": "int64",
      "description": "The project this campaign belongs to"
    },
    "name": {
      "type": "string",
      "description": "Human-readable name of the campaign"
    },
    "status": {
      "type": "string",
      "description": "Current status of the campaign",
      "enum": [
        "active",
        "paused",
        "not_started",
        "archived"
      ]
    },
    "experiment_ids": {
      "type": "array",
      "description": "List of experiment IDs in this campaign",
      "items": {
        "type": "integer",
        "format": "int64"
      }
    },
    "page_ids": {
      "type": "array",
      "description": "List of page IDs the campaign targets",
      "items": {
        "type": "integer",
        "format": "int64"
      }
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the campaign was created"
    },
    "last_modified": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the campaign was last modified"
    }
  }
}