non-print

API Index

Introduction

Cafe24 Analytics API (Beta)

To develop a data provision service, you can use Cafe24 Analytics API to retrieve online customer data. Please note that prior approval from Cafe24 is required to access this API.

Please use any information obtained through this API only for the approved channels, media platforms, or purposes. Any other use is strictly prohibited.

Data before 2023 is based on data from EC Admin > Statistics > Access Statistics. Data after 2023 is based on data from EC Admin > Statistics > Cafe24 Analytics.

Cafe24 Analytics API provides an OAuth 2.0-based authentication system, standard HTTP request methods, predictable endpoint URLs, and HTTP status code-based error messages..

Request/Response Format

API requests and responses support JSON format.
To protect personal information, Cafe24 Analytics API only supports HTTPS protocol.
Date attribute format is ISO_8601 E.g. YYYY-MM-DDTHH:MM:SS+09:00

Request sample (GET)

Sample result

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

Failure response sample

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

Method

Each resource supports "Read,” and you can use it by utilizing standard HTTP methods.

GET: You can retrieve (Read) the corresponding resource information.

Cafe24 Analytics API Intro

Cafe24 Analytics API

Cafe24 Analytics API is designed to retrieve customer behavior data for online stores. It can retrieve nearly all customer behavior data and can only be accessed by users authenticated through a separate OAuth 2.0 authentication process.

  Example  
 Page view : https://ca-api.cafe24data.com/visitors/pageview?mall_id=몰아이디&shop_no=1&start_date=2023-02-01&end_date=2023-02-10
Visitor : 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	Case	Troubleshooting
200	GET is successful
401	1) API was called without an access token 2) Access token is invalid 3) Access Token is expired 4) Client is unknown	Check if the access token was obtained through a valid issuance process.
401	"client_id" is not entered.	Check if "client_id" is valid.
403	Access token is valid, but the user does not have the required scope permissions.	Check the API scopes or store settings to ensure that you have the necessary permissions to call this API.
403	Not a HTTPS protocol	Check if you used HTTPS method to call this API.
404	1) Wrong API URL was called 2) Resource cannot be found 3) {#id} is missing	Refer to the API documentation to make sure that the correct endpoint URL has been used for the API call.
422	Retrieve or Process request has different values than the specifications 1) Required parameters are missing 2) Entered parameters are not the same as the ones in the specifications	Refer to the API documentation to make sure that all required parameters are included and that the entered values are valid according to the specifications.
429	Client's API requests have consumed all tokens in the bucket.	Wait a moment and try again, make sure not to exceed the maximum allowed number of API requests.
500	Internal server errors, unknown errors	A temporary error has occurred, try again later.
503	Server is down	Contact us through Cafe24 Developers.
503	Server is down, API cannot be used	Contact us through Cafe24 Developers.
504	Request timeout (Timeout)	A temporary error has occurred and response is being delayed, try again later.

How to use GET API

Cafe24 Analytics API offers various methods to retrieve data, and the following describes how to call data in various ways using different parameters.

1. Adding search parameters

You can add parameters to an endpoint to search with multiple conditions.

If you want to search multiple conditions, use "&" as a delimiter.

  검색조건 추가  
 E.g. Retrieve the page view count for a specific store within a specified time range.
GET https://ca-api.cafe24data.com/visitors/pageview?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01

E.g. Retrieve the visitor count for a specific store by domain within a specified time range.
GET https://ca-api.cafe24data.com/visitpaths/domains?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01

E.g. Retrieve the sales amount and quantity for a specific store by product within a specified time range.
GET https://ca-api.cafe24data.com/products/sales?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01

E.g. Retrieve the count of customers who placed an order, count of orders, and sales amount by the hour for a specific store within a specified time range.
GET https://ca-api.cafe24data.com/sales/times?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01 

2. Pagination

By default, the API retrieves 100 search results.

If there are more results to be retrieved, you can use the "offset" parameter to retrieve an additional 100 results per request.

  Pagination  
 E.g. Retrieve search result items (1-100)
GET https://ca-api.cafe24data.com/visitors/pageview?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01

E.g. Retrieve search result items (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

E.g. Retrieve search result items (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

E.g. Retrieve search result items (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

CA API uses "Token Bucket" algorithm.

Tokens are added to the bucket at a "fixed rate," and each request for a resource consumes one token from the bucket. If the bucket is empty, request will be limited. One token will be added to the bucket every two seconds.

If an app makes calls API at a rate of once every two seconds, it can continue to use the API without any limitations.
If the number of calls made "exceeds the call limit" in one second, 429 error (Too Many Requests) will be returned.

To avoid 429 errors, you can check how many tokens are left in the bucket by looking at the "x-ratelimit-remaining" field in the Response Header under Header.

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

Authentication

Access token can be used as a token issued by the shopping mall (EC Admin API).

Get Authentication Code

The code used to obtain a token is not reusable, and expires one minute after the issuance.

{mallid}: Enter store ID.
{client_id}: Enter "client_id" generated for your app on Cafe24 Developers.
{state}: To prevent tampering, enter a value that will be returned along with the code.
{redirect_uri}: Enter Redirect URL generated for your app on Cafe24 Developers.
{scope}: Specify the permissions for the resource servers that you want to access with the access token.

To obtain an access token, you must request an access code first. The access code is for client-side web applications. Request the access cod on a web browser not through cURL.

Request Copy

GET 'https://{mallid}.cafe24api.com/api/v2/oauth/authorize?response_type=code&client_id={client_id}&state={state}&redirect_uri={redirect_uri}&scope={scope}'

Sample result

HTTP/1.1 302 Found
Location: {redirect_uri}?code={authorize_code}&state={state}

Get Access Token

With the access code, you can get a user token (Access token, Refresh token) to call the API.

{mallid}: Enter store ID.
{client_id}: Enter client_id generated for your app on Cafe24 Developers.
{client_secret}: Enter "client_secret" generated for your app on Cafe24 Developers.
{code}: Enter the obtained code.
{redirect_uri}: Enter "Redirect URL" generated for your app on Cafe24 Developers.

access_token: This token is used by the client to access the resource servers.

refresh_token: This token is used to obtain a new access token after the previous one has expired.

Request sample

Sample result

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

Access token expires two hours after the issuance. Once expired, you need to obtain a new access token using the refresh token to continue accessing the resource servers. If you have obtained an access token, you can use "refresh_token" to renew it.

Refresh token is valid for 2 weeks. If you make a request before the refresh token is expired, both renewed access token and new refresh token will be returned. The existing refresh token will no longer be valid.

With the access code, you can get a user token (Access token, Refresh token) to call the API.

{mallid}: Enter store ID.
{domain}: Enter store domain.
{client_id}: Enter "client_id" generated for your app on Cafe24 Developers.
{client_secret}: Enter "client_secret" generated for your app on Cafe24 Developers.
{refresh_token}: Enter token "refresh_token" obtained while getting an access token.

access_token: This token is used by the client to access the resource servers.

refresh_token: This token is used to obtain a new access token after the previous one has expired.

Request sample

Sample result

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

You can revoke the access token you requested.

When the access token is revoked, the refresh token corresponding to the token requested is also revoked.

{mallid} : Enter the corresponding shopping mall ID.
{domain} : Enter the domain of the shopping mall.
{Client_id} : Enter the client_id of the app created by the developer center.
{client_secret} : Enter the client_secret of the app created by the developer center.
{token} : Enter the access token to be revoked.

Example (request)

Example (response)

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

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