데이터 스키마: 검색 분석과 규칙

periodAnalyticsPeriodData 필수

보고 기간과 시작·종료 경계입니다.

예제: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

예제: "example"

추가 필드: 아니요

as_of문자열필수

보고된 데이터의 기준 시각입니다.

format: "date-time"

예제: "2026-01-02T00:00:00Z"

days정수필수

보고 기간의 일수입니다.

예제: 1

started_at문자열필수

시작 날짜와 시각입니다.

format: "date-time"

예제: "2026-01-01T00:00:00Z"

추가 필드: 아니요

data배열 <MetricData > 필수

응답 예제 · AnalyticsResponse_list_MetricData__.

예제: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]

metaAnalyticsPageMeta | AnalyticsMeta 필수

응답 메타데이터입니다.

예제: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

추가 필드: 아니요

data배열 <OccurrenceData > 필수

응답 예제 · AnalyticsResponse_list_OccurrenceData__.

예제: [{"category_id":"example","category_result_count":1,"currency_code":"PLN","is_zero_results":false,"locale_code":"en","market_id":"example","max_price":"0.00","min_price":"0.00","occurred_at":"2026-01-01T12:00:00Z","page":1,"product_result_count":1,"query_display":"example","request_id":"example","results":[{"clicked":false,"entity_id":"example","entity_type":"product","image_url":"https://example.invalid/product.jpg","number":"example","placement_source":"organic","position":1,"sku":"example","slug":"example","title":"example"}],"sort_key":"example","source":"results"}]

metaAnalyticsPageMeta | AnalyticsMeta 필수

응답 메타데이터입니다.

예제: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

추가 필드: 아니요

dataOverviewData 필수

응답 예제 · OverviewData.

예제: {"click_through_rate":0,"clicked_searches":1,"recent":[{"is_zero_results":false,"locale_code":"en","occurred_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","request_id":"example","result_count":1,"source":"results"}],"searches":1,"zero_result_rate":0,"zero_results":1}

metaAnalyticsPageMeta | AnalyticsMeta 필수

응답 메타데이터입니다.

예제: {"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

추가 필드: 아니요

data배열 <RuleSummaryData > 필수

응답 예제 · ApiResponse_list_RuleSummaryData__.

예제: [{"created_at":"2026-01-01T12:00:00Z","enabled":true,"id":"example","is_available":true,"market_scope":"all","name":"Example","updated_at":"2026-01-01T12:00:00Z","version":1}]

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 필수

응답 메타데이터입니다.

예제: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

추가 필드: 아니요

dataRuleDetailData 필수

응답 예제 · RuleDetailData.

예제: {"category_ids":["example"],"created_at":"2026-01-01T12:00:00Z","enabled":true,"id":"example","is_available":true,"market_ids":["example"],"market_scope":"all","name":"Example","phrase_groups":[{"locale":"en","phrases":["example"]}],"product_ids":["example"],"updated_at":"2026-01-01T12:00:00Z","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 필수

응답 메타데이터입니다.

예제: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

추가 필드: 아니요

clicks정수필수

클릭 수입니다.

예제: 1

last_seen_at문자열필수

가장 최근 발생 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"

query_display문자열필수

관리자에게 표시하는 검색 문구입니다.

예제: "example"

query_hash문자열필수

그룹화된 검색 문구의 안정적인 식별자입니다.

예제: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

searches정수필수

검색 수입니다.

예제: 1

zero_results정수필수

결과가 없는 검색 수입니다.

예제: 1

추가 필드: 아니요

category_id문자열 | null필수

카테고리 식별자입니다.

예제: "example"

category_result_count정수필수

카테고리 결과 수입니다.

예제: 1

currency_code문자열필수

통화 코드입니다.

예제: "PLN"

is_zero_results불리언필수

검색 결과가 없는지 나타냅니다.

예제: false

locale_code문자열필수

언어 코드입니다.

예제: "en"

market_id문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

예제: "example"

max_price문자열 | null필수

보고된 범위의 최고 가격입니다.

예제: "0.00"

min_price문자열 | null필수

보고된 범위의 최저 가격입니다.

예제: "0.00"

occurred_at문자열필수

이벤트 발생 날짜와 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"

page정수필수

CMS 페이지 정보입니다.

예제: 1

product_result_count정수필수

상품 검색 결과 수입니다.

예제: 1

query_display문자열필수

관리자에게 표시하는 검색 문구입니다.

예제: "example"

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

예제: "example"

results배열 <ResultSnapshotData > | null필수

기록된 검색 결과입니다.

예제: [{"clicked":false,"entity_id":"example","entity_type":"product","image_url":"https://example.invalid/product.jpg","number":"example","placement_source":"organic","position":1,"sku":"example","slug":"example","title":"example"}]

sort_key문자열필수

정렬 키입니다.

예제: "example"

source문자열필수

기록된 활동의 출처입니다.

제약 조건

enum

["results", "autocomplete"]

예제: "results"

추가 필드: 아니요

click_through_rate숫자필수

선택한 검색 데이터의 클릭률입니다.

예제: 0

clicked_searches정수필수

클릭이 발생한 검색 수입니다.

예제: 1

recent배열 <RecentSearchData > 필수

최근 검색 정보입니다.

예제: [{"is_zero_results":false,"locale_code":"en","occurred_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","request_id":"example","result_count":1,"source":"results"}]

searches정수필수

검색 수입니다.

예제: 1

zero_result_rate숫자필수

결과가 없는 검색의 비율입니다.

예제: 0

zero_results정수필수

결과가 없는 검색 수입니다.

예제: 1

추가 필드: 아니요

추가 필드: 예

is_zero_results불리언필수

검색 결과가 없는지 나타냅니다.

예제: false

locale_code문자열필수

언어 코드입니다.

예제: "en"

occurred_at문자열필수

이벤트 발생 날짜와 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"

query_display문자열필수

관리자에게 표시하는 검색 문구입니다.

예제: "example"

query_hash문자열필수

그룹화된 검색 문구의 안정적인 식별자입니다.

예제: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

예제: "example"

result_count정수필수

검색 결과 수입니다.

예제: 1

source문자열필수

기록된 활동의 출처입니다.

제약 조건

enum

["results", "autocomplete"]

예제: "results"

추가 필드: 아니요

clicked불리언필수

결과를 클릭했는지 나타냅니다.

예제: false

entity_id문자열필수

참조하는 엔터티의 식별자입니다.

예제: "example"

entity_type문자열필수

참조하는 엔터티의 유형입니다.

제약 조건

enum

["product", "category"]

예제: "product"

image_url문자열 | null필수

이미지 URL입니다.

예제: "https://example.invalid/product.jpg"

number문자열 | null필수

사용자에게 표시하는 주문 또는 요청 번호입니다.

예제: "example"

placement_source문자열필수

주문이 접수된 출처입니다.

제약 조건

enum

["organic", "merchandising"]

예제: "organic"

position정수필수

정렬된 컬렉션에서의 위치입니다.

예제: 1

sku문자열필수

재고 관리 단위 코드입니다.

예제: "example"

slug문자열필수

선택한 언어의 URL 경로 조각입니다.

예제: "example"

title문자열필수

선택한 언어의 제목입니다.

예제: "example"

추가 필드: 아니요

category_ids배열 <문자열> 선택 사항

관련 카테고리 식별자입니다.

maxItems: 100

배열:minLength: 1maxLength: 63

enabled불리언선택 사항

이 설정이 활성화되어 있는지 나타냅니다.

기본값: false

market_ids배열 <문자열> 선택 사항

선택한 시장의 식별자입니다.

maxItems: 1000

배열:minLength: 1maxLength: 63

market_scope문자열선택 사항

전체 시장에 적용되는지 특정 시장에만 적용되는지 나타냅니다.

제약 조건

enum

["all", "selected"]

name문자열필수

해당 컨텍스트의 리소스 이름입니다.

minLength: 1maxLength: 160

예제: "Example"

phrases배열 <문자열> 필수

검색 규칙에 사용하는 문구입니다.

minItems: 1maxItems: 20

배열:minLength: 1maxLength: 255

예제: ["example"]

product_ids배열 <문자열> 선택 사항

관련 상품의 식별자입니다.

maxItems: 100

배열:minLength: 1maxLength: 63

예제: ["example"]

추가 필드: 아니요

category_ids배열 <문자열> 필수

관련 카테고리 식별자입니다.

예제: ["example"]

created_at문자열필수

생성 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"

enabled불리언필수

이 설정이 활성화되어 있는지 나타냅니다.

예제: true

id문자열필수

리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (RuleDetailData).

예제: "example"

is_available불리언필수

현재 컨텍스트에서 항목을 사용할 수 있는지 나타냅니다.

예제: true

market_ids배열 <문자열> 필수

선택한 시장의 식별자입니다.

예제: ["example"]

market_scope문자열필수

전체 시장에 적용되는지 특정 시장에만 적용되는지 나타냅니다.

제약 조건

enum

["all", "selected"]

예제: "all"

name문자열필수

해당 컨텍스트의 리소스 이름입니다.

예제: "Example"

phrase_groups배열 <RulePhraseGroupData > 필수

검색 규칙의 문구 그룹입니다.

예제: [{"locale":"en","phrases":["example"]}]

product_ids배열 <문자열> 필수

관련 상품의 식별자입니다.

예제: ["example"]

updated_at문자열필수

가장 최근 업데이트 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"

version정수필수

동시성 제어에 사용하는 리소스 버전입니다.

예제: 1

추가 필드: 아니요

locale문자열필수

이 요청에서 선택한 언어입니다.

예제: "en"

phrases배열 <문자열> 필수

검색 규칙에 사용하는 문구입니다.

예제: ["example"]

추가 필드: 아니요

created_at문자열필수

생성 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"

enabled불리언필수

이 설정이 활성화되어 있는지 나타냅니다.

예제: true

id문자열필수

리소스 식별자이며 반환된 값을 그대로 유지해야 합니다. (RuleSummaryData).

예제: "example"

is_available불리언필수

현재 컨텍스트에서 항목을 사용할 수 있는지 나타냅니다.

예제: true

market_scope문자열필수

전체 시장에 적용되는지 특정 시장에만 적용되는지 나타냅니다.

제약 조건

enum

["all", "selected"]

예제: "all"

name문자열필수

해당 컨텍스트의 리소스 이름입니다.

예제: "Example"

updated_at문자열필수

가장 최근 업데이트 시각입니다.

format: "date-time"

예제: "2026-01-01T12:00:00Z"

version정수필수

동시성 제어에 사용하는 리소스 버전입니다.

예제: 1

추가 필드: 아니요

category_ids배열 <문자열> 선택 사항

관련 카테고리 식별자입니다.

maxItems: 100

배열:minLength: 1maxLength: 63

enabled불리언선택 사항

이 설정이 활성화되어 있는지 나타냅니다.

expected_version정수필수

쓰기 전에 읽은 버전이며 일치하지 않으면 업데이트가 거부됩니다.

minimum: 1maximum: 2147483647

예제: 1

market_ids배열 <문자열> 선택 사항

선택한 시장의 식별자입니다.

maxItems: 1000

배열:minLength: 1maxLength: 63

market_scope문자열선택 사항

전체 시장에 적용되는지 특정 시장에만 적용되는지 나타냅니다.

제약 조건

enum

["all", "selected"]

name문자열선택 사항

해당 컨텍스트의 리소스 이름입니다.

minLength: 1maxLength: 160

예제: "Example"

phrases배열 <문자열> 선택 사항

검색 규칙에 사용하는 문구입니다.

maxItems: 20

배열:minLength: 1maxLength: 255

product_ids배열 <문자열> 선택 사항

관련 상품의 식별자입니다.

maxItems: 100

배열:minLength: 1maxLength: 63

추가 필드: 아니요

추가 필드: 예