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	Advertising media naver
keyword	Search keyword onepiece
visit_count	Visits 200
visit_rate	Visits (%) 20.2
purchase_count	Purchase count 1053
purchase_rate	Conversion rate 15.5
order_amount	Sales 360000
order_amount_per_visitor	Sales per visitor 1800
order_amount_per_buyer	Sales per buyer 1900

List all adeffect addetails cafe24

GET /adeffect/addetails

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value ad: Advertising media keyword: Views visit_count: Add-to-cart count purchase_count: Purchase count DEFAULT ad
order	Sort order desc: Descending order asc: Ascending order DEFAULT asc

Request Copy

Response Copy

Carts action

Endpoints

GET /carts/action

Carts action properties

Attribute	Description
product_no	Product number 100
product_name	Product name Shirt
count	Views 200
add_cart_count	Add-to-cart count 30000
add_cart_rate	Add-to-cart rate 30

List all carts action cafe24

GET /carts/action

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value product_name: Product name count: Views add_cart_count: Add-to-cart count add_cart_rate: Add-to-cart rate DEFAULT count
order	Sort order desc: Descending order asc: Ascending order DEFAULT desc

Request Copy

Response Copy

Members sales

Endpoints

GET /members/sales

Members sales properties

Attribute	Description
member_order_count	Purchase count (Customer) 1000
member_order_amount	Sales (Customer) 90000
nonmember_order_count	Purchase count (Guest) 2000
nonmember_order_amount	Sales (Guest) 80000

List all members sales cafe24

GET /members/sales

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100

Request Copy

Response Copy

Pages view

Endpoints

GET /pages/view

Pages view properties

Attribute	Description
url	URL cafe24.com
count	Views 1000
visit_count	Visitors 2000
first_visit_count	First-time visits 3000

List all pages view cafe24

GET /pages/view

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value url: URL count: Views visit_count: Visitors first_visit_count: First-time visits DEFAULT count
order	Sort order desc: Descending order asc: Ascending order DEFAULT desc

Request Copy

Response Copy

Products categorydetails

Endpoints

GET /products/categorydetails

Products categorydetails properties

Attribute	Description
product_no	Product number 98766789
product_name	Product name T-shirt
product_code	Product code P00BDFAW
category_name	Category name Top
category_no	Category number 1591
sales_count_per_category	Number of sales by category 1000
sales_item_per_category	Number of items sold by category 2000
sales_price_per_category	Number of sales revenue by category 30000
carts_count_per_category	Add-to-cart count by category 40000

List all products categorydetails cafe24

GET /products/categorydetails

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value product_no: Product number product_name: Product name order_count: Purchase count order_product_count: Number of items sold order_amount: Sales DEFAULT product_name
order	Sort order desc: Descending order asc: Ascending order DEFAULT asc

Request Copy

Response Copy

Products sales

Endpoints

GET /products/sales

Products sales properties

Attribute	Description
product_no	Product number 98766789
product_name	Product name Shirt
order_count	Purchase count 3
order_product_count	Number of items sold 2
order_amount	Sales 30000

List all products sales cafe24

GET /products/sales

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value product_no: Product number product_name: Product name order_count: Purchase count order_product_count: Number of items sold order_amount: Sales DEFAULT order_amount
order	Sort order desc: Descending order asc: Ascending order DEFAULT desc

Request Copy

Response Copy

Products view

Endpoints

GET /products/view

Products view properties

Attribute

Description

product_no

Product number

98766789

product_name

Product name

Shirt

count

Views

Data Product Hits Analysis API cafe24

GET /products/view

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value product_no: Product number product_name: Product name count: Views DEFAULT count
order	Sort order desc: Descending order asc: Ascending order DEFAULT desc

Request Copy

Response Copy

Sales orderdetails

Endpoints

GET /sales/orderdetails

Sales orderdetails properties

Attribute	Description
order_date	Order date 2024-06-04
order_id	Order number 20240201-0000000
ad	Advertising media ad
keyword	Search keyword keyword
medium	Media medium
campaign	Campaign campaign
content	Content content
payment_method	Payment method card
order_amount	Sales 218200

List all sales orderdetails cafe24

GET /sales/orderdetails

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
orderId	Order number 20240201-0000000 DEFAULT 20240602-0017928
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value order_id: Order number ad: Advertising media keyword: Search keyword payment_method: Payment method order_amount: Sales DEFAULT order_id
order	Sort order desc: Descending order asc: Ascending order DEFAULT asc

Request Copy

Response Copy

Sales paymethods

Endpoints

GET /sales/paymethods

Sales paymethods properties

Attribute	Description
payment_method	Payment method c
buyers_count	Number of buyers 100
order_count	Purchase count 200
order_amount	Sales 30000

List all sales paymethods cafe24

GET /sales/paymethods

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value payment_method: Payment method buyers_count: Number of buyers order_count: Purchase count order_amount: Sales DEFAULT order_amount
order	Sort order desc: Descending order asc: Ascending order DEFAULT desc

Request Copy

Response Copy

Sales pervisitors

Endpoints

GET /sales/pervisitors

Sales pervisitors properties

Attribute	Description
order_amount_per_visitor	Sales per visitor 10000
order_amount_per_buyer	Sales per buyer 20000

Attribute

Description

order_amount_per_visitor

Sales per visitor

10000

order_amount_per_buyer

Sales per buyer

20000

List all sales pervisitors cafe24

GET /sales/pervisitors

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100

Request Copy

Response Copy

Sales times

Endpoints

GET /sales/times

Sales times properties

Attribute	Description
hour	Time 1
buyers_count	Number of buyers 100
order_count	Purchase count 200
order_amount	Sales 30000

List all sales times cafe24

GET /sales/times

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value hour: Time buyers_count: Number of buyers order_count: Purchase count order_amount: Sales DEFAULT hour
order	Sort order desc: Descending order asc: Ascending order DEFAULT asc

Request Copy

Response Copy

Visitors dailyactive

Endpoints

GET /visitors/dailyactive

Visitors dailyactive properties

Attribute

Description

date

Date

2023-01-01

user_count

Number of users

List all visitors dailyactive cafe24

GET /visitors/dailyactive

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value date: Date user_count: Number of users DEFAULT date
order	Sort order desc: Descending order asc: Ascending order DEFAULT asc

Request Copy

Response Copy

Visitors pageview

Endpoints

GET /visitors/pageview

Visitors pageview properties

Attribute

Description

date

Date

2023-01-01

hour

Time

page_view

Page views

List all visitors pageview cafe24

GET /visitors/pageview

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
format_type	Data type day: Daily hour: Hourly DEFAULT day
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value date: Date page_view: Page views DEFAULT date
order	Sort order desc: Descending order asc: Ascending order DEFAULT asc

Request Copy

Response Copy

Visitors unique

Endpoints

GET /visitors/unique

Visitors unique properties

Attribute

Description

date

Date

2023-01-01

unique_visit_count

Number of unique users

List all visitors unique cafe24

GET /visitors/unique

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value date: Date unique_visit_count: Number of unique users DEFAULT date
order	Sort order desc: Descending order asc: Ascending order DEFAULT asc

Request Copy

Response Copy

Visitors view

Endpoints

GET /visitors/view

Visitors view properties

Attribute	Description
date	Date 2023-01-01
hour	Time 1
visit_count	Visitors 32
first_visit_count	First-time visitors 20
re_visit_count	Number of returning visitors 12

List all visitors view cafe24

GET /visitors/view

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
format_type	Data type day: Daily hour: Hourly DEFAULT day
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value date: Date visit_count: Visitors first_visit_count: First-time visitors re_visit_count: Number of returning visitors DEFAULT date
order	Sort order desc: Descending order asc: Ascending order DEFAULT asc

Request Copy

Response Copy

Visitpaths adkeywordsales

Endpoints

GET /visitpaths/adkeywordsales

Visitpaths adkeywordsales properties

Attribute	Description
ad	Advertising media name ad
keyword	Search keyword keyword
order_count	Purchase count 1000
order_amount	Sales 10000

List all visitpaths adkeywordsales cafe24

GET /visitpaths/adkeywordsales

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value keyword: Search keyword order_count: Purchase count order_amount: Sales DEFAULT ad
order	Sort order desc: Descending order asc: Ascending order DEFAULT asc

Request Copy

Response Copy

Visitpaths ads

Endpoints

GET /visitpaths/ads

Visitpaths ads properties

Attribute

Description

Advertising media name

visit_count

Visitors

List all visitpaths ads cafe24

GET /visitpaths/ads

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value ad: Advertising media name visit_count: Visitors DEFAULT visit_count
order	Sort order desc: Descending order asc: Ascending order DEFAULT desc

Request Copy

Response Copy

Visitpaths adsales

Endpoints

GET /visitpaths/adsales

Visitpaths adsales properties

Attribute

Description

Advertising media name

order_count

Purchase count

1000

order_amount

Sales

10000

List all visitpaths adsales cafe24

GET /visitpaths/adsales

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value ad: Advertising media name order_count: Purchase count order_amount: Sales DEFAULT order_amount
order	Sort order desc: Descending order asc: Ascending order DEFAULT desc

Request Copy

Response Copy

Visitpaths domains

Endpoints

GET /visitpaths/domains

Visitpaths domains properties

Attribute

Description

domain

Domain

cafe24.com

visit_count

Visitors

1000

List all visitpaths domains cafe24

GET /visitpaths/domains

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value domain: Domain visit_count: Visitors DEFAULT visit_count
order	Sort order desc: Descending order asc: Ascending order DEFAULT desc

Request Copy

Response Copy

Visitpaths domainsales

Endpoints

GET /visitpaths/domainsales

Visitpaths domainsales properties

Attribute

Description

domain

Domain

cafe24.com

order_count

Purchase count

1000

order_amount

Sales

10000

List all visitpaths domainsales cafe24

GET /visitpaths/domainsales

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value domain: Domain order_count: Purchase count order_amount: Sales DEFAULT order_amount
order	Sort order desc: Descending order asc: Ascending order DEFAULT desc

Request Copy

Response Copy

Visitpaths keyworddetails

Endpoints

GET /visitpaths/keyworddetails

Visitpaths keyworddetails properties

Attribute	Description
keyword	Search keyword onepiece
engine	Search engine Naver
visit_count	Visits 200
purchase_count	Purchase count 1053
purchase_rate	Conversion rate 15.5
order_amount	Sales 360000
order_amount_per_visitor	Sales per visitor 1800
order_amount_per_buyer	Sales per buyer 1900

List all visitpaths keyworddetails cafe24

GET /visitpaths/keyworddetails

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value keyword: Search keyword engine: Search engine purchase_count: Purchase count order_amount: Sales DEFAULT keyword
order	Sort order desc: Descending order asc: Ascending order DEFAULT asc

Request Copy

Response Copy

Visitpaths keywords

Endpoints

GET /visitpaths/keywords

Visitpaths keywords properties

Attribute

Description

keyword

Search keyword

keyword

visit_count

Visitors

1000

List all visitpaths keywords cafe24

GET /visitpaths/keywords

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value keyword: Search keyword visit_count: Visitors DEFAULT visit_count
order	Sort order desc: Descending order asc: Ascending order DEFAULT desc

Request Copy

Response Copy

Visitpaths keywordsales

Endpoints

GET /visitpaths/keywordsales

Visitpaths keywordsales properties

Attribute

Description

keyword

Search keyword

keyword

order_count

Purchase count

1000

order_amount

Sales

10000

List all visitpaths keywordsales cafe24

GET /visitpaths/keywordsales

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value keyword: Search keyword order_count: Purchase count order_amount: Sales DEFAULT order_amount
order	Sort order desc: Descending order asc: Ascending order DEFAULT desc

Request Copy

Response Copy

Visitpaths urls

Endpoints

GET /visitpaths/urls

Visitpaths urls properties

Attribute

Description

url

URL

cafe24.com

visit_count

Visitors

1000

List all visitpaths urls cafe24

GET /visitpaths/urls

GET

Specification

Property	Description
SCOPE	mall.read_analytics
Request Limit	0

Request

Parameter	Description
mall_id Required	Store ID Sample ID
shop_no	Store number Store number DEFAULT 1
start_date Required	Start date 2023-01-01
end_date Required	End date 2023-02-01
device_type	Device type pc: PC mobile: Mobile total: All
limit	Number of responses Minimum: 50 Maximum: 1000 Default: 100 DEFAULT 100
offset	Offset DEFAULT 0
sort	Sort value url: URL visit_count: Visitors DEFAULT visit_count
order	Sort order desc: Descending order asc: Ascending order DEFAULT desc

Request Copy

Response Copy