GraphQL: Onsite Sessions

Search…
Creating a session
When a new user comes to the app, you can use this method to get a new session. It will return you a customer-id that can save on the device and use for future requests. This would be ideal.
1
mutation {
2
  newSession(referer: "https://google.com?q=shoes")
3
}
Copied!
Updating a session
When a customer logs in, you can update the existing customer with the customer-reference. This would merge the online and mobile sessions. If not needed, I would omit this for now.
Working with recommendations
On the Product Page
In order to use the GraphQL session mutation to fetch recommendations for your search page, the event, in this case, must be VIEWED_PRODUCT and you should specify the product-identifier of the current product being viewed.
1
mutation {
2
  updateSession(by: BY_CID, id: "5b1a481060b221115c4a251e",
3
    params: {
4
      event: {
5
        type: VIEWED_PRODUCT
6
        target: "11923861519"
7
        ref: "front-page-slot-1"
8
      }
9
    }
10
  ) {
11
    pages {
12
      forProductPage(params: {
13
        isPreview: false, imageVersion:  VERSION_8_400_400
14
      }, product: "11923861519") {
15
        divId
16
        resultId
17
        primary {
18
          productId
19
        }
20
      }
21
    }
22
  }
23
}
Copied!
On the Category Page
In order to use the GraphQL session mutation to fetch recommendations for your category page, the event, in this case, must be VIEWED_CATEGORY and you should specify a fully qualified category path of the current category. For example, if you have a category called "Dresses" under the category "Women", the FQCN would be "/Women/Dresses".
1
mutation {
2
  updateSession(by: BY_CID, id: "5b1a481060b221115c4a251e",
3
    params: {
4
      event: {
5
        type: VIEWED_CATEGORY
6
        target: "/Shorts"
7
      }
8
    }
9
  ) {
10
    pages {
11
      forCategoryPage(params: {
12
        isPreview: false, imageVersion:  VERSION_8_400_400
13
      }, category: "Shorts") {
14
        divId
15
        resultId
16
        primary {
17
          productId
18
        }
19
      }
20
    }
21
  }
22
}
Copied!
On the Search Page
In order to use the GraphQL session mutation to fetch recommendations for your search page, the event, in this case, must be SEARCHED_FOR and you should specify the search term of the query.
1
mutation {
2
  updateSession(by: BY_CID, id: "5b1a481060b221115c4a251e",
3
    params: {
4
      event: {
5
        type: SEARCHED_FOR
6
        target: "black shoes"
7
      }
8
    }
9
  ) {
10
    pages {
11
      forSearchPage(params: {
12
        isPreview: false, imageVersion:  VERSION_8_400_400
13
      }, term: "black shoes") {
14
        divId
15
        resultId
16
        primary {
17
          productId
18
        }
19
      }
20
    }
21
  }
22
}
Copied!
On the Cart Page
In order to use the GraphQL session mutation to fetch recommendations for your cart or checkout page, the event, in this case, must be VIEWED_PAGE and you should specify a fully qualified URL of the page as the target.
1
mutation {
2
  updateSession(by: BY_CID, id: "5b1a481060b221115c4a251e",
3
    params: {
4
      event: {
5
        type: VIEWED_PAGE
6
        target: "https://example.com/cart"
7
      }
8
    }
9
  ) {
10
    pages {
11
      forCartPage(params: {
12
        isPreview: false, imageVersion:  VERSION_8_400_400
13
      }, value: 100) {
14
        divId
15
        resultId
16
        primary {
17
          productId
18
        }
19
      }
20
    }
21
  }
22
}
Copied!
On the Front Page
In order to use the GraphQL session mutation to fetch recommendations for your home or front page, the event, in this case, must be VIEWED_PAGE and you should specify a fully qualified URL of the page as the target
1
mutation {
2
  updateSession(by: BY_CID, id: "5b1a481060b221115c4a251e",
3
    params: {
4
      event: {
5
        type: VIEWED_PAGE
6
        target: "https://example.com"
7
      }
8
    }
9
  ) {
10
    pages {
11
      forFrontPage(params: {
12
        isPreview: false, imageVersion:  VERSION_8_400_400
13
      }) {
14
        divId
15
        resultId
16
        primary {
17
          productId
18
        }
19
      }
20
    }
21
  }
22
}
Copied!
Attribution of Recommendation Results
Recommendation results can be attributed to events by setting a session event's ref to the recommendation result's resultId.
Here is an example of some recommendations for a front page. You can see recommendation result's resultId is "frontpage-nosto-1".
1
{
2
  "data": {
3
    "updateSession": {
4
      "pages": {
5
        "forFrontPage": [
6
          {
7
            "resultId": "frontpage-nosto-1",
8
            "primary": [
9
              {
10
                "productId": "9497180547",
11
                "name": "Cool Kicks",
12
                "url": "https://example.com/products/cool-kicks"
13
              },
14
              {
15
                "productId": "9497180163",
16
                "name": "Awesome Sneakers",
17
                "url": "https://example.com/products/awesome-sneakers"
18
              },
19
              {
20
                "productId": "4676165861430",
21
                "name": "Free gift",
22
                "url": "https://example.com/products/free-gift"
23
              },
24
              {
25
                "productId": "2188051218486",
26
                "name": "Furry Dice",
27
                "url": "https://example.com/products/furry-dice"
28
              },
29
              {
30
                "productId": "9497180611",
31
                "name": "Gnarly Shoes",
32
                "url": "https://example.com/products/gnarly-shoes-1"
33
              }
34
            ]
35
          }
36
        ]
37
      }
38
    }
39
  }
40
}
Copied!
If a customer selects to view the Cool Kicks product, you can generate the following request. Note that the event's ref is set to "frontpage-nosto-1". 
1
mutation {
2
  updateSession(by: BY_CID, id: "5b1a481060b221115c4a251e",
3
    params: {
4
      event: {
5
        type: VIEWED_PRODUCT
6
        target: "9497180547"
7
        ref: "frontpage-nosto-1"
8
      }
9
    }
10
  ) {
11
    pages {
12
      forProductPage(params: {
13
        isPreview: false, imageVersion:  VERSION_8_400_400
14
      }, product: "9497180547") {
15
        divId
16
        resultId
17
        primary {
18
          productId
19
        }
20
      }
21
    }
22
  }
23
}
Copied!
Updating Identities
Working with Orders
Last modified 6mo ago
Copy link
Contents
Creating a session
Updating a session
Working with recommendations
Attribution of Recommendation Results