sayren Docs
Analytics

방문 분석 개요

기간 합계, 세션 기준 구매 퍼널(세션 → 상품 조회 → 장바구니 → 결제 시작 → 구매), 날짜별 값을 돌려준다. 스코프 `analytics:r`. - 날짜는 Asia/Seoul 기준이며 `from`·`to` 모두 포함한다. 최대 92일. - 스토어프런트가 `@sayren/storefront-sdk`로 수집한 이벤트를 주기적으로 집계한 값이다. 오늘 값은 `lastComputedAt` 시점까지 반영된다. - 봇·자동화 브라우저의 세션은 빠진다. 테스트 결제(샌드박스 결제)로 만든 구매는 기본 제외이고 `includeTest=true`면 포함한다. - `visitors`는 날짜별 순방문자의 합이다(여러 날 방문한 사람은 날마다 센다).

GET
/v1/analytics/overview

기간 합계, 세션 기준 구매 퍼널(세션 → 상품 조회 → 장바구니 → 결제 시작 → 구매), 날짜별 값을 돌려준다. 스코프 analytics:r.

  • 날짜는 Asia/Seoul 기준이며 from·to 모두 포함한다. 최대 92일.
  • 스토어프런트가 @sayren/storefront-sdk로 수집한 이벤트를 주기적으로 집계한 값이다. 오늘 값은 lastComputedAt 시점까지 반영된다.
  • 봇·자동화 브라우저의 세션은 빠진다. 테스트 결제(샌드박스 결제)로 만든 구매는 기본 제외이고 includeTest=true면 포함한다.
  • visitors는 날짜별 순방문자의 합이다(여러 날 방문한 사람은 날마다 센다).

Authorization

bearer
AuthorizationBearer <token>

userToken(계정 스코프) 또는 storeToken(스토어 스코프)

In: header

Query Parameters

from*string

시작일 (YYYY-MM-DD, Asia/Seoul 기준, 포함)

Match^\d{4}-\d{2}-\d{2}$
to*string

종료일 (YYYY-MM-DD, 포함). from부터 최대 92일

Match^\d{4}-\d{2}-\d{2}$
includeTest?string

테스트 결제(샌드박스 결제)로 만든 구매 포함 여부. 기본 false

Value in

  • "true"
  • "false"

Response Body

application/json

curl -X GET "https://example.com/v1/analytics/overview?from=string&to=string"
{  "meta": {    "status": 0,    "code": "OK",    "message": "string",    "isSuccess": true  },  "data": {    "from": "string",    "to": "string",    "timezone": "Asia/Seoul",    "currency": "KRW",    "includeTest": true,    "lastComputedAt": "string",    "summary": {      "visitors": -9007199254740991,      "sessions": -9007199254740991,      "engagedSessions": -9007199254740991,      "pageViews": -9007199254740991,      "engagementSeconds": -9007199254740991,      "productViews": -9007199254740991,      "productViewSessions": -9007199254740991,      "addToCartSessions": -9007199254740991,      "beginCheckoutSessions": -9007199254740991,      "purchaseSessions": -9007199254740991,      "purchases": -9007199254740991,      "revenue": -9007199254740991,      "engagementRate": 0,      "conversionRate": 0    },    "funnel": [      {        "step": "SESSION",        "sessions": -9007199254740991,        "rateFromPrevious": 0      }    ],    "rows": [      {        "visitors": -9007199254740991,        "sessions": -9007199254740991,        "engagedSessions": -9007199254740991,        "pageViews": -9007199254740991,        "engagementSeconds": -9007199254740991,        "productViews": -9007199254740991,        "productViewSessions": -9007199254740991,        "addToCartSessions": -9007199254740991,        "beginCheckoutSessions": -9007199254740991,        "purchaseSessions": -9007199254740991,        "purchases": -9007199254740991,        "revenue": -9007199254740991,        "engagementRate": 0,        "conversionRate": 0,        "date": "string"      }    ]  },  "error": null}

Store API 개요

관리(셀러) API 레퍼런스

상품별 방문 분석 GET

상품별 목록 노출·상세 조회·장바구니 담기·구매를 돌려준다. 스코프 `analytics:r`. - 날짜는 Asia/Seoul 기준이며 `from`·`to` 모두 포함한다. 최대 92일. - 스토어프런트가 `@sayren/storefront-sdk`로 수집한 이벤트를 주기적으로 집계한 값이다. 오늘 값은 `lastComputedAt` 시점까지 반영된다. - 봇·자동화 브라우저의 세션은 빠진다. 테스트 결제(샌드박스 결제)로 만든 구매는 기본 제외이고 `includeTest=true`면 포함한다. - 구매 금액은 주문 상품 금액 합계다. 상품명은 현재 이름이고 삭제된 상품은 null이다.