콘텐츠로 건너뛰기

데이터 객체 가져오기

get

/data_objects/objects/{type_name}/{object_id}

이 엔드포인트를 사용하면 데이터 객체 하나를 반환할 수 있습니다.

전제 조건

이 엔드포인트를 사용하려면 data_objects.read 권한이 있는 API 키가 필요합니다.

사용량 제한

이 엔드포인트는 데이터 객체 읽기 버킷에 속하며, 기본 제한은 분당 요청 1,000회입니다.

경로 매개변수

다음 표에는 /data_objects/objects/{type_name}/{object_id} 엔드포인트의 경로 매개변수와 각 매개변수에 대한 설명이 나와 있습니다.

매개변수 필수 데이터 유형 설명
type_name 필수 문자열 데이터 객체 유형의 머신 이름
object_id 필수 문자열 객체 식별자

요청 예시

이 섹션에는 경로 매개변수 페이로드 샘플과 cURL 요청 샘플이 포함되어 있습니다.

샘플 요청 페이로드

이 요청의 경로 매개변수를 지정할 때 다음 JSON 객체를 참고하세요.

{
  "type_name": "account",
  "object_id": "acct-123"
}

샘플 cURL 요청

이 예시는 acct-123 계정 레코드와 여기에 저장된 속성을 가져옵니다.

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

응답

이 섹션에는 성공 응답 예시와 응답 필드가 포함되어 있습니다.

성공 응답 예시

상태 코드 200은 다음과 같은 응답 본문을 반환할 수 있습니다.

{
  "data_object": {
    "type_name": "account",
    "object_id": "acct-123",
    "attributes": { "name": "Acme", "industry": "software" }
  }
}

응답 매개변수

다음 표에는 성공 응답에 포함되는 필드와 각 필드에 대한 설명이 나와 있습니다.

매개변수 필수 데이터 유형 설명
data_object 필수 객체 반환된 데이터 객체 레코드
data_object.type_name 필수 문자열 데이터 객체 유형의 머신 이름
data_object.object_id 필수 문자열 데이터 객체 식별자
data_object.attributes 필수 객체 필드 이름을 키로 하는 객체 속성

오류

다음 표에는 이 엔드포인트에서 자주 발생하는 오류와 해결 방법이 나와 있습니다.

상태 원인 안내
404 유형을 찾을 수 없음(data-object-type-not-found) 또는 객체를 찾을 수 없음(data-object-not-found) type_name과 object_id가 모두 워크스페이스에 존재하는지 확인하세요.
401 REST API 키가 누락되었거나 유효하지 않음 Authorization 헤더에 Bearer YOUR_REST_API_KEY가 사용되었는지, 키가 활성 상태인지 확인하세요.
403 API 키에 권한이 없거나 허용 목록에 의해 요청이 차단됨 키에 data_objects.read 권한이 있는지, 그리고 허용 목록을 구성한 경우 소스 IP가 키 허용 목록에 포함되어 있는지 확인하세요.
429 사용량 제한 초과 X-RateLimit-Reset 이후에 다시 시도하고 요청 빈도를 줄이세요.
New Stuff!