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

Collection 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": {
    "collection": {
      "id": "Required, string type, represents the unique identifier of the collection",
      "productVariants": [
        {
          "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": "Required, string type, represents the product variant title",
          "untranslatedTitle": "Required, string type, represents the untranslated product variant title"
        }
      ],
      "title": "Required, string type, represents the collection title"
    }
  },
  "id": "Required, string type, represents the unique identifier of the event or record",
  "name": "Required, string type, represents the event name: collection_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": {
    "collection": {
      "id": "413565288661",
      "productVariants": [
        {
          "id": "43661047660757",
          "image": {
            "src": "https://cdn.shopify.com/s/files/1/0643/2614/0117/products/TOMATOPASSATABRAISEDLAMBSHANKS-WITHMASHANDSALSAVERDE.webp?v=1664335990"
          },
          "price": {
            "amount": 434,
            "currencyCode": "HKD"
          },
          "product": {
            "id": "7878328221909",
            "title": "TOMATO PASSATA BRAISED LAMB SHANKS - WITH MASH AND SALSA VERDE",
            "type": "",
            "untranslatedTitle": "TOMATO PASSATA BRAISED LAMB SHANKS - WITH MASH AND SALSA VERDE",
            "url": "/products/tomato-passata-braised-lamb-shanks-with-mash-and-salsa-verde",
            "vendor": "Test-Dmap"
          },
          "sku": "",
          "title": "Default Title",
          "untranslatedTitle": "Default Title"
        },
        {
          "id": "43716659937493",
          "image": {
            "src": "https://cdn.shopify.com/s/files/1/0643/2614/0117/products/STICKYCOFFEEPORKSHORTRIBS-WITHPICKLEDCABBAGEANDCORNSALSA.webp?v=1665541874"
          },
          "price": {
            "amount": 788,
            "currencyCode": "HKD"
          },
          "product": {
            "id": "7893679407317",
            "title": "STICKY COFFEE PORK SHORT RIBS - WITH PICKLED CABBAGE AND CORN SALSA",
            "type": "",
            "untranslatedTitle": "STICKY COFFEE PORK SHORT RIBS - WITH PICKLED CABBAGE AND CORN SALSA",
            "url": "/products/sticky-coffee-pork-short-ribs-with-pickled-cabbage-and-corn-salsa",
            "vendor": "Test-Dmap"
          },
          "sku": "",
          "title": "Default Title",
          "untranslatedTitle": "Default Title"
        }
      ],
      "title": "Other"
    }
  },
  "id": "sh-6578fb4d-E920-4D0B-15DC-BC2635274EFC",
  "name": "collection_viewed",
  "seq": 1,
  "timestamp": "2025-04-24T01:45:48.441Z",
  "type": "standard"
}
PreviousProduct viewedNextSearch submitted

Last updated 7 days ago

Was this helpful?