Create a new key moment

curl --request POST \
  --url https://api.kameleoon.com/key-moments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Key Moment",
  "siteId": 8372,
  "audienceTracking": true,
  "conditionDataList": [
    {
      "id": 123,
      "parentId": 123,
      "targetingCondition": {
        "weight": 1,
        "include": true
      }
    }
  ],
  "conditionDataTree": {
    "targetingType": "<string>"
  },
  "conditionsData": {
    "firstLevel": [
      {
        "conditions": [
          {
            "weight": 1,
            "include": true
          }
        ],
        "orOperators": [
          true
        ]
      }
    ],
    "firstLevelOrOperators": [
      true
    ]
  },
  "description": "The key moment is for new A/B tests",
  "isFavorite": true,
  "userVisible": true
}
'

import requests

url = "https://api.kameleoon.com/key-moments"

payload = {
    "name": "My Key Moment",
    "siteId": 8372,
    "audienceTracking": True,
    "conditionDataList": [
        {
            "id": 123,
            "parentId": 123,
            "targetingCondition": {
                "weight": 1,
                "include": True
            }
        }
    ],
    "conditionDataTree": { "targetingType": "<string>" },
    "conditionsData": {
        "firstLevel": [
            {
                "conditions": [
                    {
                        "weight": 1,
                        "include": True
                    }
                ],
                "orOperators": [True]
            }
        ],
        "firstLevelOrOperators": [True]
    },
    "description": "The key moment is for new A/B tests",
    "isFavorite": True,
    "userVisible": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'My Key Moment',
    siteId: 8372,
    audienceTracking: true,
    conditionDataList: [{id: 123, parentId: 123, targetingCondition: {weight: 1, include: true}}],
    conditionDataTree: {targetingType: '<string>'},
    conditionsData: {
      firstLevel: [{conditions: [{weight: 1, include: true}], orOperators: [true]}],
      firstLevelOrOperators: [true]
    },
    description: 'The key moment is for new A/B tests',
    isFavorite: true,
    userVisible: true
  })
};

fetch('https://api.kameleoon.com/key-moments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kameleoon.com/key-moments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My Key Moment',
    'siteId' => 8372,
    'audienceTracking' => true,
    'conditionDataList' => [
        [
                'id' => 123,
                'parentId' => 123,
                'targetingCondition' => [
                                'weight' => 1,
                                'include' => true
                ]
        ]
    ],
    'conditionDataTree' => [
        'targetingType' => '<string>'
    ],
    'conditionsData' => [
        'firstLevel' => [
                [
                                'conditions' => [
                                                                [
                                                                                                                                'weight' => 1,
                                                                                                                                'include' => true
                                                                ]
                                ],
                                'orOperators' => [
                                                                true
                                ]
                ]
        ],
        'firstLevelOrOperators' => [
                true
        ]
    ],
    'description' => 'The key moment is for new A/B tests',
    'isFavorite' => true,
    'userVisible' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kameleoon.com/key-moments"

	payload := strings.NewReader("{\n  \"name\": \"My Key Moment\",\n  \"siteId\": 8372,\n  \"audienceTracking\": true,\n  \"conditionDataList\": [\n    {\n      \"id\": 123,\n      \"parentId\": 123,\n      \"targetingCondition\": {\n        \"weight\": 1,\n        \"include\": true\n      }\n    }\n  ],\n  \"conditionDataTree\": {\n    \"targetingType\": \"<string>\"\n  },\n  \"conditionsData\": {\n    \"firstLevel\": [\n      {\n        \"conditions\": [\n          {\n            \"weight\": 1,\n            \"include\": true\n          }\n        ],\n        \"orOperators\": [\n          true\n        ]\n      }\n    ],\n    \"firstLevelOrOperators\": [\n      true\n    ]\n  },\n  \"description\": \"The key moment is for new A/B tests\",\n  \"isFavorite\": true,\n  \"userVisible\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.kameleoon.com/key-moments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Key Moment\",\n  \"siteId\": 8372,\n  \"audienceTracking\": true,\n  \"conditionDataList\": [\n    {\n      \"id\": 123,\n      \"parentId\": 123,\n      \"targetingCondition\": {\n        \"weight\": 1,\n        \"include\": true\n      }\n    }\n  ],\n  \"conditionDataTree\": {\n    \"targetingType\": \"<string>\"\n  },\n  \"conditionsData\": {\n    \"firstLevel\": [\n      {\n        \"conditions\": [\n          {\n            \"weight\": 1,\n            \"include\": true\n          }\n        ],\n        \"orOperators\": [\n          true\n        ]\n      }\n    ],\n    \"firstLevelOrOperators\": [\n      true\n    ]\n  },\n  \"description\": \"The key moment is for new A/B tests\",\n  \"isFavorite\": true,\n  \"userVisible\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/key-moments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Key Moment\",\n  \"siteId\": 8372,\n  \"audienceTracking\": true,\n  \"conditionDataList\": [\n    {\n      \"id\": 123,\n      \"parentId\": 123,\n      \"targetingCondition\": {\n        \"weight\": 1,\n        \"include\": true\n      }\n    }\n  ],\n  \"conditionDataTree\": {\n    \"targetingType\": \"<string>\"\n  },\n  \"conditionsData\": {\n    \"firstLevel\": [\n      {\n        \"conditions\": [\n          {\n            \"weight\": 1,\n            \"include\": true\n          }\n        ],\n        \"orOperators\": [\n          true\n        ]\n      }\n    ],\n    \"firstLevelOrOperators\": [\n      true\n    ]\n  },\n  \"description\": \"The key moment is for new A/B tests\",\n  \"isFavorite\": true,\n  \"userVisible\": true\n}"

response = http.request(request)
puts response.read_body

{
  "name": "My Key Moment",
  "siteId": 8372,
  "audienceTracking": true,
  "audienceTrackingEditable": true,
  "conditionDataList": [
    {
      "id": 123,
      "isConditionBlock": true,
      "parentId": 123,
      "targetingCondition": {
        "weight": 1,
        "include": true,
        "htmlDescription": "<string>",
        "id": 123
      }
    }
  ],
  "conditionDataTree": {
    "targetingType": "<string>",
    "conditionData": [
      {
        "weight": 1,
        "htmlDescription": "<string>",
        "id": 123
      }
    ],
    "isConditionBlock": true
  },
  "conditionsData": {
    "firstLevel": [
      {
        "conditions": [
          {
            "weight": 1,
            "include": true,
            "htmlDescription": "<string>",
            "id": 123
          }
        ],
        "orOperators": [
          true
        ]
      }
    ],
    "firstLevelOrOperators": [
      true
    ]
  },
  "createdBy": 123,
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateModified": "2023-11-07T05:31:56Z",
  "description": "The key moment is for new A/B tests",
  "id": 123,
  "isFavorite": true,
  "links": [
    {
      "domainId": 123,
      "domainStatus": "<string>"
    }
  ],
  "userVisible": true
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

POST

key-moments

Create a new key moment

curl --request POST \
  --url https://api.kameleoon.com/key-moments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Key Moment",
  "siteId": 8372,
  "audienceTracking": true,
  "conditionDataList": [
    {
      "id": 123,
      "parentId": 123,
      "targetingCondition": {
        "weight": 1,
        "include": true
      }
    }
  ],
  "conditionDataTree": {
    "targetingType": "<string>"
  },
  "conditionsData": {
    "firstLevel": [
      {
        "conditions": [
          {
            "weight": 1,
            "include": true
          }
        ],
        "orOperators": [
          true
        ]
      }
    ],
    "firstLevelOrOperators": [
      true
    ]
  },
  "description": "The key moment is for new A/B tests",
  "isFavorite": true,
  "userVisible": true
}
'

import requests

url = "https://api.kameleoon.com/key-moments"

payload = {
    "name": "My Key Moment",
    "siteId": 8372,
    "audienceTracking": True,
    "conditionDataList": [
        {
            "id": 123,
            "parentId": 123,
            "targetingCondition": {
                "weight": 1,
                "include": True
            }
        }
    ],
    "conditionDataTree": { "targetingType": "<string>" },
    "conditionsData": {
        "firstLevel": [
            {
                "conditions": [
                    {
                        "weight": 1,
                        "include": True
                    }
                ],
                "orOperators": [True]
            }
        ],
        "firstLevelOrOperators": [True]
    },
    "description": "The key moment is for new A/B tests",
    "isFavorite": True,
    "userVisible": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'My Key Moment',
    siteId: 8372,
    audienceTracking: true,
    conditionDataList: [{id: 123, parentId: 123, targetingCondition: {weight: 1, include: true}}],
    conditionDataTree: {targetingType: '<string>'},
    conditionsData: {
      firstLevel: [{conditions: [{weight: 1, include: true}], orOperators: [true]}],
      firstLevelOrOperators: [true]
    },
    description: 'The key moment is for new A/B tests',
    isFavorite: true,
    userVisible: true
  })
};

fetch('https://api.kameleoon.com/key-moments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kameleoon.com/key-moments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My Key Moment',
    'siteId' => 8372,
    'audienceTracking' => true,
    'conditionDataList' => [
        [
                'id' => 123,
                'parentId' => 123,
                'targetingCondition' => [
                                'weight' => 1,
                                'include' => true
                ]
        ]
    ],
    'conditionDataTree' => [
        'targetingType' => '<string>'
    ],
    'conditionsData' => [
        'firstLevel' => [
                [
                                'conditions' => [
                                                                [
                                                                                                                                'weight' => 1,
                                                                                                                                'include' => true
                                                                ]
                                ],
                                'orOperators' => [
                                                                true
                                ]
                ]
        ],
        'firstLevelOrOperators' => [
                true
        ]
    ],
    'description' => 'The key moment is for new A/B tests',
    'isFavorite' => true,
    'userVisible' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kameleoon.com/key-moments"

	payload := strings.NewReader("{\n  \"name\": \"My Key Moment\",\n  \"siteId\": 8372,\n  \"audienceTracking\": true,\n  \"conditionDataList\": [\n    {\n      \"id\": 123,\n      \"parentId\": 123,\n      \"targetingCondition\": {\n        \"weight\": 1,\n        \"include\": true\n      }\n    }\n  ],\n  \"conditionDataTree\": {\n    \"targetingType\": \"<string>\"\n  },\n  \"conditionsData\": {\n    \"firstLevel\": [\n      {\n        \"conditions\": [\n          {\n            \"weight\": 1,\n            \"include\": true\n          }\n        ],\n        \"orOperators\": [\n          true\n        ]\n      }\n    ],\n    \"firstLevelOrOperators\": [\n      true\n    ]\n  },\n  \"description\": \"The key moment is for new A/B tests\",\n  \"isFavorite\": true,\n  \"userVisible\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.kameleoon.com/key-moments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Key Moment\",\n  \"siteId\": 8372,\n  \"audienceTracking\": true,\n  \"conditionDataList\": [\n    {\n      \"id\": 123,\n      \"parentId\": 123,\n      \"targetingCondition\": {\n        \"weight\": 1,\n        \"include\": true\n      }\n    }\n  ],\n  \"conditionDataTree\": {\n    \"targetingType\": \"<string>\"\n  },\n  \"conditionsData\": {\n    \"firstLevel\": [\n      {\n        \"conditions\": [\n          {\n            \"weight\": 1,\n            \"include\": true\n          }\n        ],\n        \"orOperators\": [\n          true\n        ]\n      }\n    ],\n    \"firstLevelOrOperators\": [\n      true\n    ]\n  },\n  \"description\": \"The key moment is for new A/B tests\",\n  \"isFavorite\": true,\n  \"userVisible\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/key-moments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Key Moment\",\n  \"siteId\": 8372,\n  \"audienceTracking\": true,\n  \"conditionDataList\": [\n    {\n      \"id\": 123,\n      \"parentId\": 123,\n      \"targetingCondition\": {\n        \"weight\": 1,\n        \"include\": true\n      }\n    }\n  ],\n  \"conditionDataTree\": {\n    \"targetingType\": \"<string>\"\n  },\n  \"conditionsData\": {\n    \"firstLevel\": [\n      {\n        \"conditions\": [\n          {\n            \"weight\": 1,\n            \"include\": true\n          }\n        ],\n        \"orOperators\": [\n          true\n        ]\n      }\n    ],\n    \"firstLevelOrOperators\": [\n      true\n    ]\n  },\n  \"description\": \"The key moment is for new A/B tests\",\n  \"isFavorite\": true,\n  \"userVisible\": true\n}"

response = http.request(request)
puts response.read_body

{
  "name": "My Key Moment",
  "siteId": 8372,
  "audienceTracking": true,
  "audienceTrackingEditable": true,
  "conditionDataList": [
    {
      "id": 123,
      "isConditionBlock": true,
      "parentId": 123,
      "targetingCondition": {
        "weight": 1,
        "include": true,
        "htmlDescription": "<string>",
        "id": 123
      }
    }
  ],
  "conditionDataTree": {
    "targetingType": "<string>",
    "conditionData": [
      {
        "weight": 1,
        "htmlDescription": "<string>",
        "id": 123
      }
    ],
    "isConditionBlock": true
  },
  "conditionsData": {
    "firstLevel": [
      {
        "conditions": [
          {
            "weight": 1,
            "include": true,
            "htmlDescription": "<string>",
            "id": 123
          }
        ],
        "orOperators": [
          true
        ]
      }
    ],
    "firstLevelOrOperators": [
      true
    ]
  },
  "createdBy": 123,
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateModified": "2023-11-07T05:31:56Z",
  "description": "The key moment is for new A/B tests",
  "id": 123,
  "isFavorite": true,
  "links": [
    {
      "domainId": 123,
      "domainStatus": "<string>"
    }
  ],
  "userVisible": true
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name

string

required

Name of the key moment

Example:

"My Key Moment"

siteId

integer<int64>

required

Unique Id of the site where the key moment was, or will be created.

Example:

8372

audienceTracking

boolean

Indicates if the key moment is used for tracking audience

conditionDataList

Conditions data node · object[]

Conditions upon which visitors will be included in the key moment in list form

Show child attributes

conditionDataTree

Conditions data level · object

Conditions by which visitors will be segmented in tree form

Show child attributes

conditionsData

Conditions data · object

Conditions according to which visitors will be segmented

Show child attributes

description

string

Description of the key moment

Example:

"The key moment is for new A/B tests"

isFavorite

boolean

Indicates whether the key moment is a favorite

userVisible

boolean

Indicates whether the key moment is hidden from the user.

Response

Created

name

string

required

Name of the key moment

Example:

"My Key Moment"

siteId

integer<int64>

required

Unique Id of the site where the key moment was, or will be created.

Example:

8372

audienceTracking

boolean

Indicates if the key moment is used for tracking audience

audienceTrackingEditable

boolean

read-only

Indicates if audienceTracking can be enabled or disabled. In some cases, audienceTracking cannot be disabled. E.g. When a key moment has predictive conditions, audience will be tracked by default.

conditionDataList

Conditions data node · object[]

Conditions upon which visitors will be included in the key moment in list form

Show child attributes

conditionDataTree

Conditions data level · object

Conditions by which visitors will be segmented in tree form

Show child attributes

conditionsData

Conditions data · object

Conditions according to which visitors will be segmented

Show child attributes

createdBy

integer<int64>

read-only

Account Id of the key moment creator

dateCreated

string<date-time>

read-only

Date the key moment was created

dateModified

string<date-time>

read-only

Date the key moment was modified

description

string

Description of the key moment

Example:

"The key moment is for new A/B tests"

integer<int64>

read-only

Unique Id of the key moment

isFavorite

boolean

Indicates whether the key moment is a favorite

links

Link · object[]

read-only

List of links to related entities.This is an optional field that is included in the request body

Show child attributes

userVisible

boolean

Indicates whether the key moment is hidden from the user.

Get all key moments

Get a key moment

⌘I