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

Search submitted

{
  "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 basic structure context definition",
  "data": {
    "searchResult": {
      "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., USD)"
          },
          "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"
        }
      ],
      "query": "Required, string type, represents the search keyword"
    }
  },
  "id": "Required, string type, represents the unique identifier of the event or record",
  "name": "Required, string type, represents the event name: search_submitted",
  "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": "FDDD18B6-7c01-4086-99da-a9d056b93ad5",
  "clientIp": "5.34.216.118",
  "context": context,
  "data": {
    "searchResult": {
      "productVariants": [
        {
          "id": "43728958423253",
          "image": {
            "src": "//test-xq.myshopify.com/cdn/shop/products/APPLEROYALGALAORGANIC1KG-3.webp?v=1665737167"
          },
          "price": {
            "amount": 9.49,
            "currencyCode": "USD"
          },
          "product": {
            "id": "7897433309397",
            "title": "APPLE PINK LADY ORGANIC",
            "type": "",
            "untranslatedTitle": "APPLE PINK LADY ORGANIC",
            "url": "/products/apple-pink-lady-organic-1kg?_pos=1\\u0026_sid=11682145c\\u0026_ss=r\\u0026variant=43728958423253",
            "vendor": "Test-Dmap"
          },
          "sku": "apple-01",
          "title": "1.0KG",
          "untranslatedTitle": "1.0KG"
        },
        {
          "id": "43729074487509",
          "image": {
            "src": "//test-xq.myshopify.com/cdn/shop/products/APPLEGRANNYSMITHBOX.webp?v=1665739504"
          },
          "price": {
            "amount": 36,
            "currencyCode": "USD"
          },
          "product": {
            "id": "7897486295253",
            "title": "APPLE GRANNY SMITH BOX",
            "type": "",
            "untranslatedTitle": "APPLE GRANNY SMITH BOX",
            "url": "/products/apple-granny-smith-box?_pos=2\\u0026_sid=11682145c\\u0026_ss=r",
            "vendor": "Test-Dmap"
          },
          "sku": "",
          "title": "Default Title",
          "untranslatedTitle": "Default Title"
        },
        {
          "id": "43729007476949",
          "image": {
            "src": "//test-xq.myshopify.com/cdn/shop/products/DAVE_SMARKETPICKSFRUITANDVEGBOX.webp?v=1665738041"
          },
          "price": {
            "amount": 65,
            "currencyCode": "USD"
          },
          "product": {
            "id": "7897450709205",
            "title": "DAVE'S MARKET PICKS FRUIT AND VEG BOX",
            "type": "",
            "untranslatedTitle": "DAVE'S MARKET PICKS FRUIT AND VEG BOX",
            "url": "/products/daves-market-picks-fruit-and-veg-box?_pos=3\\u0026_sid=11682145c\\u0026_ss=r",
            "vendor": "Test-Dmap"
          },
          "sku": "",
          "title": "Default Title",
          "untranslatedTitle": "Default Title"
        },
        {
          "id": "43729034903765",
          "image": {
            "src": "//test-xq.myshopify.com/cdn/shop/products/2KensingtonPrideMangoes.webp?v=1665738601"
          },
          "price": {
            "amount": 60,
            "currencyCode": "USD"
          },
          "product": {
            "id": "7897467945173",
            "title": "FRUIT VALUE BOX",
            "type": "",
            "untranslatedTitle": "FRUIT VALUE BOX",
            "url": "/products/fruit-value-box?_pos=4\\u0026_sid=11682145c\\u0026_ss=r",
            "vendor": "Test-Dmap"
          },
          "sku": "",
          "title": "Default Title",
          "untranslatedTitle": "Default Title"
        }
      ],
      "query": "apple"
    }
  },
  "id": "sh-834be633-9918-443D-3130-3FA2287865C4",
  "name": "search_submitted",
  "seq": 1,
  "timestamp": "2025-03-11T03:42:23.264Z",
  "type": "standard"
}
PreviousCollection viewedNextProduct added to cart

Last updated 7 days ago

Was this helpful?