Attribuly API Docs
  • Introduction
  • Authentication
  • Endpoint
    • Google Looker Studio
  • API Reference
    • Event summary
    • Order: first and last touchpoint
    • Order: total conversion journey
    • The number of visitors who visited the landing page and then completed the event.
  • Common data structures
    • Customer
    • Order
    • Product
    • Event
      • Page viewed
      • Cart viewed
      • Product viewed
      • Collection viewed
      • Search submitted
      • Product added to cart
      • Product removed to cart
      • Lead form
      • Checkout started
      • Checkout address info submitted
      • Checkout contact info submitted
      • Checkout shipping info submitted
      • Payment info submitted
      • Checkout completed
Powered by GitBook
On this page

Was this helpful?

  1. Common data structures
  2. Event

Product viewed

{
  "clientId": "Required, string type, represents the unique identifier of the client",
  "clientIp": "Required, string type, represents the IP address of the client",
  "context": "Required, please refer to the context definition in the basic structure",
  "data": {
    "productVariant": {
      "id": "Required, string type, represents the unique identifier of the product variant",
      "image": {
        "src": "Required, string type, represents the image link"
      },
      "price": {
        "amount": "Required, numeric type, represents the price amount",
        "currencyCode": "Required, string type, represents the currency code (e.g., HKD)"
      },
      "product": {
        "id": "Required, string type, represents the unique identifier of the product",
        "title": "Required, string type, represents the product title",
        "type": "Optional, string type, represents the product type",
        "untranslatedTitle": "Required, string type, represents the untranslated product title",
        "url": "Required, string type, represents the product URL",
        "vendor": "Required, string type, represents the vendor name"
      },
      "sku": "Optional, string type, represents the stock keeping unit",
      "title": "Optional, string type, represents the product variant title",
      "untranslatedTitle": "Optional, string type, represents the untranslated product variant title"
    }
  },
  "id": "Required, string type, represents the unique identifier of the event or record",
  "name": "Required, string type, represents the event name: product_viewed",
  "seq": "Required, numeric type, represents the sequence number",
  "timestamp": "Required, string type, represents the timestamp (ISO 8601 format)",
  "type": "Required, string type, represents the form type"
}
{
  "clientId": "ffac04fa-8ad8-48fd-8a3a-59ad06a7518a",
  "clientIp": "5.34.216.118",
  "context": context,
  "data": {
    "productVariant": {
      "id": "43661439271125",
      "image": {
        "src": "//test-xq.myshopify.com/cdn/shop/products/AbbottsBakery-SourdoughGrains_Seeds_760g.webp?v=1664345120"
      },
      "price": {
        "amount": 34,
        "currencyCode": "HKD"
      },
      "product": {
        "id": "7878527156437",
        "title": "ABBOTTS BAKERY SOURDOUGH RYE 760G",
        "type": "",
        "untranslatedTitle": "ABBOTTS BAKERY SOURDOUGH RYE 760G",
        "url": "/products/abbotts-bakery-sourdough-rye-760g",
        "vendor": "Test-Dmap"
      },
      "sku": "G-03",
      "title": "Default Title",
      "untranslatedTitle": "Default Title"
    }
  },
  "id": "sh-6676f11a-C74D-47E4-D177-B87BFA364F2B",
  "name": "product_viewed",
  "seq": 1,
  "timestamp": "2025-04-24T06:23:12.043Z",
  "type": "standard"
}
PreviousCart viewedNextCollection viewed

Last updated 7 days ago

Was this helpful?