GET/api/v4/locations/{locationId}/review-analytics-overview

상호작용 분석 조회

사업장의 리뷰 분석 개요(KPI)를 반환합니다. 2개의 관련 라우트는 시계열 타임라인과 사이트별 세부 분석을 반환합니다.

API 키가 필요합니다. 헤더 형식과 키 교체는 인증을 참고하세요.

매개변수

경로

이름유형필수설명
locationIdstring필수Location ID, a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`).

쿼리

이름유형필수설명기본값
startDatestring선택Start of the analytics period (YYYY-MM-DD). Optional here: it narrows the window the KPIs and their deltas are computed over. Required by the timeline route.—
endDatestring선택End of the analytics period (YYYY-MM-DD). Optional here, required by the timeline route.—

응답

200Overview analytics for the location.
Response
{  "data": {    "interactionsAnalyticsStats": {      "stats": [        { "name": "total-reviews", "value": 128, "delta": 6.67 },        { "name": "new-reviews", "value": 9, "delta": -25 },        { "name": "overall-rating", "value": 4.43, "delta": 2.31 },        { "name": "review-response-rate", "value": 62.5, "delta": 12.5 }      ]    }  }}
401Unauthenticated, missing or invalid API key.

단일 사업장의 리뷰 분석을 반환합니다. 이 라우트는 개요 KPI를 반환하며, 다른 형태의 분석은 관련 라우트 2개가 반환하며, 각 라우트는 별도 페이지에서 설명합니다.

  • review-analytics-overview(이 페이지): 전체 통계: total-reviews, new-reviews, overall-rating(평균, 1–5), review-response-rate(백분율). 응답 키: interactionsAnalyticsStats.
  • review-analytics-timeline: 지정한 날짜 범위의 상호작용 수와 평균 평점에 대한 일별 시계열입니다. 응답 키: interactionsChartData. startDate 및 endDate가 필요합니다.
  • review-analytics-sites-stats: 각 소스 사이트의 평균 평점, 총 상호작용 수, 최근 활동을 보여 주는 플랫폼별 세부 분석입니다. 응답 키: interactionsSitesStats.

stats의 각 항목에는 name, value, delta가 포함됩니다. delta는 직전 동일 길이의 기간 대비 변화율입니다(이전 기간이 없는 신규 계정에서는 100으로 표시됩니다).

사용 사례: 사업장 성과 요약 타일

매장 대시보드에 "리뷰 한눈에 보기" 타일을 표시하려면 사업장 ID만 지정하여 이 엔드포인트를 호출하며, 개요에는 날짜 범위가 필요하지 않습니다. 대표 별점 평균은 overall-rating에서 읽고, 팀이 답글을 작성한 리뷰 수는 review-response-rate로 표시합니다. 타일에 30일 추세 스파크라인이 필요하면 review-analytics-timeline과 함께 사용합니다(startDate/endDate를 전달합니다).

locationId에는 원시 숫자형 데이터베이스 ID와 Base64 Relay ID를 구분 없이 사용할 수 있으므로, 모든 사업장 목록 조회에서 반환받은 ID를 그대로 재사용할 수 있습니다.

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/review-analytics-overview' \  -H "Authorization: API $LISTINGSAPI_KEY"