non-print
API Index
Introduction
Cafe24 Analytics API (Beta)
Cafe24 Analytics APIは、Cafe24ショップのユーザー行動データ提供によってデータ提供サービスを制作する、Cafe24の承認を得た協力会社にのみ提供されるAPIです。
当APIを通して取得した情報を事前に承認を得ていないチャンネル(またはメディア)および目的のために使用することはできませんのでご注意ください。
2023年以前のデータはEC Admin > 統計 > アクセス統計のデータを基に提供され、2023年以降のデータはEC Admin > 統計 > Cafe24 アナリティクスのデータを基に提供されます。
Cafe24 Analytics APIは、OAuth 2.0基盤の認証システムと標準HTTP Request Method、リソースの予測が可能なエンドポイントURL、HTTPコード基盤のエラーメッセージを提供します。
Request/Response Format
APIのリクエストおよびレスポンスはJSON Formatに対応しています。
個人情報保護のため、Cafe24 Analytics APIはHTTPSプロトコルにのみ対応しています。
Dates属性は ISO_8601 フォーマットで提供されます。:YYYY-MM-DDTHH:MM:SS+09:00
要求例題(検索)
正常応答例題
{
"resource": {
"key": "value",
"key": "value"
}
}
エラー応答例題
{
"error": {
"code": "error code",
"message": "error message",
"more_info": {
}
}
}
Cafe24 Analytics API Intro
Cafe24 Analytics APIはショップのユーザー行動データ照会に適したAPIです。 Cafe24 Analytics APIでは、該当のリソースに対するほぼ全ての情報を照会することができます。また、Cafe24 Analytics APIを使用するには、OAuth 2.0方式による別途の認証が必要となります。
使用例
PV(ページビュー) : https://ca-api.cafe24data.com/visitors/pageview?mall_id=몰아이디&shop_no=1&start_date=2023-02-01&end_date=2023-02-10
アクセス数 : https://ca-api.cafe24data.com/visitors/view?mall_id=몰아이디&shop_no=1&start_date=2023-02-01&end_date=2023-02-10
API Status Code
Code | 発生事例 | エラーの解決方法 |
---|---|---|
200 | GETに成功した場合 | |
401 | 1) Access Tokenがない状況で呼び出しを行った場合 2) Access Tokenが有効ではない場合 Access Tokenが満了された場合 4) クライアントが把握できない場合(不明なクライアント) | 有効なクライアントIDが使用されたかどうかを確認します。 |
403 | Access Tokenはあるが、該当のScopeに対する権限がない場合 | APIのScopeまたはショップの設定を確認し、APIの呼び出し権限があるかどうかを把握します。 |
403 | httpsプロトコルではない場合 | httpsプロトコルでAPIリクエストが行われたかどうかを確認します。 |
404 | 1) API URLを間違って呼び出した場合 2) リソースが見つからない場合 3) {#id}がない場合 | APIドキュメントを参考に、エンドポイントURLに問題があるかどうかを確認します。 |
422 | 照会・処理リクエストを行う際の値が既定の仕様(スペック)と異なる場合 1) 必須パラメーターの漏れ 2) 既定の仕様(スペック)と異なる場合 | APIドキュメントを参考に、必須パラメーターの入力漏れや無効な値の入力があるかどうかを確認します。 |
429 | クライアントのAPIリクエストによってバケット(Bucket)のトークンがすべて消費された場合 | APIリクエスト数が上限を超えないよう、しばらく時間をおいてから再度リクエストを行います。 |
500 | 内部サーバーエラーまたは不明なエラーが発生した場合 | Cafe24 Developersまでお問い合わせください。 |
503 | サーバーが過負荷でダウンした場合 | Cafe24 Developersまでお問い合わせください。 |
503 | サーバーが過負荷でダウンした場合/APIを使用できない場合 | Cafe24 Developersまでお問い合わせください。 |
504 | リクエストの処理に時間がかかり、タイムアウトとなった場合 | 一時的なエラーが発生した場合です。しばらく時間をおいてから再度試してください。 |
1. 検索条件の追加
検索を行う際に、エンドポイントにパラメーターを追加すると検索条件を追加することができます。
複数の条件に一致する結果を検索したい場合、「&」を使用して検索条件を追加することができます。
検索条件の追加
例) 特定のショップにおいて、特定の期間中に発生したPV数を照会する場合
GET https://ca-api.cafe24data.com/visitors/pageview?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01
例) 特定のショップにおいて、特定の期間中に発生したドメインごとのアクセス数を照会する場合
GET https://ca-api.cafe24data.com/visitpaths/domains?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01
例) 特定のショップにおいて、特定の期間中に発生した商品別の売上高・販売件数を照会する場合
GET https://ca-api.cafe24data.com/products/sales?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01
例) 特定のショップにおいて、特定の期間中に発生した時間帯別の購入者数・購入件数・売上高を照会する場合
GET https://ca-api.cafe24data.com/sales/times?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01
2. Pagination
検索結果は基本的に100件まで照会できます。
照会された結果が多い場合は、「offset」パラメーターを利用して100件ずつ追加照会を行うことが可能です。
Pagination
例) 100件のPVを照会する場合
GET https://ca-api.cafe24data.com/visitors/pageview?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01
例) 101件目~200件目のPVを照会する場合
GET hhttps://ca-api.cafe24data.com/visitors/pageview?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01&offset=100
例) 201件目~300件目のPVを照会する場合
GET hhttps://ca-api.cafe24data.com/visitors/pageview?mall_id=nelly&start_date=2023-01-01&end_date=2023-02-01&offset=200
例) 301件目~400件目のPVを照会する場合
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では「トークンバケット(Token Bucket)」アルゴリズムが使用されています。
「トークンバケット(Token Bucket)」とは、バケット(Bucket)に「リクエスト数上限」分のトークン(Token)を設定しておいて、リクエストが発生する度に1つのトークンが消費されるうようにし、バケットに使用可能なトークンが残っていない状態になるとリクエストを制限するアルゴリズムです。バケットのトークンは1秒に2個ずつ増加されます。
アプリが1秒に2回ずつのAPIリクエストを発生させる場合は、制限されることなく持続的に使用できます。 一時的に1秒以内に「リクエスト数上限」を超える呼び出しが発生する場合は、429エラー(Too Many Request)が返されます。 HeaderのResponse Headerにて「x-ratelimit-remaining」でバケットに残っているトークンを確認し、429エラーを防止することが可能です。
Response Header
> X-RateLimit-Remaining: 9
> X-RateLimit-Requested-Tokens: 1
> X-RateLimit-Burst-Capacity: 10
> X-RateLimit-Replenish-Rate: 2
Authentication
アクセス トークンは、ショッピングモール(EC Admin API)が発行するトークンとして使用できます。
Get Authentication Code
トークン発行要求時に使われたcodeは再使用できず、コード発行後1分が経過すると満了します。
{mallid} : ショップのIDを入力します。
{client_id} : 開発者センターで作成したアプリのclient_idを入力します。
{state} : 偽変造を防止するために入力する値にコード返還時に同じ値が返還されます。
{redirect_uri} : 開発者センターで作成したアプリのRedirect URLを入力します。
{scope} : アクセストークンでアクセスするリソースサーバーの権限を入力することができます。
アクセストークンの発行のためにはまずアクセスコードを要求しなければなりません。アクセスコードはクライアントがウェブアプリケーションの形態である場合に利用されます。コードの要求はcURLではなくウェブブラウザーで行わなければなりません。
例示コード(要求)
GET 'https://{mallid}.cafe24api.com/api/v2/oauth/authorize?response_type=code&client_id={client_id}&state={state}&redirect_uri={redirect_uri}&scope={scope}'
例示コード(応答)
HTTP/1.1 302 Found
Location: {redirect_uri}?code={authorize_code}&state={state}
Get Access Token
発行された認証コードを使用し、実際にAPIを呼び出しできるユーザートークン(Access Token、Refresh Token)を取得することができます。
{mallid}:該当のショップIDを入力してください。
{client_id}:Cafe24 Developersで作成したアプリのclient_idを入力してください。
{client_secret}:Cafe24 Developersで作成したアプリのclient_secretを入力してください。
{code}:発行されたコードを入力してください。
{redirect_uri}:Cafe24 Developersで作成したアプリのRedirect URLを入力してください。
access_token:アクセストークン。クライアントがリソースサーバーにアクセスする際に使用されます。
refresh_token:アクセストークンの満了後、再発行のために使用されるトークンです。
例示コード(要求)
例示コード(応答)
HTTP/1.1 200 OK
{
"access_token": "0iqR5nM5EJIq..........",
"expires_at": "2021-03-01T14:00:00.000",
"refresh_token": "JeTJ7XpnFC0P..........",
"refresh_token_expires_at": "2021-03-15T12:00:00.000",
"client_id": "BrIfqEKoPxeE..........",
"mall_id": "yourmall",
"user_id": "test",
"scopes": [
"mall.analytics",
"...etc...",
],
"issued_at": "2021-03-01T12:00:00.000"
}
Get Access Token using refresh token
アクセストークンは、発行から2時間が経過すると使用不可になります。 アクセストークンが満了された場合、リソースサーバーにアクセスするには再発行が必要となります。その場合、すでにアクセストークンを発行した状態であれば、refresh_tokenを使用してアクセストークンの再発行を行うことが可能です。
refresh tokenの有効期限は2週間であり、refresh tokenが満了される前にリクエストを行うと、更新されたaccess tokenと更新されたrefresh tokenが一緒に返されます。更新されたrefresh tokenが返された後は、既存のrefresh tokenは満了になり、使用不可となります。
発行された認証コードを使用し、実際にAPIを呼び出しできるユーザートークン(Access Token、Refresh Token)を取得することができます。
{mallid}:該当のショップIDを入力してください。
{domain}:該当のショップのドメインを入力してください。
{client_id}:Cafe24 Developersで作成したアプリのclient_idを入力してください。
{client_secret}:Cafe24 Developersで作成したアプリのclient_secretを入力してください。
{refresh_token}:トークンの発行時に返されたrefresh_tokenを入力してください。
access_token:アクセストークン。クライアントがリソースサーバーにアクセスする際に使用されます。
refresh_token:アクセストークンの満了後、再発行のために使用されるトークンです。
例示コード(要求)
例示コード(応答)
HTTP/1.1 200 OK
{
"access_token": "21EZes0dGSfN..........",
"expires_at": "2021-03-01T15:50:00.000",
"refresh_token": "xLlhWztQHBik............",
"refresh_token_expires_at": "2021-03-15T13:50:00.000",
"client_id": "BrIfqEKoPxeE..........",
"mall_id": "yourmall",
"user_id": "test",
"scopes": [
"mall.analytics",
"...etc...",
],
"issued_at": "2021-03-01T13:50:00.000"
}
Revoke Access Token
特定のアクセストークンを取り消すことができます。
アクセストークンが取り消された場合、要求されたアクセストークンのリフレッシュトークンも同時に取り消されます。
{mallid} : ショップのIDを入力します。
{domain}: ショップのドメインを入力します。
{client_id} : 開発者センターで作成したアプリのclient_idを入力します。
{client_secret}: 開発者センターで作成したアプリのclient_secretを入力します。
{token} : 取り消すアクセストークンを入力してください。
例示コード(要求)
例示コード(応答)
HTTP/1.1 200 OK
Analytics
Adeffect addetails
Endpoints
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_ | api.adeffect.dto.AdDetailsDTO.visitCount.title api.adeffect.dto.AdDetailsDTO.visitCount.description |
visit_ | api.adeffect.dto.AdDetailsDTO.visitRate.title api.adeffect.dto.AdDetailsDTO.visitRate.description |
purchase_ | api.adeffect.dto.AdDetailsDTO.purchaseCount.title api.adeffect.dto.AdDetailsDTO.purchaseCount.description |
purchase_ | api.adeffect.dto.AdDetailsDTO.purchaseRate.title api.adeffect.dto.AdDetailsDTO.purchaseRate.description |
order_ | api.adeffect.dto.AdDetailsDTO.orderAmount.title api.adeffect.dto.AdDetailsDTO.orderAmount.description |
order_ | api.adeffect.dto.AdDetailsDTO.orderAmountPerVisitor.title api.adeffect.dto.AdDetailsDTO.orderAmountPerVisitor.description |
order_ | api.adeffect.dto.AdDetailsDTO.orderAmountPerBuyer.title api.adeffect.dto.AdDetailsDTO.orderAmountPerBuyer.description |
List all adeffect addetails
GET /adeffect/addetails
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Carts action
Endpoints
Carts action properties
Attribute | Description |
---|---|
product_ | api.carts.dto.ActionDTO.productNo.title api.carts.dto.ActionDTO.productNo.description |
product_ | 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_ | api.carts.dto.ActionDTO.addCartCount.title api.carts.dto.ActionDTO.addCartCount.description |
add_ | api.carts.dto.ActionDTO.addCartRate.title api.carts.dto.ActionDTO.addCartRate.description |
List all carts action
GET /carts/action
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Members sales
Endpoints
Members sales properties
Attribute | Description |
---|---|
member_ | api.members.dto.SalesDTO.memberOrderCount.title api.members.dto.SalesDTO.memberOrderCount.description |
member_ | api.members.dto.SalesDTO.memberOrderAmount.title api.members.dto.SalesDTO.memberOrderAmount.description |
nonmember_ | api.members.dto.SalesDTO.nonmemberOrderCount.title api.members.dto.SalesDTO.nonmemberOrderCount.description |
nonmember_ | api.members.dto.SalesDTO.nonmemberOrderAmount.title api.members.dto.SalesDTO.nonmemberOrderAmount.description |
List all members sales
GET /members/sales
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
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_ | api.pages.dto.ViewDTO.visitCount.title api.pages.dto.ViewDTO.visitCount.description |
first_ | api.pages.dto.ViewDTO.firstVisitCount.title api.pages.dto.ViewDTO.firstVisitCount.description |
List all pages view
GET /pages/view
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Products categorydetails
Endpoints
Products categorydetails properties
Attribute | Description |
---|---|
product_ | api.products.dto.Product.productNo.title api.products.dto.Product.productNo.description |
product_ | api.products.dto.CategoryDetailsDTO.productName.title api.products.dto.CategoryDetailsDTO.productName.description |
product_ | api.products.dto.CategoryDetailsDTO.productCode.title api.products.dto.CategoryDetailsDTO.productCode.description |
category_ | api.products.dto.CategoryDetailsDTO.categoryName.title api.products.dto.CategoryDetailsDTO.categoryName.description |
category_ | api.products.dto.CategoryDetailsDTO.categoryNo.title api.products.dto.CategoryDetailsDTO.categoryNo.description |
sales_ | api.products.dto.CategoryDetailsDTO.salesCountPerCategory.title api.products.dto.CategoryDetailsDTO.salesCountPerCategory.description |
sales_ | api.products.dto.CategoryDetailsDTO.salesItemPerCategory.title api.products.dto.CategoryDetailsDTO.salesItemPerCategory.description |
sales_ | api.products.dto.CategoryDetailsDTO.salesPricePerCategory.title api.products.dto.CategoryDetailsDTO.salesPricePerCategory.description |
carts_ | api.products.dto.CategoryDetailsDTO.cartsCountPerCategory.title api.products.dto.CategoryDetailsDTO.cartsCountPerCategory.description |
List all products categorydetails
GET /products/categorydetails
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Products sales
Endpoints
Products sales properties
Attribute | Description |
---|---|
product_ | api.products.dto.Product.productNo.title api.products.dto.Product.productNo.description |
product_ | api.products.dto.Product.productName.title api.products.dto.Product.productName.description |
order_ | api.products.dto.SalesDTO.orderCount.title api.products.dto.SalesDTO.orderCount.description |
order_ | api.products.dto.SalesDTO.orderProductCount.title api.products.dto.SalesDTO.orderProductCount.description |
order_ | api.products.dto.SalesDTO.orderAmount.title api.products.dto.SalesDTO.orderAmount.description |
List all products sales
GET /products/sales
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Products view
Endpoints
Products view properties
Attribute | Description |
---|---|
product_ | api.products.dto.Product.productNo.title api.products.dto.Product.productNo.description |
product_ | 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 /products/view
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 | ソート値 product_no : 商品番号 DEFAULT count |
order | ソート順 desc: 降順 DEFAULT desc |
Sales orderdetails
Endpoints
Sales orderdetails properties
Attribute | Description |
---|---|
order_ | api.sales.dto.OrderdetailsDTO.orderDate.title api.sales.dto.OrderdetailsDTO.orderDate.description |
order_ | 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_ | api.sales.dto.OrderdetailsDTO.paymentMethod.title api.sales.dto.OrderdetailsDTO.paymentMethod.description |
order_ | api.sales.dto.OrderdetailsDTO.orderAmount.title api.sales.dto.OrderdetailsDTO.orderAmount.description |
List all sales orderdetails
GET /sales/orderdetails
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Sales paymethods
Endpoints
Sales paymethods properties
Attribute | Description |
---|---|
payment_ | api.sales.dto.PaymethodsDTO.paymentMethod.title api.sales.dto.PaymethodsDTO.paymentMethod.description |
buyers_ | api.sales.dto.PaymethodsDTO.buyersCount.title api.sales.dto.PaymethodsDTO.buyersCount.description |
order_ | api.sales.dto.PaymethodsDTO.orderCount.title api.sales.dto.PaymethodsDTO.orderCount.description |
order_ | api.sales.dto.PaymethodsDTO.orderAmount.title api.sales.dto.PaymethodsDTO.orderAmount.description |
List all sales paymethods
GET /sales/paymethods
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Sales pervisitors
Endpoints
Sales pervisitors properties
Attribute | Description |
---|---|
order_ | api.sales.dto.PervisitorsDTO.orderAmountPerVisitor.title api.sales.dto.PervisitorsDTO.orderAmountPerVisitor.description |
order_ | api.sales.dto.PervisitorsDTO.orderAmountPerBuyer.title api.sales.dto.PervisitorsDTO.orderAmountPerBuyer.description |
List all sales pervisitors
GET /sales/pervisitors
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Sales times
Endpoints
Sales times properties
Attribute | Description |
---|---|
hour | api.sales.dto.TimesDTO.hour.title api.sales.dto.TimesDTO.hour.description |
buyers_ | api.sales.dto.TimesDTO.buyersCount.title api.sales.dto.TimesDTO.buyersCount.description |
order_ | api.sales.dto.TimesDTO.orderCount.title api.sales.dto.TimesDTO.orderCount.description |
order_ | api.sales.dto.TimesDTO.orderAmount.title api.sales.dto.TimesDTO.orderAmount.description |
List all sales times
GET /sales/times
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Visitors dailyactive
Endpoints
List all visitors dailyactive
GET /visitors/dailyactive
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Visitors pageview
Endpoints
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_ | api.visitors.dto.PageViewDTO.pageView.title api.visitors.dto.PageViewDTO.pageView.description |
List all visitors pageview
GET /visitors/pageview
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | api.common.request.SetRequestParam.deviceType.title api.common.request.SetRequestParam.deviceType.description |
format_ | 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 |
Visitors unique
Endpoints
List all visitors unique
GET /visitors/unique
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
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_ | api.visitors.dto.ViewDTO.visitCount.title api.visitors.dto.ViewDTO.visitCount.description |
first_ | api.visitors.dto.ViewDTO.firstVisitCount.title api.visitors.dto.ViewDTO.firstVisitCount.description |
re_ | api.visitors.dto.ViewDTO.reVisitCount.title api.visitors.dto.ViewDTO.reVisitCount.description |
List all visitors view
GET /visitors/view
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | api.common.request.SetRequestParam.deviceType.title api.common.request.SetRequestParam.deviceType.description |
format_ | 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 |
Visitpaths adkeywordsales
Endpoints
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_ | api.visitpaths.dto.AdKeywordSalesDTO.orderCount.title api.visitpaths.dto.AdKeywordSalesDTO.orderCount.description |
order_ | api.visitpaths.dto.AdKeywordSalesDTO.orderAmount.title api.visitpaths.dto.AdKeywordSalesDTO.orderAmount.description |
List all visitpaths adkeywordsales
GET /visitpaths/adkeywordsales
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Visitpaths ads
Endpoints
List all visitpaths ads
GET /visitpaths/ads
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Visitpaths adsales
Endpoints
Visitpaths adsales properties
Attribute | Description |
---|---|
ad | api.visitpaths.dto.AdSalesDTO.ad.title api.visitpaths.dto.AdSalesDTO.ad.description |
order_ | api.visitpaths.dto.AdSalesDTO.orderCount.title api.visitpaths.dto.AdSalesDTO.orderCount.description |
order_ | api.visitpaths.dto.AdSalesDTO.orderAmount.title api.visitpaths.dto.AdSalesDTO.orderAmount.description |
List all visitpaths adsales
GET /visitpaths/adsales
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Visitpaths domains
Endpoints
List all visitpaths domains
GET /visitpaths/domains
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Visitpaths domainsales
Endpoints
Visitpaths domainsales properties
Attribute | Description |
---|---|
domain | api.visitpaths.dto.DomainSalesDTO.domain.title api.visitpaths.dto.DomainSalesDTO.domain.description |
order_ | api.visitpaths.dto.DomainSalesDTO.orderCount.title api.visitpaths.dto.DomainSalesDTO.orderCount.description |
order_ | api.visitpaths.dto.DomainSalesDTO.orderAmount.title api.visitpaths.dto.DomainSalesDTO.orderAmount.description |
List all visitpaths domainsales
GET /visitpaths/domainsales
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Visitpaths keyworddetails
Endpoints
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_ | api.visitpaths.dto.KeywordDetailsDTO.visitCount.title api.visitpaths.dto.KeywordDetailsDTO.visitCount.description |
purchase_ | api.visitpaths.dto.KeywordDetailsDTO.purchaseCount.title api.visitpaths.dto.KeywordDetailsDTO.purchaseCount.description |
purchase_ | api.visitpaths.dto.KeywordDetailsDTO.purchaseRate.title api.visitpaths.dto.KeywordDetailsDTO.purchaseRate.description |
order_ | api.visitpaths.dto.KeywordDetailsDTO.orderAmount.title api.visitpaths.dto.KeywordDetailsDTO.orderAmount.description |
order_ | api.visitpaths.dto.KeywordDetailsDTO.orderAmountPerVisitor.title api.visitpaths.dto.KeywordDetailsDTO.orderAmountPerVisitor.description |
order_ | api.visitpaths.dto.KeywordDetailsDTO.orderAmountPerBuyer.title api.visitpaths.dto.KeywordDetailsDTO.orderAmountPerBuyer.description |
List all visitpaths keyworddetails
GET /visitpaths/keyworddetails
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Visitpaths keywords
Endpoints
List all visitpaths keywords
GET /visitpaths/keywords
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Visitpaths keywordsales
Endpoints
Visitpaths keywordsales properties
Attribute | Description |
---|---|
keyword | api.visitpaths.dto.KeywordSalesDTO.keyword.title api.visitpaths.dto.KeywordSalesDTO.keyword.description |
order_ | api.visitpaths.dto.KeywordSalesDTO.orderCount.title api.visitpaths.dto.KeywordSalesDTO.orderCount.description |
order_ | api.visitpaths.dto.KeywordSalesDTO.orderAmount.title api.visitpaths.dto.KeywordSalesDTO.orderAmount.description |
List all visitpaths keywordsales
GET /visitpaths/keywordsales
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |
Visitpaths urls
Endpoints
List all visitpaths urls
GET /visitpaths/urls
GET
基本スペック
Property | Description |
---|---|
SCOPE | 접속통계の읽기권한 (mall.read_analytics) |
呼び出し件数制限 | 0 |
要求スペック
Parameter | Description |
---|---|
mall_ Required | モールID サンプルID |
shop_ | ショップ番号 ショップ番号 DEFAULT 1 |
start_ Required | 開始日 2023-01-01 |
end_ Required | 終了日 2023-02-01 |
device_ | 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 |