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

이름	설명
목록	해당 구성 세부 정보를 포함한 홀드아웃 그룹 목록입니다.
편집	홀드아웃 그룹을 편집합니다.
생성	새 홀드아웃을 생성합니다.

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`	선택 사항	`string`	홀드아웃 그룹 이름입니다.
`description`	선택 사항	`string`	홀드아웃 그룹 설명입니다.
`experiments`	선택 사항	`number array`	이 홀드아웃 그룹에 포함시킬 실험 ID 목록입니다. 실험 평가 모드는 홀드아웃 그룹의 평가 모드와 호환되어야 합니다.
`individualInclusion`	선택 사항	`string array`	이 홀드아웃 그룹에 포함시킬 사용자 ID 또는 장치 ID 목록입니다. 포함된 사용자는 실험을 경험하지 못합니다.
`individualExclusion`	선택 사항	`string array`	이 홀드아웃 그룹에서 제외할 사용자 ID 또는 장치 ID 목록입니다. 제외된 사용자는 실험을 경험할 수 있습니다.
`archive`	선택 사항	`boolean`	홀드아웃 그룹을 보관하거나 보관을 해제합니다. 보관될 때 홀드아웃 그룹은 삭제된 것으로 설정되어 모든 하위 실험의 상위 종속성에서 제거됩니다.

요청 예제

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`	필수	`number`	홀드아웃 그룹의 프로젝트 ID입니다.
`name`	필수	`string`	홀드아웃 그룹 이름입니다.
`key`	선택 사항	`string`	홀드아웃 그룹 키입니다. 모든 플래그, 실험, 홀드아웃 그룹 및 뮤텍스 그룹에서 고유해야 합니다. 키를 지정하지 않은 경우 Amplitude는 키를 생성합니다.
`description`	선택 사항	`string`	홀드아웃 그룹 설명입니다.
`holdoutPercentage`	필수	`number`	홀드아웃 비율입니다. 1과 99 사을 대상 구간으로 하는 포함된 정수입니다.
`evaluationMode`	선택 사항	`string`	평가 모드입니다. 옵션은 `local` 및 `remote`입니다. 기본값은 `remote`입니다.
`bucketingKey`	선택 사항	`string`	버킷 키입니다. 기본값은 `amplitude_id`입니다.
`experiments`	선택 사항	`number array`	이 홀드아웃 그룹에 포함시킬 실험 ID 목록입니다. 실험 평가 모드는 홀드아웃 그룹의 평가 모드와 호환되어야 합니다.
`individualInclusion`	선택 사항	`string array`	이 홀드아웃 그룹에 포함시킬 사용자 ID 또는 장치 ID 목록입니다. 포함된 사용자는 실험을 경험하지 못합니다.
`individualExclusion`	선택 사항	`string array`	이 홀드아웃 그룹에서 제외할 사용자 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}'

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