non-print

API Index

Introduction

Cafe24 Analytics API (Beta)

Cafe24 Analytics API는 카페24 쇼핑몰의 사용자 행동 데이터를 제공하여 데이터 제공 서비스를 제작하는 카페24의 승인을 받은 제휴사에 제공되는 API입니다.

본 API를 통해 취득한 정보는 사전 승인되지 않은 채널(또는 미디어) 및 목적을 위해 사용할 수 없습니다.

2023년 이전 데이터는 EC Admin > 통계 > 접속통계의 데이터를 기반으로 제공되고, 2023년 이후 데이터는 EC Admin > 통계 > 카페24 애널리틱스의 데이터를 기반으로 제공됩니다.

Cafe24 Analytics API는 OAuth 2.0 기반의 인증 시스템과 표준 HTTP Request Method, 리소스를 예측할 수 있는 엔드포인트 URL, HTTP 코드 기반의 에러 메시지를 제공합니다.

Request/Response Format

API 요청과 응답은 JSON Format을 지원합니다.
개인정보 보호를 위하여 Cafe24 Analytics API는 HTTPS 프로토콜만 지원합니다.
Dates 속성은 ISO_8601 Format으로 제공합니다. : YYYY-MM-DDTHH:MM:SS+09:00

요청 예제 (조회)

정상 응답 예제

{
  "resource": {
      "key": "value",
      "key": "value"
   }
}

에러 응답 예제

{
  "error": {
      "code": "error code",
      "message": "error message",
      "more_info": {
      }
  }
}

Method

각 리소스 별로 Read를 지원하며 표준 HTTP Method를 사용하여 API를 사용할 수 있습니다.

GET : 해당 리소스의 정보를 조회(Read)합니다.

Cafe24 Analytics API Intro

Cafe24 Analytics API는 쇼핑몰의 사용자 행동 데이터를 조회하는데 적합합니다. Cafe24 Analytics API는 해당 리소스의 정보를 대부분 조회할 수 있으며 OAuth 2.0 방식의 별도 인증을 통과한 경우에만 사용할 수 있습니다.

  사용 예시  
 페이지뷰 : https://ca-api.cafe24data.com/visitors/pageview?mall_id=몰아이디&shop_no=1&start_date=2023-02-01&end_date=2023-02-10
방문자수 : https://ca-api.cafe24data.com/visitors/view?mall_id=몰아이디&shop_no=1&start_date=2023-02-01&end_date=2023-02-10 

API Status Code

Code	발생하는 사례	오류 해결 방법
200	GET 성공
401	1) Access Token 없이 호출한 경우 2) Access Token이 유효하지 않은 경우 3) Access Token이 만료된 경우 4) 알 수 없는 클라이언트일 경우	유효한 클라이언트 ID를 사용하였는지 확인합니다.
401	API 사용시 client_id를 미입력한 경우	유효한 클라이언트 ID를 사용하였는지 확인합니다.
403	Access Token은 있으나 해당 Scope에 권한이 없음	API를 호출할 수 있는 권한이 있는지 API의 Scope 또는 쇼핑몰의 설정을 확인합니다.
403	https 프로토콜이 아닌 경우	API 요청시 https 로 요청하였는지 확인합니다.
404	1) API URL을 잘못 호출한 경우 2) 리소스를 찾을 수 없을 경우 3) {#id}가 없는 경우	엔드포인트 URL의 오류가 있는지 API문서를 참고하여 확인합니다.
422	조회/처리 요청시 값이 정해진 스펙과 다를 경우 1) 필수 파라메터 누락함 2) 정해진 스펙과 다를 경우	API문서를 참고하여 필수 파라미터가 입력되지 않았거나 유효하지 않은 타입의 값을 입력하지 않았는지 확인합니다.
429	클라이언트의 API 요청이 Bucket에 Token 을 모두 소모한 경우	API 최대 허용 요청 건수를 초과하지 않도록 잠시 후 다시 요청합니다.
500	내부 서버 에러, 알 수 없는 에러	개발자센터로 문의해주세요.
503	현재 서버가 다운된 경우	개발자센터로 문의해주세요.
503	서버가 다운된 경우. API를 사용할 수 없음.	개발자센터로 문의해주세요.
504	요청 시간이 초과된 경우(Timeout)	일시적으로 에러가 발생하여 응답이 지연되고 있습니다. 잠시 후에 다시 시도해주세요.

How to use GET API

Cafe24 Analytics API는 데이터를 조회하는 여러가지 방법을 제공하고 있습니다.

다음은 API 조회시 여러가지 파라메터를 사용하여 다양하게 데이터를 호출할 수 있는 방법을 설명하고 있습니다.

1. 검색조건 추가

검색조건은 엔드포인트에 파라메터를 추가하여 검색할 수 있습니다.

여러 조건을 같이 검색할 경우 "&" 구분자를 이용하여 검색 조건을 추가할 수 있습니다.

  검색조건 추가  
 예) 특정 상점의 특정 기간 동안의 페이지 뷰 조회
GET https://ca-api.cafe24data.com/visitors/pageview?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01

예) 특정 상점의 특정 기간 동안의 도메인별 방문수 조회
GET https://ca-api.cafe24data.com/visitpaths/domains?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01

예) 특정 상점의 특정 기간 동안의 상품별 매출액, 판매건수 조회
GET https://ca-api.cafe24data.com/products/sales?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01

예) 특정 상점의 특정 기간 동안의 시간별 구매자수, 구매건수, 매출액 조회
GET https://ca-api.cafe24data.com/sales/times?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01 

2. Pagination

기본적으로 100개의 결과가 조회됩니다.

조회 결과가 많을 경우, offset 파라미터로 100개씩 추가로 결과를 조회할 수 있습니다.

  Pagination  
 예) 페이지 뷰 100건 조회
GET https://ca-api.cafe24data.com/visitors/pageview?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01

예) 101번째부터 200번째까지의 페이지뷰 조회
GET hhttps://ca-api.cafe24data.com/visitors/pageview?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01&offset=100

예) 201번째부터 300번째까지의 페이지뷰 조회
GET hhttps://ca-api.cafe24data.com/visitors/pageview?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01&offset=200

예) 301번째부터 400번째까지의 페이지뷰 조회
GET hhttps://ca-api.cafe24data.com/visitors/pageview?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01&offset=300 

API Limit

Cafe24 Analytics API 에서 사용되는 알고리즘은 "Token Bucket" 입니다.

Token Bucket 알고리즘은 Bucket 안에 "호출건 수 제한" 만큼 Token 담아두고, 요청이 들어올 때 1 씩 Token 수를 감소하여 Bucket 에 더 이상 사용할 Token 이 없을 때 요청을 제한합니다. Bucket 안에 Token은 1초에 2씩 다시 증가합니다.

만약 앱이 1초에 2회씩 API 를 요청한다면 API 요청은 별다른 제약 없이 계속 사용할 수 있습니다. 순간적으로 1초 이내에 "호출건 수 제한" 이상의 콜이 발생한다면 429 에러(Too Many Request)를 반환합니다. Header에 Response Header 에 "x-ratelimit-remaining" 으로 Bucket 에 Token이 얼마나 남았는지 확인하여 429 에러를 피할 수 있습니다.

 Response Header
> X-RateLimit-Remaining: 9
> X-RateLimit-Requested-Tokens: 1
> X-RateLimit-Burst-Capacity: 10
> X-RateLimit-Replenish-Rate: 2 

Authentication

접근 토큰(access_token)은 쇼핑몰(EC Admin API)에서 발급되는 토큰으로 사용하실 수 있습니다.

Get Authentication Code

토큰발급 요청시 사용된 code는 재사용할 수 없으며 코드 발급 후 1분이 경과하면 만료됩니다.

{mallid} : 해당 쇼핑몰ID를 입력합니다.
{client_id} : 개발자 센터에서 생성한 앱의 client_id를 입력합니다.
{state} : 위변조 방지를 위해 입력하는 값으로 코드 반환시 같은 값이 반환됩니다.
{redirect_uri} : 개발자 센터에서 생성한 앱의 Redirect URL을 입력합니다.
{scope} : 해당 접근 토큰으로 접근할 리소스 서버의 권한을 입력할 수 있습니다.

접근 토큰을 발급 받으려면 면저 접근 코드를 요청해야 합니다. 접근 코드는 클라이언트가 웹 애플리케이션 형태일 경우 이용됩니다. 코드 요청은 cURL이 아닌 웹브라우저에서 진행하셔야 합니다.

  예시 코드 (요청)  
 GET 'https://{mallid}.cafe24api.com/api/v2/oauth/authorize?response_type=code&client_id={client_id}&state={state}&redirect_uri={redirect_uri}&scope={scope}' 
  예시 코드 (응답)  
 HTTP/1.1 302 Found
Location: {redirect_uri}?code={authorize_code}&state={state} 

Get Access Token

발급 받은 인증 코드를 사용하여 실제로 API를 호출할 수 있는 사용자 토큰(Access Token, Refresh Token)을 받아 올 수 있습니다.

{mallid} : 해당 쇼핑몰ID를 입력합니다.
{client_id} : 개발자 센터에서 생성한 앱의 client_id를 입력합니다.
{client_secret} : 개발자 센터에서 생성한 앱의 client_secret을 입력합니다.
{code} : 발급받은 코드를 입력합니다.
{redirect_uri} : 개발자 센터에서 생성한 앱의 Redirect URL을 입력합니다.

access_token : 접근 토큰으로서 클라이언트가 리소스 서버에 접근시 사용됩니다.

refresh_token : 접근 토큰 만료 후 재발급을 위해 사용하는 토큰입니다.

예시 코드 (요청)

예시 코드 (응답)

HTTP/1.1 200 OK
{
    "access_token": "0iqR5nM5EJIq..........",
    "expires_at": "2021-03-01T14:00:00.000",
    "refresh_token": "JeTJ7XpnFC0P..........",
    "refresh_token_expires_at": "2021-03-15T12:00:00.000",
    "client_id": "BrIfqEKoPxeE..........",
    "mall_id": "yourmall",
    "user_id": "test",
    "scopes": [
        "mall.analytics",
        "...etc...",
    ],
    "issued_at": "2021-03-01T12:00:00.000"
}

Get Access Token using refresh token

접근 토큰은 발급 받은 후 2시간이 지나면 사용할 수 없습니다. 접근 토큰이 만료된 후 다시 재발급을 받아야 리소스 서버에 접근할 수 있습니다. 이미 접근 토큰을 발급 받았다면 refresh_token를 사용하여 접근 토큰을 재발급 받을수 있습니다.

refresh token은 2주간 유효하며, refresh token 만료전에 요청을 하면 갱신된 access token과 갱신된 refresh token이 함께 반환됩니다. 기존 refresh token은 만료처리되어 사용할 수 없습니다.

발급 받은 인증 코드를 사용하여 실제로 API를 호출할 수 있는 사용자 토큰(Access Token, Refresh Token)을 받아 올 수 있습니다.

{mallid} : 해당 쇼핑몰ID를 입력합니다.
{domain} : 해당 쇼핑몰의 도메인을 입력합니다.
{client_id} : 개발자 센터에서 생성한 앱의 client_id를 입력합니다.
{client_secret} : 개발자 센터에서 생성한 앱의 client_secret을 입력합니다.
{refresh_token} : 토큰 발급시 받은 refresh_token을 입력합니다.

access_token : 접근 토큰으로서 클라이언트가 리소스 서버에 접근시 사용됩니다.

refresh_token : 접근 토큰 만료 후 재발급을 위해 사용하는 토큰입니다.

예시 코드 (요청)

예시 코드 (응답)

HTTP/1.1 200 OK
{
    "access_token": "21EZes0dGSfN..........",
    "expires_at": "2021-03-01T15:50:00.000",
    "refresh_token": "xLlhWztQHBik............",
    "refresh_token_expires_at": "2021-03-15T13:50:00.000",
    "client_id": "BrIfqEKoPxeE..........",
    "mall_id": "yourmall",
    "user_id": "test",
    "scopes": [
        "mall.analytics",
        "...etc...",
    ],
    "issued_at": "2021-03-01T13:50:00.000"
}

Revoke Access Token

Access Token을 사용하여 직접 토큰을 폐기할 수 있습니다.

요청한 토큰에 해당하는 리프레시 토큰도 함께 폐기됩니다.

{mallid} : 해당 쇼핑몰ID를 입력합니다.
{client_id} : 개발자 센터에서 생성한 앱의 client_id를 입력합니다.
{client_secret} : 개발자 센터에서 생성한 앱의 client_secret을 입력합니다.
{token} : 토큰 발급시 받은 access_token을 입력합니다.

예시 코드 (요청)

예시 코드 (응답)

HTTP/1.1 200 OK

Analytics

Adeffect addetails

Endpoints

GET /adeffect/addetails

Adeffect addetails properties

Attribute	Description
ad	광고매체 네이버
keyword	검색어 onepiece
visit_count	방문수 200
visit_rate	방문비율 20.2
purchase_count	구매건수 1053
purchase_rate	구매율 15.5
order_amount	매출액 360000
order_amount_per_visitor	방문당매출 1800
order_amount_per_buyer	구매당매출 1900

List all adeffect addetails

GET /adeffect/addetails

GET

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 ad : 광고매체 keyword : 조회수 visit_count : 담긴수 purchase_count : 구매건수 DEFAULT ad
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT asc

Request Copy

Response Copy

Carts action

Endpoints

GET /carts/action

Carts action properties

Attribute	Description
product_no	상품번호 100
product_name	상품명 셔츠
count	조회수 200
add_cart_count	담긴수 30000
add_cart_rate	담김율 30

List all carts action

GET /carts/action

GET

담긴 상품은 각 상품별로 노출 수 대비 장바구니에 담긴수를 비교한 정보를 제공합니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 product_name : 상품명 count : 조회수 add_cart_count : 담긴수 add_cart_rate : 담김율 DEFAULT count
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT desc

Request Copy

Response Copy

Members sales

Endpoints

GET /members/sales

Members sales properties

Attribute	Description
member_order_count	회원 구매건수 1000
member_order_amount	회원 매출액 90000
nonmember_order_count	비회원 구매건수 2000
nonmember_order_amount	비회원 매출액 80000

List all members sales

GET /members/sales

GET

구매건수와 매출액을 회원과 비회원으로 구분하여 분석한 정보를 제공합니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100

Request Copy

Response Copy

Pages view

Endpoints

GET /pages/view

Pages view properties

Attribute	Description
url	url cafe24.com
count	접속수 1000
visit_count	방문자수 2000
first_visit_count	처음접속수 3000

List all pages view

GET /pages/view

GET

많이 찾는 페이지는 쇼핑몰 사이트의 웹 페이지 중 방문자가 가장 많이 접속한 페이지들에 대한 분석 정보를 제공합니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 url : url count : 조회수 visit_count : 방문자수 first_visit_count : 처음접속수 DEFAULT count
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT desc

Request Copy

Response Copy

Products categorydetails

Endpoints

GET /products/categorydetails

Products categorydetails properties

Attribute	Description
product_no	상품번호 98766789
product_name	상품명 티셔츠
product_code	상품코드 P00BDFAW
category_name	카테고리명 상의
category_no	카테고리번호 1591
sales_count_per_category	카테고리별 판매건수 1000
sales_item_per_category	카테고리별 판매물품수 2000
sales_price_per_category	카테고리별 상품판매금액 30000
carts_count_per_category	카테고리별 담긴수 40000

List all products categorydetails

GET /products/categorydetails

GET

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 product_no : 상품번호 product_name : 상품명 order_count : 판매건수 order_product_count : 판매물품수 order_amount : 매출액 DEFAULT product_name
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT asc

Request Copy

Response Copy

Products sales

Endpoints

GET /products/sales

Products sales properties

Attribute	Description
product_no	상품번호 98766789
product_name	상품명 셔츠
order_count	판매건수 3
order_product_count	판매물품수 2
order_amount	매출액 30000

List all products sales

GET /products/sales

GET

각 상품에 대해 장바구니에 담긴수, 판매건수, 판매물품수, 판매금액 정보를 제공합니다.

- 판매건수
조회기간 동안 해당 상품이 판매된 횟수입니다. 결제 완료된 주문만 집계됩니다.

- 판매물품수
조회기간 동안 해당 상품이 판매된 수량입니다. 결제 완료된 주문만 집계됩니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 product_no : 상품번호 product_name : 상품명 order_count : 판매건수 order_product_count : 판매물품수 order_amount : 매출액 DEFAULT order_amount
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT desc

Request Copy

Response Copy

Products view

Endpoints

GET /products/view

Products view properties

Attribute

Description

product_no

상품번호

98766789

product_name

상품명

셔츠

count

조회수

List all products view

GET /products/view

GET

각 상품에 대해 조회수 정보를 제공합니다.

상품 상세 페이지에 접속(노출) 될 경우 집계 됩니다.
- 시간, 날짜, IP에 관계없이 모든 접속 횟수를 집계하여 제공되고 있습니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 product_no : 상품번호 product_name : 상품명 count : 조회수 DEFAULT count
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT desc

Request Copy

Response Copy

Sales orderdetails

Endpoints

GET /sales/orderdetails

Sales orderdetails properties

Attribute	Description
order_id	주문번호 20240201-0000000
ad	광고매체 ad
keyword	검색어 keyword
payment_method	결제수단 card
order_amount	매출액 218200

List all sales orderdetails

GET /sales/orderdetails

GET

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 order_id : 주문번호 ad : 광고매체 keyword : 검색어 payment_method : 결제수단 order_amount : 매출액 DEFAULT order_id
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT asc

Request Copy

Response Copy

Sales paymethods

Endpoints

GET /sales/paymethods

Sales paymethods properties

Attribute	Description
payment_method	결제수단 c
buyers_count	구매자수 100
order_count	구매건수 200
order_amount	매출액 집계 30000

List all sales paymethods

GET /sales/paymethods

GET

구매자가 결제완료(입금완료) 된 일자를 기준으로 결제수단별로 집계한 정보를 제공합니다.
주문일을 기준으로 집계하는 쇼핑몰어드민의 '영업관리'와 집계기준의 차이 때문에 값이 다르게 보일 수 있지만, 실제 주문과 차이는 없습니다.

(단, 결제취소, 결제대기, 할인금액, 쿠폰할인 금액은 집계되지 않습니다.)

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 payment_method : 결제수단 buyers_count : 구매자수 order_count : 구매건수 order_amount : 매출액 DEFAULT order_amount
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT desc

Request Copy

Response Copy

Sales pervisitors

Endpoints

GET /sales/pervisitors

Sales pervisitors properties

Attribute	Description
order_amount_per_visitor	방문 1인당 매출액 10000
order_amount_per_buyer	구매 1인당 매출액 20000

Attribute

Description

order_amount_per_visitor

방문 1인당 매출액

10000

order_amount_per_buyer

구매 1인당 매출액

20000

List all sales pervisitors

GET /sales/pervisitors

GET

매출액과 고객수를 비교하여 고객 1명당의 가치를 평가한 정보를 제공합니다.

- 방문고객1인당 매출액
매출액을 방문 고객수로 나눈 금액을 의미하며, 집계된 정보를 바탕으로 방문고객 1인당 발생하는 매출액을 추산 할 수 있습니다.
방문고객1인당 매출액 = 결제완료(입금완료)된 매출액 / 방문자수

- 구매고객1인당 매출액
매출액을 구매자수로 나눈 금액을 의미합니다.
집계된 정보를 바탕으로 구매고객 1인당 발생하는 매출액을 추산할 수 있으며, 쇼핑몰 실질 방문자의 구매력을 나타냅니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100

Request Copy

Response Copy

Sales times

Endpoints

GET /sales/times

Sales times properties

Attribute	Description
hour	시간 1
buyers_count	구매자수 100
order_count	구매건수 200
order_amount	매출액 30000

List all sales times

GET /sales/times

GET

결제완료(입금확인) 된 일자를 기준으로 집계한 정보를 제공합니다.
주문일을 기준으로 집계하는 쇼핑몰어드민의 '영업관리'와 집계기준의 차이 때문에 값이 다르게 보일 수 있지만, 실제 주문과 차이는 없습니다.
(단, 환불/교환/취소와 할인/쿠폰할인 금액은 매출액에 반영되지 않습니다.)

- 조회기간 동안 발생한 주문의 결제 금액입니다. 결제 완료된 주문만 집계됩니다.
- 네이버페이, 카카오페이를 사용하여 결제된 주문도 반영됩니다.
- 단, 타 마켓연동 주문은 반영되지 않습니다. (자사몰 매출만 취급)

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 hour : 시간대 buyers_count : 구매자수 order_count : 구매건수 order_amount : 매출액 DEFAULT hour
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT asc

Request Copy

Response Copy

Visitors dailyactive

Endpoints

GET /visitors/dailyactive

Visitors dailyactive properties

Attribute

Description

date

날짜

2023-01-01

user_count

사용자수

List all visitors dailyactive

GET /visitors/dailyactive

GET

DAU
- Daily Active User의 약자입니다.
- 해당 일(DAU) 동안 중복 방문을 제거한 순수 사용자 수를 의미합니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 date : 날짜 user_count : 사용자수 DEFAULT date
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT asc

Request Copy

Response Copy

Visitors pageview

Endpoints

GET /visitors/pageview

Visitors pageview properties

Attribute

Description

date

날짜

2023-01-01

hour

시간

page_view

페이지뷰

List all visitors pageview

GET /visitors/pageview

GET

페이지뷰는 방문자가 쇼핑몰 내에서 본 페이지의 총 수를 의미합니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
format_type	데이터 형식 day: 일별 hour: 시간별 DEFAULT day
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 date : 날짜 page_view : 페이지뷰 DEFAULT date
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT asc

Request Copy

Response Copy

Visitors unique

Endpoints

GET /visitors/unique

Visitors unique properties

Attribute

Description

date

날짜

2023-01-01

unique_visit_count

순방문자수

List all visitors unique

GET /visitors/unique

GET

순 방문자수는 쇼핑몰에 방문한 전체 방문자 수에서 중복 IP를 제외한 순수 방문자 수 입니다.

중복IP를 제외한 방문자 수이며 동일한 PC 또는 모바일 기기로 여러번 방문시 IP 정보가 다를 경우 접속된 IP수 만큼 순방문자 수가 증가합니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 date : 날짜 unique_visit_count : 순방문자수 DEFAULT date
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT asc

Request Copy

Response Copy

Visitors view

Endpoints

GET /visitors/view

Visitors view properties

Attribute	Description
date	날짜 2023-01-01
hour	시간 1
visit_count	방문자수 32
first_visit_count	처음방문자수 20
re_visit_count	재방문자수 12

List all visitors view

GET /visitors/view

GET

전체 방문자수는 방문자가 쇼핑몰내 방문한 총 수를 의미하며 처음방문수와 재방문수의 합과 일치합니다.
방문자수는 세션타임아웃, 브라우저종료 후 재 방문시 방문자수가 증가 합니다.

* 방문의 정의

- 방문의 정의는 통계 서비스마다 상이하며, 카페24 애널리틱스는 사용자의 접속~마지막 활동으로부터 60분까지를 기준으로 합니다.
- 따라서 한 번 접속했다가 사이트 창을 닫았더라도, 마지막 활동으로부터 60분 이내에 다시 접속했다면 같은 방문입니다.
- 마지막 활동으로부터 60분이 경과하면 방문이 종료되었다고 간주하며, 이후에 다시 접속(또는 활동)하더라도 다른 방문으로 집계됩니다.
- 또한 방문은 브라우저 별로 구분되므로, 한 기기에서 다른 브라우저로 중복 접속하는 경우 각각 다른 방문으로 집계됩니다.

* 예외 사항

만약 방문 의도의 변화가 감지된다면(유입 경로, 검색어, 광고 정보가 이전과 다른 경우) 방문이 유지되고 있더라도 다른 방문으로 집계됩니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
format_type	데이터 형식 day: 일별 hour: 시간별 DEFAULT day
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 date : 날짜 visit_count : 방문자수 first_visit_count : 처음방문자수 re_visit_count : 재방문자수 DEFAULT date
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT asc

Request Copy

Response Copy

Visitpaths adkeywordsales

Endpoints

GET /visitpaths/adkeywordsales

Visitpaths adkeywordsales properties

Attribute	Description
ad	광고매체명 ad
keyword	검색어 keyword
order_count	구매건수 1000
order_amount	매출액 10000

List all visitpaths adkeywordsales

GET /visitpaths/adkeywordsales

GET

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 keyword : 검색어 order_count : 구매건수 order_amount : 매출액 DEFAULT ad
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT asc

Request Copy

Response Copy

Visitpaths ads

Endpoints

GET /visitpaths/ads

Visitpaths ads properties

Attribute

Description

광고매체명

visit_count

방문자수

List all visitpaths ads

GET /visitpaths/ads

GET

쇼핑몰 유입 시의 광고 정보를 분석한 결과입니다.

해당 광고 정보로 유입되어 방문이 유지되는 동안 발생한 성과만 집계합니다. (직접전환)

광고 정보가 존재하지 않는 경우, '채널 없음'으로 표시됩니다.

UTM 파라미터의 종류

- utm_source: 광고 매체사(채널)를 식별하는 용도입니다. 예) google, youtube, instagram, facebook 등
- utm_medium: 광고 형태(그룹)를 식별하는 용도입니다. 예) display, search, video, cpc, cpm 등
- utm_campaign: 광고의 목적이나 컨텐츠 등(캠페인)을 식별하는 용도입니다. 주로 utm_source와 utm_medium보다 세부 구분이 필요할 때 사용됩니다. 예) spring_sale, black_friday 등
- utm_term: 광고 키워드를 식별하는 용도입니다. 예) onepiece 등
- 올바른 분석을 위하여 utm_source와 utm_medium은 필수로 사용해주세요.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 ad : 광고매체명 visit_count : 방문수 DEFAULT visit_count
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT desc

Request Copy

Response Copy

Visitpaths adsales

Endpoints

GET /visitpaths/adsales

Visitpaths adsales properties

Attribute

Description

광고매체명

order_count

구매건수

1000

order_amount

매출액

10000

List all visitpaths adsales

GET /visitpaths/adsales

GET

네이버, 다음, 구글, 크리테오 등 광고 매체별로 발생한 방문통계와 구매 관련 분석 정보를 제공합니다.

- 광고종류
네이버, 다음, 구글, 크리테오 등 온라인 광고를 제공하는 업체의 광고상품(네이버클릭초이스, 다음클릭스, 구글애드워즈 등)을 의미합니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 ad : 광고매체명 order_count : 구매건수 order_amount : 매출액 DEFAULT order_amount
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT desc

Request Copy

Response Copy

Visitpaths domains

Endpoints

GET /visitpaths/domains

Visitpaths domains properties

Attribute

Description

domain

도메인

cafe24.com

visit_count

방문자수

1000

List all visitpaths domains

GET /visitpaths/domains

GET

쇼핑몰에 유입되기 직전에 거쳐온 URL이 있는 경우, 해당 URL의 도메인 부분을 의미합니다.

도메인 정보가 없는 경우에는 '참조 도메인 없음'으로 표시됩니다. (일반적으로 '직접 유입' 또는 '다이렉트'라고 부르는 것과 같은 개념)

'참조 도메인 없음'의 주요 케이스
- 브라우저 주소창에 직접 URL을 입력하여 유입
- 즐겨찾기 등록을 통한 유입
- 앱을 통한 유입
- 유입 출처가 남지 않는 형태의 광고를 통한 유입 등

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 domain : 도메인 visit_count : 방문수 DEFAULT visit_count
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT desc

Request Copy

Response Copy

Visitpaths domainsales

Endpoints

GET /visitpaths/domainsales

Visitpaths domainsales properties

Attribute

Description

domain

도메인

cafe24.com

order_count

구매건수

1000

order_amount

매출액

10000

List all visitpaths domainsales

GET /visitpaths/domainsales

GET

방문한 도메인을 기준으로 방문도메인별로 구매건수, 매출액을 제공합니다.

- 구매건수
검색엔진, 포탈, 블로그, SNS 등의 도메인이 있는 링크 및 북마크를 통해 쇼핑몰에 방문 한 후 결제완료된 건수를 의미합니다.

- 매출액
매출액은 도메인 및 북마크를 통해 방문한 후 결제완료(입금완료)된 금액의 합을 의미합니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 domain : 도메인 order_count : 구매건수 order_amount : 매출액 DEFAULT order_amount
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT desc

Request Copy

Response Copy

Visitpaths keyworddetails

Endpoints

GET /visitpaths/keyworddetails

Visitpaths keyworddetails properties

Attribute	Description
keyword	검색어 onepiece
engine	검색엔진 네이버
visit_count	방문수 200
purchase_count	구매건수 1053
purchase_rate	구매율 15.5
order_amount	매출액 360000
order_amount_per_visitor	방문당매출 1800
order_amount_per_buyer	구매당매출 1900

List all visitpaths keyworddetails

GET /visitpaths/keyworddetails

GET

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 keyword : 검색어 engine: 검색엔진 purchase_count : 구매건수 order_amount : 매출액 DEFAULT keyword
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT asc

Request Copy

Response Copy

Visitpaths keywords

Endpoints

GET /visitpaths/keywords

Visitpaths keywords properties

Attribute

Description

keyword

검색어

keyword

visit_count

방문자수

1000

List all visitpaths keywords

GET /visitpaths/keywords

GET

네이버클릭초이스, 다음클릭스, 구글애드워즈 등 온라인 키워드 검색광고로 발생한 방문통계 정보를 제공합니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 keyword : 검색어 visit_count : 방문수 DEFAULT visit_count
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT desc

Request Copy

Response Copy

Visitpaths keywordsales

Endpoints

GET /visitpaths/keywordsales

Visitpaths keywordsales properties

Attribute

Description

keyword

검색어

keyword

order_count

구매건수

1000

order_amount

매출액

10000

List all visitpaths keywordsales

GET /visitpaths/keywordsales

GET

네이버클릭초이스, 다음클릭스, 구글애드워즈 등 온라인 키워드 검색광고로 발생한 방문통계의 구매건수, 매출액 정보를 제공합니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 keyword : 검색어 order_count : 구매건수 order_amount : 매출액 DEFAULT order_amount
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT desc

Request Copy

Response Copy

Visitpaths urls

Endpoints

GET /visitpaths/urls

Visitpaths urls properties

Attribute

Description

url

cafe24.com

visit_count

방문자수

1000

List all visitpaths urls

GET /visitpaths/urls

GET

쇼핑몰에 접속하기전 웹사이트 URL을 의미합니다.
'도메인(.com, .net, co.kr 등) / 페이지' 형태로 정보를 제공합니다.

기본스펙

Property	Description
SCOPE	접속통계 읽기권한 (mall.read_analytics)
호출건수 제한	0

요청사양

Parameter	Description
mall_id Required	몰 아이디 샘플 아이디
shop_no	샵 번호 샵 번호 DEFAULT 1
start_date Required	시작일 2023-01-01
end_date Required	종료일 2023-02-01
device_type	디바이스 타입 pc: pc mobile: 모바일 total: 전체
limit	응답 갯수 최소: 50 최대: 1000 기본: 100 DEFAULT 100
offset	오프셋 DEFAULT 0
sort	정렬 값 url : url visit_count : 방문수 DEFAULT visit_count
order	정렬 순서 desc: 내림차순 asc: 오름차순 DEFAULT desc

Request Copy

Response Copy