요약 — 검색 분석과 규칙
“검색 분석과 규칙”의 데이터를 조회합니다. 결과는 이 작업의 매개변수에 따라 달라집니다.
GET/api/v1/search/overview
- 인증
Bearer- 최소 요금제
- STANDARD
- 필수 권한
search.analytics:read
코드 예제
요청 예제
cURL
: "${SHOPENTLY_SHOP_URL:?}"
curl --disable --globoff --fail-with-body --silent --show-error \
--proto '=https' --connect-timeout 5 --max-time 30 \
--request GET \
--header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
--url "${SHOPENTLY_SHOP_URL%/}"/api/v1/search/overview
PHP
<?php
declare(strict_types=1);
$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
isset($origin['query']) || isset($origin['fragment'])) {
throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/search/overview');
curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 30,
CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
if (str_contains($line, ':')) {
[$name, $value] = explode(':', $line, 2);
$responseHeaders[strtolower(trim($name))] = trim($value);
}
return strlen($line);
},
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
throw new RuntimeException('HTTP ' . $status . '; request_id=' .
($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;
Python
from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit
import requests # python -m pip install requests
base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
headers["Content-Type"] = "application/json"
with ExitStack() as stack:
session = stack.enter_context(requests.Session())
files = None
if False:
image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
if os.fstat(image.fileno()).st_size > 5242880:
raise ValueError("Image exceeds 5 MiB")
files = {"file": ("article.png", image, "image/png")}
response = session.request(
'GET', base_url + '/api/v1/search/overview', headers=headers,
data=body.encode("utf-8") if body is not None else None, files=files,
timeout=(5, 30), allow_redirects=False,
)
if not 200 <= response.status_code < 300:
raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
if False:
if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
raise ValueError("Unexpected image response")
with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
output.write(response.content)
else:
result = response.json() if response.content else None
print(json.dumps(result, ensure_ascii=False, indent=2))
응답 예제 200
{
"data": {
"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
},
"meta": {
"period": {
"as_of": "2026-01-02T00:00:00Z",
"days": 1,
"started_at": "2026-01-01T00:00:00Z"
},
"request_id": "example"
}
}
작동 방식
- GET /api/v1/search/overview 와 /api/v1/search/queries 는 요약 통계와 그룹화된 검색어를 제공합니다.
- 검색어의 query_hash 로 개별 발생 기록을 조회하세요.
- 보고 기간은 7일, 30일 또는 90일이며 각 엔드포인트에 명시된 필터를 사용할 수 있습니다.
- 검색 규칙은 문구를 선택한 상품과 카테고리에 연결하며 생성, 조회, 업데이트, 삭제할 수 있습니다.
- 규칙과 분석의 권한은 별개이므로 검색 통계를 읽는 권한만으로 설정을 변경할 수 없습니다.
매개변수
쿼리 매개변수
days정수선택 사항보고 기간의 일수입니다.
제약 조건
enum[7, 30, 90]
이 작업은 JSON 본문을 받지 않습니다.
응답
응답 200
전체 모델: AnalyticsResponse_OverviewData_
dataOverviewData필수성공 응답의 데이터입니다.
필드 ·
dataclick_through_rate숫자필수선택한 검색 데이터의 클릭률입니다.
clicked_searches정수필수클릭이 발생한 검색 수입니다.
recent배열 <RecentSearchData> 필수최근 검색 정보입니다.
필드 ·
recentsearches정수필수검색 수입니다.
zero_result_rate숫자필수결과가 없는 검색의 비율입니다.
zero_results정수필수결과가 없는 검색 수입니다.
metaAnalyticsPageMetaAnalyticsMeta필수응답 메타데이터입니다.
필드 ·
metapaginationPagination필수커서 기반 페이지 나누기 메타데이터입니다.
periodAnalyticsPeriodData필수보고 기간과 시작·종료 경계입니다.
request_id문자열필수고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.
minLength:1maxLength:100
periodAnalyticsPeriodData필수보고 기간과 시작·종료 경계입니다.
request_id문자열필수고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.
minLength:1maxLength:100
HTTP 상태
200- 성공 응답 스키마
400- 잘못된 요청
401- 인증 필요
403- 권한 없음
404- 리소스를 찾을 수 없음
409- 버전 충돌
422- 유효성 검사 실패
429- 요청 한도 초과
기타 HTTP 상태 (7)
405- 허용되지 않은 메서드
413- 요청이 너무 큼
415- 지원하지 않는 형식
500- 서버 오류
502- API 게이트웨이 오류
503- 서비스 이용 불가
504- 시간 초과
오류 목록: ErrorResponse
헤더
401
WWW-Authenticate문자열선택 사항서버가 요구하는 인증 방식입니다.
405
Allow문자열선택 사항이 리소스가 지원하는 HTTP 메서드입니다.
429, 503
Retry-After정수선택 사항재시도 전에 기다려야 하는 최소 시간(초)입니다.
minimum:0