Requires
dataaccess scope.
Overview
Main Application Scenarios
Due to the large volume of trajectory and behavioral data related to C-end users, providing this data through simple RESTful APIs may cause interface call timeouts. Therefore, Shoplazza provides a feature for developers to "create an asynchronous query task" to retrieve this data. The data is then generated into a CSV file, placed on a file service, and developers are informed of the URL to access these data files, allowing them to download the data when needed.
What data can be queried?
| Data Type (User Event) | Explanation |
|---|---|
| impressions | Product Exposure - Tracks when a product is displayed to a user. |
| add_payment_info | Checkout Add Payment Info - Refers to when payment information is added during the checkout process. |
| add_to_cart | Add to Cart - Records when a product is added to the shopping cart. |
| begin_checkout | Begin Checkout - Indicates when a user initiates the checkout process. |
| pageview | Page View - Captures records of page visits by users. |
| place_order | Place Order - Represents when an order is placed by a user. |
| product_search | Product Search - Tracks instances where users search for products. |
| product_view | Product View - Monitors views of product detail pages. |
| purchase_product | Purchase Product - Records when a product is purchased. |
| refund_order | Refund Order - Accounts for when an order is refunded. |
Data Model
Data Structure for Analytical Data
Event tracking data related to the events is consolidated into a single wide table named realtime_events. The data query task created involves searching this table using certain filtering conditions and storing the following fields in a file for easy access, allowing developers to download the records at any time.
| Field | Description |
|---|---|
| event | Event type ,such as :add_payment_info, add_to_cart, etc |
| session_id | Session ID (valid for 30 minutes) |
| store_id | Store ID |
| _os | Customer's operating system |
| _ip | Customer's IP address |
| city | City, derived from IP address |
| province | Province, derived from IP address |
| country | Country, derived from IP address |
| time | Time the event occurred |
| _referrer | Referring page |
| _referrer_host | Host of the referring page |
| _url | URL of the visited page |
| _url_path | Path of the visited page URL |
| client_id | Customer identifier with a one-year validity period |
| _latest_referrer_host | The last external source host |
| product_title | Product title |
| product_handle | Product handle |
| product_id | Product ID |
| variant_id | Variant (SKU) ID |
| price | Product price |
| quantity | Quantity of items |
| total | Total amount |
| discount_total | Discount amount (order level) |
| discount | Discount amount (per item) |
| payment_method | Payment method |
| order_id | Order ID |
| number | Order number |
| key_word | Search keyword |
| impressions | Impressions |
| platform | Platform, distinguishes between C-end and B-end |
| user_agent | User's browser user agent |
| _screen_height | Browser height |
| _screen_width | Browser width |
| theme_name | Name of the theme used in the store |
| theme_version | Version of the theme used in the store |
| country_abbr | Country abbreviation (two-letter code), derived from IP address |
| currency_code | Currency code |