실험 API 관리 홀드아웃 그룹 엔드포인트

이름	설명
목록	홀드아웃 그룹과 해당 구성 세부 정보를 나열합니다.
자세한 정보 보기	홀드아웃 그룹의 구성 세부 정보를 가져옵니다.
편집	홀드아웃 그룹을 편집합니다.
생성	새 홀드아웃 그룹을 생성합니다.

EU 데이터 상주

이 페이지의 예제에서는 기본 URL https://experiment.amplitude.com을(를) 사용합니다. 프로젝트에서 Amplitude의 EU 데이터 센터를 사용하고 있다면 대신 https://experiment.eu.amplitude.com을(를) 사용하십시오. 자세한 내용은 지역을 참조하십시오.

bash

GET https://experiment.amplitude.com/api/1/holdouts

해당 구성 세부 정보와 함께 홀드아웃 그룹 목록을 가져옵니다.

쿼리 매개 변수

이름	유형	필수	설명
`limit`	정수입니다.	아니요	반환할 홀드아웃 그룹의 최대 수입니다. 1000개로 제한됩니다.
`cursor`	문자열	아니요	결과 페이지를 시작할 때 사용되는 오프셋입니다.

응답

성공적인 요청은 200 OK 응답과 응답 본문에 JSON으로 인코딩된 홀드아웃 그룹 목록을 반환합니다.

curl --request GET \
--url 'https://experiment.amplitude.com/api/1/holdout?limit=1000' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <management-api-key>'

자세한 정보 보기

bash

GET https://experiment.amplitude.com/api/1/holdouts/<id>

홀드아웃 그룹의 구성 세부 정보를 가져옵니다.

경로 변수

이름	유형	필수	설명
`id`	문자열	예	홀드아웃 그룹의 ID입니다.

응답

성공적인 요청은 200 OK 응답과 홀드아웃 그룹의 세부 정보가 포함된 JSON 객체를 반환합니다.

curl --request GET \
    --url 'https://experiment.amplitude.com/api/1/holdouts/<id>' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>'

편집

bash

PATCH https://experiment.amplitude.com/api/1/holdouts/{id}

홀드아웃 그룹을 편집합니다.

경로 변수

이름	설명
`id`	필수입니다. 문자열입니다. 홀드아웃 그룹의 ID입니다.

요청 본문

이름	유형	필수	설명
`name`	문자열	아니요	홀드아웃 그룹 이름입니다.
`description`	문자열	아니요	홀드아웃 그룹 설명입니다.
`experiments`	숫자 배열	아니요	이 홀드아웃 그룹에 포함할 실험 ID 목록입니다. 실험 평가 모드는 홀드아웃 그룹의 평가 모드와 호환되어야 합니다.
`individualInclusion`	문자열 배열	아니요	이 홀드아웃 그룹에 포함시킬 사용자 ID 또는 장치 ID 목록입니다. 포함된 사용자는 실험을 경험하지 못합니다.
`individualExclusion`	문자열 배열	아니요	이 홀드아웃 그룹에서 제외할 사용자 ID 또는 장치 ID 목록입니다. 제외된 사용자는 실험을 경험할 수 있습니다.
`archive`	부울입니다.	아니요	홀드아웃 그룹을 아카이브합니다. 이 속성을 설정하면 홀드아웃 그룹이 삭제된 것으로 표시되고 모든 하위 실험의 상위 종속성에서 제거됩니다.

요청 예제

json

{
  "name": "updated name",
  "description": "updated description",
  "experiments": [123],
  "individualInclusion": ["x@amplitude.com"]
}

응답

성공적인 요청은 200 OK 응답을 반환합니다.

요청

curl

curl --request PATCH \
    --url 'https://experiment.amplitude.com/api/1/holdouts/<id>' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>' \
    --data '{"name": "updated name"}'

생성

bash

POST https://experiment.amplitude.com/api/1/holdouts

새 홀드아웃 그룹을 생성합니다.

요청 본문

이름	유형	필수	설명
`projectId`	숫자	예	홀드아웃 그룹의 프로젝트 ID입니다.
`name`	문자열	예	홀드아웃 그룹 이름입니다.
`key`	문자열	아니요	홀드아웃 그룹 키입니다. 고유해야 합니다. 지정되지 않은 경우 Amplitude는 임의의 키를 생성합니다.
`description`	문자열	아니요	홀드아웃 그룹 설명입니다.
`holdoutPercentage`	숫자	예	홀드아웃 비율입니다. 1과 99 대상 구간의 정수입니다(두 값을 포함).
`evaluationMode`	문자열	아니요	평가 모드입니다. 옵션은 `local` 및 `remote`입니다. 기본값은 `remote`입니다.
`bucketingKey`	문자열	아니요	버킷 키입니다. 기본값은 `amplitude_id`입니다.
`experiments`	숫자 배열	아니요	이 홀드아웃 그룹에 포함할 실험 ID 목록입니다. 실험 평가 모드는 홀드아웃 그룹의 평가 모드와 호환되어야 합니다.
`individualInclusion`	문자열 배열	아니요	이 홀드아웃 그룹에 포함시킬 사용자 ID 또는 장치 ID 목록입니다. 포함된 사용자는 실험을 경험하지 못합니다.
`individualExclusion`	문자열 배열	아니요	이 홀드아웃 그룹에서 제외할 사용자 ID 또는 장치 ID 목록입니다. 제외된 사용자는 실험을 경험할 수 있습니다.

요청 예제

json

{
    "projectId": <projectId>,
    "name": "Example Holdout",
  	"key": "example-holdout",
    "holdoutPercentage": 5,
    "evaluationMode": "local",
    "bucketingKey": "device_id",
    "experiments": [21197],
    "individualInclusion": ["x@amplitude.com"],
    "individualExclusion": ["y@amplitude.com"],
}

응답

성공적인 요청은 200 OK 응답과 홀드아웃 그룹의 ID 및 URL을 포함한 JSON 객체를 반환합니다.

curl --request POST \
    --url 'https://experiment.amplitude.com/api/1/holdouts' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>' \
    --data '{"projectId":"<projectId>","name":"Example Holdout","holdoutPercentage":5}'

이 내용이 도움이 되었나요?