Get a key moment - Kameleoon Documentation

GET

key-moments

{keyMomentId}

Get a key moment

curl --request GET \
  --url https://api.kameleoon.com/key-moments/{keyMomentId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kameleoon.com/key-moments/{keyMomentId}', 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/{keyMomentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "name": "My Key Moment",
  "siteId": 8372,
  "audienceTracking": true,
  "audienceTrackingEditable": true,
  "campaignType": "ALL",
  "conditionDataList": [
    {
      "id": 123,
      "isConditionBlock": true,
      "logicalOperator": "AND",
      "parentId": 123,
      "targetingCondition": {
        "targetingType": "PAGE_URL",
        "weight": 1,
        "count": 123,
        "include": true,
        "matchType": "EQUAL",
        "unitOfTime": "SECOND",
        "htmlDescription": "<string>",
        "id": 123
      }
    }
  ],
  "conditionDataTree": {
    "targetingType": "<string>",
    "conditionData": [
      {
        "targetingType": "PAGE_URL",
        "weight": 1,
        "htmlDescription": "<string>",
        "id": 123
      }
    ],
    "isConditionBlock": true,
    "logicalOperator": "AND"
  },
  "conditionsData": {
    "firstLevel": [
      {
        "conditions": [
          {
            "targetingType": "PAGE_URL",
            "weight": 1,
            "count": 123,
            "include": true,
            "matchType": "EQUAL",
            "unitOfTime": "SECOND",
            "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>",
      "domainType": "EXPERIMENT",
      "linkRole": "MAIN",
      "linkType": "DIRECT"
    }
  ],
  "userVisible": true
}

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

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

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

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

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

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

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

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "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.

Path Parameters

keyMomentId

integer<int64>

required

Query Parameters

optionalFields

string[]

Response

name

string

required

Name of the key moment

Example:

"My Key Moment"

siteId

integer<int64>

required

Unique ID of the site where Kameleoon created, or will create, the key moment.

Example:

8372

audienceTracking

boolean

Indicates if the key moment tracks audience

audienceTrackingEditable

boolean

read-only

Indicates if users can enable or disable audienceTracking. In some cases, users cannot disable audienceTracking. For example, when a key moment has predictive conditions, Kameleoon tracks audience by default.

campaignType

enum<string>

Campaign type of the key moment (trigger).

Available options:

ALL,

FEATURE,

WEB

conditionDataList

object[]

Conditions upon which the key moment includes visitors in list form

Show child attributes

conditionDataTree

object

Conditions upon which the key moment includes visitors in tree form

Show child attributes

conditionsData

object

Conditions upon which the key moment includes visitors

Show child attributes

createdBy

integer<int64>

read-only

Account ID of the key moment creator

dateCreated

string<date-time>

read-only

Date of key moment creation

dateModified

string<date-time>

read-only

Date of key moment modification

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

object[]

read-only

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

Show child attributes

userVisible

boolean

Indicates whether the application hides the key moment from the user.

⌘I

Get a key moment

curl --request GET \
  --url https://api.kameleoon.com/key-moments/{keyMomentId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kameleoon.com/key-moments/{keyMomentId}', 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/{keyMomentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "name": "My Key Moment",
  "siteId": 8372,
  "audienceTracking": true,
  "audienceTrackingEditable": true,
  "campaignType": "ALL",
  "conditionDataList": [
    {
      "id": 123,
      "isConditionBlock": true,
      "logicalOperator": "AND",
      "parentId": 123,
      "targetingCondition": {
        "targetingType": "PAGE_URL",
        "weight": 1,
        "count": 123,
        "include": true,
        "matchType": "EQUAL",
        "unitOfTime": "SECOND",
        "htmlDescription": "<string>",
        "id": 123
      }
    }
  ],
  "conditionDataTree": {
    "targetingType": "<string>",
    "conditionData": [
      {
        "targetingType": "PAGE_URL",
        "weight": 1,
        "htmlDescription": "<string>",
        "id": 123
      }
    ],
    "isConditionBlock": true,
    "logicalOperator": "AND"
  },
  "conditionsData": {
    "firstLevel": [
      {
        "conditions": [
          {
            "targetingType": "PAGE_URL",
            "weight": 1,
            "count": 123,
            "include": true,
            "matchType": "EQUAL",
            "unitOfTime": "SECOND",
            "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>",
      "domainType": "EXPERIMENT",
      "linkRole": "MAIN",
      "linkType": "DIRECT"
    }
  ],
  "userVisible": true
}

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

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

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

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

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

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

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

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

APIs

Authorizations

Path Parameters

Query Parameters

Response