닫기
  • Analytics

    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

    Adeffect addetails properties

    Attribute Description
    ad

    api.adeffect.dto.AdDetailsDTO.ad.title

    api.adeffect.dto.AdDetailsDTO.ad.description

    keyword

    api.adeffect.dto.AdDetailsDTO.keyword.title

    api.adeffect.dto.AdDetailsDTO.keyword.description

    visit_count

    api.adeffect.dto.AdDetailsDTO.visitCount.title

    api.adeffect.dto.AdDetailsDTO.visitCount.description

    visit_rate

    api.adeffect.dto.AdDetailsDTO.visitRate.title

    api.adeffect.dto.AdDetailsDTO.visitRate.description

    purchase_count

    api.adeffect.dto.AdDetailsDTO.purchaseCount.title

    api.adeffect.dto.AdDetailsDTO.purchaseCount.description

    purchase_rate

    api.adeffect.dto.AdDetailsDTO.purchaseRate.title

    api.adeffect.dto.AdDetailsDTO.purchaseRate.description

    order_amount

    api.adeffect.dto.AdDetailsDTO.orderAmount.title

    api.adeffect.dto.AdDetailsDTO.orderAmount.description

    order_amount_per_visitor

    api.adeffect.dto.AdDetailsDTO.orderAmountPerVisitor.title

    api.adeffect.dto.AdDetailsDTO.orderAmountPerVisitor.description

    order_amount_per_buyer

    api.adeffect.dto.AdDetailsDTO.orderAmountPerBuyer.title

    api.adeffect.dto.AdDetailsDTO.orderAmountPerBuyer.description

    List all adeffect addetails

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.adeffect.request.AdDetailsReq.offset.title

    api.adeffect.request.AdDetailsReq.offset.description

    DEFAULT 0

    sort

    api.adeffect.request.AdDetailsReq.sort.title

    api.adeffect.request.AdDetailsReq.sort.description

    DEFAULT ad

    order

    api.adeffect.request.AdDetailsReq.order.title

    api.adeffect.request.AdDetailsReq.order.description

    DEFAULT asc

    List all adeffect addetails
    Request Copy
    Response Copy

    Carts action

    Endpoints

    Carts action properties

    Attribute Description
    product_no

    api.carts.dto.ActionDTO.productNo.title

    api.carts.dto.ActionDTO.productNo.description

    product_name

    api.carts.dto.ActionDTO.productName.title

    api.carts.dto.ActionDTO.productName.description

    count

    api.carts.dto.ActionDTO.count.title

    api.carts.dto.ActionDTO.count.description

    add_cart_count

    api.carts.dto.ActionDTO.addCartCount.title

    api.carts.dto.ActionDTO.addCartCount.description

    add_cart_rate

    api.carts.dto.ActionDTO.addCartRate.title

    api.carts.dto.ActionDTO.addCartRate.description

    List all carts action

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.carts.request.ActionReq.offset.title

    api.carts.request.ActionReq.offset.description

    DEFAULT 0

    sort

    api.carts.request.ActionReq.sort.title

    api.carts.request.ActionReq.sort.description

    DEFAULT count

    order

    api.carts.request.ActionReq.order.title

    api.carts.request.ActionReq.order.description

    DEFAULT desc

    List all carts action
    Request Copy
    Response Copy

    Members sales

    Endpoints

    Members sales properties

    Attribute Description
    member_order_count

    api.members.dto.SalesDTO.memberOrderCount.title

    api.members.dto.SalesDTO.memberOrderCount.description

    member_order_amount

    api.members.dto.SalesDTO.memberOrderAmount.title

    api.members.dto.SalesDTO.memberOrderAmount.description

    nonmember_order_count

    api.members.dto.SalesDTO.nonmemberOrderCount.title

    api.members.dto.SalesDTO.nonmemberOrderCount.description

    nonmember_order_amount

    api.members.dto.SalesDTO.nonmemberOrderAmount.title

    api.members.dto.SalesDTO.nonmemberOrderAmount.description

    List all members sales

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    List all members sales
    Request Copy
    Response Copy

    Pages view

    Endpoints

    Pages view properties

    Attribute Description
    url

    api.pages.dto.ViewDTO.url.title

    api.pages.dto.ViewDTO.url.description

    count

    api.pages.dto.ViewDTO.count.title

    api.pages.dto.ViewDTO.count.description

    visit_count

    api.pages.dto.ViewDTO.visitCount.title

    api.pages.dto.ViewDTO.visitCount.description

    first_visit_count

    api.pages.dto.ViewDTO.firstVisitCount.title

    api.pages.dto.ViewDTO.firstVisitCount.description

    List all pages view

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.pages.request.ViewReq.offset.title

    api.pages.request.ViewReq.offset.description

    DEFAULT 0

    sort

    api.pages.request.ViewReq.sort.title

    api.pages.request.ViewReq.sort.description

    DEFAULT count

    order

    api.pages.request.ViewReq.order.title

    api.pages.request.ViewReq.order.description

    DEFAULT desc

    List all pages view
    Request Copy
    Response Copy

    Products categorydetails

    Products categorydetails properties

    Attribute Description
    product_no

    api.products.dto.Product.productNo.title

    api.products.dto.Product.productNo.description

    product_name

    api.products.dto.CategoryDetailsDTO.productName.title

    api.products.dto.CategoryDetailsDTO.productName.description

    product_code

    api.products.dto.CategoryDetailsDTO.productCode.title

    api.products.dto.CategoryDetailsDTO.productCode.description

    category_name

    api.products.dto.CategoryDetailsDTO.categoryName.title

    api.products.dto.CategoryDetailsDTO.categoryName.description

    category_no

    api.products.dto.CategoryDetailsDTO.categoryNo.title

    api.products.dto.CategoryDetailsDTO.categoryNo.description

    sales_count_per_category

    api.products.dto.CategoryDetailsDTO.salesCountPerCategory.title

    api.products.dto.CategoryDetailsDTO.salesCountPerCategory.description

    sales_item_per_category

    api.products.dto.CategoryDetailsDTO.salesItemPerCategory.title

    api.products.dto.CategoryDetailsDTO.salesItemPerCategory.description

    sales_price_per_category

    api.products.dto.CategoryDetailsDTO.salesPricePerCategory.title

    api.products.dto.CategoryDetailsDTO.salesPricePerCategory.description

    carts_count_per_category

    api.products.dto.CategoryDetailsDTO.cartsCountPerCategory.title

    api.products.dto.CategoryDetailsDTO.cartsCountPerCategory.description

    List all products categorydetails

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.products.request.SalesReq.offset.title

    api.products.request.SalesReq.offset.description

    DEFAULT 0

    sort

    api.products.request.SalesReq.sort.title

    api.products.request.SalesReq.sort.description

    DEFAULT product_name

    order

    api.products.request.SalesReq.order.title

    api.products.request.SalesReq.order.description

    DEFAULT asc

    List all products categorydetails
    Request Copy
    Response Copy

    Products sales

    Products sales properties

    Attribute Description
    product_no

    api.products.dto.Product.productNo.title

    api.products.dto.Product.productNo.description

    product_name

    api.products.dto.Product.productName.title

    api.products.dto.Product.productName.description

    order_count

    api.products.dto.SalesDTO.orderCount.title

    api.products.dto.SalesDTO.orderCount.description

    order_product_count

    api.products.dto.SalesDTO.orderProductCount.title

    api.products.dto.SalesDTO.orderProductCount.description

    order_amount

    api.products.dto.SalesDTO.orderAmount.title

    api.products.dto.SalesDTO.orderAmount.description

    List all products sales

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.products.request.SalesReq.offset.title

    api.products.request.SalesReq.offset.description

    DEFAULT 0

    sort

    api.products.request.SalesReq.sort.title

    api.products.request.SalesReq.sort.description

    DEFAULT order_amount

    order

    api.products.request.SalesReq.order.title

    api.products.request.SalesReq.order.description

    DEFAULT desc

    List all products sales
    Request Copy
    Response Copy

    Products view

    Endpoints

    Products view properties

    Attribute Description
    product_no

    api.products.dto.Product.productNo.title

    api.products.dto.Product.productNo.description

    product_name

    api.products.dto.Product.productName.title

    api.products.dto.Product.productName.description

    count

    api.products.dto.ViewDTO.count.title

    api.products.dto.ViewDTO.count.description

    Data Product Hits Analysis API

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.products.request.ViewReq.offset.title

    api.products.request.ViewReq.offset.description

    DEFAULT 0

    sort

    sort_value

    product_no : product number
    product_name : product name
    count : view count

    DEFAULT count

    order

    sort_order

    desc: descending order
    asc: ascending order

    DEFAULT desc

    Data Product Hits Analysis API
    Request Copy
    Response Copy

    Sales orderdetails

    Sales orderdetails properties

    Attribute Description
    order_date

    api.sales.dto.OrderdetailsDTO.orderDate.title

    api.sales.dto.OrderdetailsDTO.orderDate.description

    order_id

    api.sales.dto.OrderdetailsDTO.orderId.title

    api.sales.dto.OrderdetailsDTO.orderId.description

    ad

    api.sales.dto.OrderdetailsDTO.ad.title

    api.sales.dto.OrderdetailsDTO.ad.description

    keyword

    api.sales.dto.OrderdetailsDTO.keyword.title

    api.sales.dto.OrderdetailsDTO.keyword.description

    medium

    api.sales.dto.OrderdetailsDTO.medium.title

    api.sales.dto.OrderdetailsDTO.medium.description

    campaign

    api.sales.dto.OrderdetailsDTO.campaign.title

    api.sales.dto.OrderdetailsDTO.campaign.description

    content

    api.sales.dto.OrderdetailsDTO.content.title

    api.sales.dto.OrderdetailsDTO.content.description

    payment_method

    api.sales.dto.OrderdetailsDTO.paymentMethod.title

    api.sales.dto.OrderdetailsDTO.paymentMethod.description

    order_amount

    api.sales.dto.OrderdetailsDTO.orderAmount.title

    api.sales.dto.OrderdetailsDTO.orderAmount.description

    List all sales orderdetails

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    orderId

    api.sales.request.OrderdetailsReq.orderId.title

    api.sales.request.OrderdetailsReq.orderId.description

    DEFAULT 20240602-0017928

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.sales.request.OrderdetailsReq.offset.title

    api.sales.request.OrderdetailsReq.offset.description

    DEFAULT 0

    sort

    api.sales.request.OrderdetailsReq.sort.title

    api.sales.request.OrderdetailsReq.sort.description

    DEFAULT order_id

    order

    api.sales.request.OrderdetailsReq.order.title

    api.sales.request.OrderdetailsReq.order.description

    DEFAULT asc

    List all sales orderdetails
    Request Copy
    Response Copy

    Sales paymethods

    Sales paymethods properties

    Attribute Description
    payment_method

    api.sales.dto.PaymethodsDTO.paymentMethod.title

    api.sales.dto.PaymethodsDTO.paymentMethod.description

    buyers_count

    api.sales.dto.PaymethodsDTO.buyersCount.title

    api.sales.dto.PaymethodsDTO.buyersCount.description

    order_count

    api.sales.dto.PaymethodsDTO.orderCount.title

    api.sales.dto.PaymethodsDTO.orderCount.description

    order_amount

    api.sales.dto.PaymethodsDTO.orderAmount.title

    api.sales.dto.PaymethodsDTO.orderAmount.description

    List all sales paymethods

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.sales.request.PaymethodsReq.offset.title

    api.sales.request.PaymethodsReq.offset.description

    DEFAULT 0

    sort

    api.sales.request.PaymethodsReq.sort.title

    api.sales.request.PaymethodsReq.sort.description

    DEFAULT order_amount

    order

    api.sales.request.PaymethodsReq.order.title

    api.sales.request.PaymethodsReq.order.description

    DEFAULT desc

    List all sales paymethods
    Request Copy
    Response Copy

    Sales pervisitors

    Sales pervisitors properties

    Attribute Description
    order_amount_per_visitor

    api.sales.dto.PervisitorsDTO.orderAmountPerVisitor.title

    api.sales.dto.PervisitorsDTO.orderAmountPerVisitor.description

    order_amount_per_buyer

    api.sales.dto.PervisitorsDTO.orderAmountPerBuyer.title

    api.sales.dto.PervisitorsDTO.orderAmountPerBuyer.description

    List all sales pervisitors

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    List all sales pervisitors
    Request Copy
    Response Copy

    Sales times

    Endpoints

    Sales times properties

    Attribute Description
    hour

    api.sales.dto.TimesDTO.hour.title

    api.sales.dto.TimesDTO.hour.description

    buyers_count

    api.sales.dto.TimesDTO.buyersCount.title

    api.sales.dto.TimesDTO.buyersCount.description

    order_count

    api.sales.dto.TimesDTO.orderCount.title

    api.sales.dto.TimesDTO.orderCount.description

    order_amount

    api.sales.dto.TimesDTO.orderAmount.title

    api.sales.dto.TimesDTO.orderAmount.description

    List all sales times

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.sales.request.TimesReq.offset.title

    api.sales.request.TimesReq.offset.description

    DEFAULT 0

    sort

    api.sales.request.TimesReq.sort.title

    api.sales.request.TimesReq.sort.description

    DEFAULT hour

    order

    api.sales.request.TimesReq.order.title

    api.sales.request.TimesReq.order.description

    DEFAULT asc

    List all sales times
    Request Copy
    Response Copy

    Visitors dailyactive

    Visitors dailyactive properties

    Attribute Description
    date

    api.visitors.dto.DailyActiveDTO.date.title

    api.visitors.dto.DailyActiveDTO.date.description

    user_count

    api.visitors.dto.DailyActiveDTO.userCount.title

    api.visitors.dto.DailyActiveDTO.userCount.description

    List all visitors dailyactive

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.visitors.request.DailyActiveReq.offset.title

    api.visitors.request.DailyActiveReq.offset.description

    DEFAULT 0

    sort

    api.visitors.request.DailyActiveReq.sort.title

    api.visitors.request.DailyActiveReq.sort.description

    DEFAULT date

    order

    api.visitors.request.DailyActiveReq.order.title

    api.visitors.request.DailyActiveReq.order.description

    DEFAULT asc

    List all visitors dailyactive
    Request Copy
    Response Copy

    Visitors pageview

    Visitors pageview properties

    Attribute Description
    date

    api.visitors.dto.PageViewDTO.date.title

    api.visitors.dto.PageViewDTO.date.description

    hour

    api.visitors.dto.PageViewDTO.hour.title

    api.visitors.dto.PageViewDTO.hour.description

    page_view

    api.visitors.dto.PageViewDTO.pageView.title

    api.visitors.dto.PageViewDTO.pageView.description

    List all visitors pageview

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    format_type

    api.visitors.request.PageViewReq.formatType.title

    api.visitors.request.PageViewReq.formatType.description

    DEFAULT day

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.visitors.request.PageViewReq.offset.title

    api.visitors.request.PageViewReq.offset.description

    DEFAULT 0

    sort

    api.visitors.request.PageViewReq.sort.title

    api.visitors.request.PageViewReq.sort.description

    DEFAULT date

    order

    api.visitors.request.PageViewReq.order.title

    api.visitors.request.PageViewReq.order.description

    DEFAULT asc

    List all visitors pageview
    Request Copy
    Response Copy

    Visitors unique

    Visitors unique properties

    Attribute Description
    date

    api.visitors.dto.UniqueDTO.date.title

    api.visitors.dto.UniqueDTO.date.description

    unique_visit_count

    api.visitors.dto.UniqueDTO.uniqueVisitCount.title

    api.visitors.dto.UniqueDTO.uniqueVisitCount.description

    List all visitors unique

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.visitors.request.UniqueReq.offset.title

    api.visitors.request.UniqueReq.offset.description

    DEFAULT 0

    sort

    api.visitors.request.UniqueReq.sort.title

    api.visitors.request.UniqueReq.sort.description

    DEFAULT date

    order

    api.visitors.request.UniqueReq.order.title

    api.visitors.request.UniqueReq.order.description

    DEFAULT asc

    List all visitors unique
    Request Copy
    Response Copy

    Visitors view

    Endpoints

    Visitors view properties

    Attribute Description
    date

    api.visitors.dto.ViewDTO.date.title

    api.visitors.dto.ViewDTO.date.description

    hour

    api.visitors.dto.ViewDTO.hour.title

    api.visitors.dto.ViewDTO.hour.description

    visit_count

    api.visitors.dto.ViewDTO.visitCount.title

    api.visitors.dto.ViewDTO.visitCount.description

    first_visit_count

    api.visitors.dto.ViewDTO.firstVisitCount.title

    api.visitors.dto.ViewDTO.firstVisitCount.description

    re_visit_count

    api.visitors.dto.ViewDTO.reVisitCount.title

    api.visitors.dto.ViewDTO.reVisitCount.description

    List all visitors view

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    format_type

    api.visitors.request.ViewReq.formatType.title

    api.visitors.request.ViewReq.formatType.description

    DEFAULT day

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.visitors.request.ViewReq.offset.title

    api.visitors.request.ViewReq.offset.description

    DEFAULT 0

    sort

    api.visitors.request.ViewReq.sort.title

    api.visitors.request.ViewReq.sort.description

    DEFAULT date

    order

    api.visitors.request.ViewReq.order.title

    api.visitors.request.ViewReq.order.description

    DEFAULT asc

    List all visitors view
    Request Copy
    Response Copy

    Visitpaths adkeywordsales

    Visitpaths adkeywordsales properties

    Attribute Description
    ad

    api.visitpaths.dto.AdKeywordSalesDTO.ad.title

    api.visitpaths.dto.AdKeywordSalesDTO.ad.description

    keyword

    api.visitpaths.dto.AdKeywordSalesDTO.keyword.title

    api.visitpaths.dto.AdKeywordSalesDTO.keyword.description

    order_count

    api.visitpaths.dto.AdKeywordSalesDTO.orderCount.title

    api.visitpaths.dto.AdKeywordSalesDTO.orderCount.description

    order_amount

    api.visitpaths.dto.AdKeywordSalesDTO.orderAmount.title

    api.visitpaths.dto.AdKeywordSalesDTO.orderAmount.description

    List all visitpaths adkeywordsales

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.visitpaths.request.AdKeywordSalesReq.offset.title

    api.visitpaths.request.AdKeywordSalesReq.offset.description

    DEFAULT 0

    sort

    api.visitpaths.request.AdKeywordSalesReq.sort.title

    api.visitpaths.request.AdKeywordSalesReq.sort.description

    DEFAULT ad

    order

    api.visitpaths.request.AdKeywordSalesReq.order.title

    api.visitpaths.request.AdKeywordSalesReq.order.description

    DEFAULT asc

    List all visitpaths adkeywordsales
    Request Copy
    Response Copy

    Visitpaths ads

    Visitpaths ads properties

    Attribute Description
    ad

    api.visitpaths.dto.AdsDTO.ad.title

    api.visitpaths.dto.AdsDTO.ad.description

    visit_count

    api.visitpaths.dto.AdsDTO.visitCount.title

    api.visitpaths.dto.AdsDTO.visitCount.description

    List all visitpaths ads

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.visitpaths.request.AdsReq.offset.title

    api.visitpaths.request.AdsReq.offset.description

    DEFAULT 0

    sort

    api.visitpaths.request.AdsReq.sort.title

    api.visitpaths.request.AdsReq.sort.description

    DEFAULT visit_count

    order

    api.visitpaths.request.AdsReq.order.title

    api.visitpaths.request.AdsReq.order.description

    DEFAULT desc

    List all visitpaths ads
    Request Copy
    Response Copy

    Visitpaths adsales

    Visitpaths adsales properties

    Attribute Description
    ad

    api.visitpaths.dto.AdSalesDTO.ad.title

    api.visitpaths.dto.AdSalesDTO.ad.description

    order_count

    api.visitpaths.dto.AdSalesDTO.orderCount.title

    api.visitpaths.dto.AdSalesDTO.orderCount.description

    order_amount

    api.visitpaths.dto.AdSalesDTO.orderAmount.title

    api.visitpaths.dto.AdSalesDTO.orderAmount.description

    List all visitpaths adsales

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.visitpaths.request.AdSalesReq.offset.title

    api.visitpaths.request.AdSalesReq.offset.description

    DEFAULT 0

    sort

    api.visitpaths.request.AdSalesReq.sort.title

    api.visitpaths.request.AdSalesReq.sort.description

    DEFAULT order_amount

    order

    api.visitpaths.request.AdSalesReq.order.title

    api.visitpaths.request.AdSalesReq.order.description

    DEFAULT desc

    List all visitpaths adsales
    Request Copy
    Response Copy

    Visitpaths domains

    Visitpaths domains properties

    Attribute Description
    domain

    api.visitpaths.dto.DomainsDTO.domain.title

    api.visitpaths.dto.DomainsDTO.domain.description

    visit_count

    api.visitpaths.dto.DomainsDTO.visitCount.title

    api.visitpaths.dto.DomainsDTO.visitCount.description

    List all visitpaths domains

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.visitpaths.request.DomainsReq.offset.title

    api.visitpaths.request.DomainsReq.offset.description

    DEFAULT 0

    sort

    api.visitpaths.request.DomainsReq.sort.title

    api.visitpaths.request.DomainsReq.sort.description

    DEFAULT visit_count

    order

    api.visitpaths.request.DomainsReq.order.title

    api.visitpaths.request.DomainsReq.order.description

    DEFAULT desc

    List all visitpaths domains
    Request Copy
    Response Copy

    Visitpaths domainsales

    Visitpaths domainsales properties

    Attribute Description
    domain

    api.visitpaths.dto.DomainSalesDTO.domain.title

    api.visitpaths.dto.DomainSalesDTO.domain.description

    order_count

    api.visitpaths.dto.DomainSalesDTO.orderCount.title

    api.visitpaths.dto.DomainSalesDTO.orderCount.description

    order_amount

    api.visitpaths.dto.DomainSalesDTO.orderAmount.title

    api.visitpaths.dto.DomainSalesDTO.orderAmount.description

    List all visitpaths domainsales

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.visitpaths.request.DomainSalesReq.offset.title

    api.visitpaths.request.DomainSalesReq.offset.description

    DEFAULT 0

    sort

    api.visitpaths.request.DomainSalesReq.sort.title

    api.visitpaths.request.DomainSalesReq.sort.description

    DEFAULT order_amount

    order

    api.visitpaths.request.DomainSalesReq.order.title

    api.visitpaths.request.DomainSalesReq.order.description

    DEFAULT desc

    List all visitpaths domainsales
    Request Copy
    Response Copy

    Visitpaths keyworddetails

    Visitpaths keyworddetails properties

    Attribute Description
    keyword

    api.visitpaths.dto.KeywordDetailsDTO.keyword.title

    api.visitpaths.dto.KeywordDetailsDTO.keyword.description

    engine

    api.visitpaths.dto.KeywordDetailsDTO.engine.title

    api.visitpaths.dto.KeywordDetailsDTO.engine.description

    visit_count

    api.visitpaths.dto.KeywordDetailsDTO.visitCount.title

    api.visitpaths.dto.KeywordDetailsDTO.visitCount.description

    purchase_count

    api.visitpaths.dto.KeywordDetailsDTO.purchaseCount.title

    api.visitpaths.dto.KeywordDetailsDTO.purchaseCount.description

    purchase_rate

    api.visitpaths.dto.KeywordDetailsDTO.purchaseRate.title

    api.visitpaths.dto.KeywordDetailsDTO.purchaseRate.description

    order_amount

    api.visitpaths.dto.KeywordDetailsDTO.orderAmount.title

    api.visitpaths.dto.KeywordDetailsDTO.orderAmount.description

    order_amount_per_visitor

    api.visitpaths.dto.KeywordDetailsDTO.orderAmountPerVisitor.title

    api.visitpaths.dto.KeywordDetailsDTO.orderAmountPerVisitor.description

    order_amount_per_buyer

    api.visitpaths.dto.KeywordDetailsDTO.orderAmountPerBuyer.title

    api.visitpaths.dto.KeywordDetailsDTO.orderAmountPerBuyer.description

    List all visitpaths keyworddetails

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.visitpaths.request.KeywordDetailsReq.offset.title

    api.visitpaths.request.KeywordDetailsReq.offset.description

    DEFAULT 0

    sort

    api.visitpaths.request.KeywordDetailsReq.sort.title

    api.visitpaths.request.KeywordDetailsReq.sort.description

    DEFAULT keyword

    order

    api.visitpaths.request.KeywordDetailsReq.order.title

    api.visitpaths.request.KeywordDetailsReq.order.description

    DEFAULT asc

    List all visitpaths keyworddetails
    Request Copy
    Response Copy

    Visitpaths keywords

    Visitpaths keywords properties

    Attribute Description
    keyword

    api.visitpaths.dto.KeywordsDTO.keyword.title

    api.visitpaths.dto.KeywordsDTO.keyword.description

    visit_count

    api.visitpaths.dto.KeywordsDTO.visitCount.title

    api.visitpaths.dto.KeywordsDTO.visitCount.description

    List all visitpaths keywords

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.visitpaths.request.KeywordsReq.offset.title

    api.visitpaths.request.KeywordsReq.offset.description

    DEFAULT 0

    sort

    api.visitpaths.request.KeywordsReq.sort.title

    api.visitpaths.request.KeywordsReq.sort.description

    DEFAULT visit_count

    order

    api.visitpaths.request.KeywordsReq.order.title

    api.visitpaths.request.KeywordsReq.order.description

    DEFAULT desc

    List all visitpaths keywords
    Request Copy
    Response Copy

    Visitpaths keywordsales

    Visitpaths keywordsales properties

    Attribute Description
    keyword

    api.visitpaths.dto.KeywordSalesDTO.keyword.title

    api.visitpaths.dto.KeywordSalesDTO.keyword.description

    order_count

    api.visitpaths.dto.KeywordSalesDTO.orderCount.title

    api.visitpaths.dto.KeywordSalesDTO.orderCount.description

    order_amount

    api.visitpaths.dto.KeywordSalesDTO.orderAmount.title

    api.visitpaths.dto.KeywordSalesDTO.orderAmount.description

    List all visitpaths keywordsales

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.visitpaths.request.KeywordSalesReq.offset.title

    api.visitpaths.request.KeywordSalesReq.offset.description

    DEFAULT 0

    sort

    api.visitpaths.request.KeywordSalesReq.sort.title

    api.visitpaths.request.KeywordSalesReq.sort.description

    DEFAULT order_amount

    order

    api.visitpaths.request.KeywordSalesReq.order.title

    api.visitpaths.request.KeywordSalesReq.order.description

    DEFAULT desc

    List all visitpaths keywordsales
    Request Copy
    Response Copy

    Visitpaths urls

    Visitpaths urls properties

    Attribute Description
    url

    api.visitpaths.dto.UrlsDTO.url.title

    api.visitpaths.dto.UrlsDTO.url.description

    visit_count

    api.visitpaths.dto.UrlsDTO.visitCount.title

    api.visitpaths.dto.UrlsDTO.visitCount.description

    List all visitpaths urls

    GET

    Specification

    Property Description
    SCOPE mall.read_analytics
    Request Limit 0

    Request

    Parameter Description
    mall_id
    Required

    mall id

    sample id

    shop_no

    shop no

    shop no

    DEFAULT 1

    start_date
    Required

    start date

    2023-01-01

    end_date
    Required

    end date

    2023-02-01

    device_type

    api.common.request.SetRequestParam.deviceType.title

    api.common.request.SetRequestParam.deviceType.description

    limit

    api.common.request.SetRequestParam.limit.title

    api.common.request.SetRequestParam.limit.description

    DEFAULT 100

    offset

    api.visitpaths.request.UrlsReq.offset.title

    api.visitpaths.request.UrlsReq.offset.description

    DEFAULT 0

    sort

    api.visitpaths.request.UrlsReq.sort.title

    api.visitpaths.request.UrlsReq.sort.description

    DEFAULT visit_count

    order

    api.visitpaths.request.UrlsReq.order.title

    api.visitpaths.request.UrlsReq.order.description

    DEFAULT desc

    List all visitpaths urls
    Request Copy
    Response Copy
    Top