VTEX · Schema

SessionPing

Sends an ACK to the API to renew the session server-side. It should be sent every 1 minute.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
session object
anonymous object
type string Type of event, which can be one of the following: `page.cart`, `page.empty_cart`, `search.query`, `page.confirmation`, `session.ping`, `search.click`.
agent string Identifies whether the request came from a mobile or desktop application. It's used as a filter in the search report.
View JSON Schema on GitHub

JSON Schema

vtex-sessionping-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SessionPing",
  "title": "SessionPing",
  "description": "Sends an ACK to the API to renew the session server-side. It should be sent every 1 minute.",
  "type": "object",
  "required": [
    "session",
    "anonymous",
    "type",
    "agent"
  ],
  "properties": {
    "session": {
      "$ref": "#/components/schemas/UserIdentification/properties/session"
    },
    "anonymous": {
      "$ref": "#/components/schemas/UserIdentification/properties/anonymous"
    },
    "type": {
      "type": "string",
      "title": "type",
      "description": "Type of event, which can be one of the following: `page.cart`, `page.empty_cart`, `search.query`, `page.confirmation`, `session.ping`, `search.click`.",
      "example": "session.ping"
    },
    "agent": {
      "type": "string",
      "title": "agent",
      "description": "Identifies whether the request came from a mobile or desktop application. It's used as a filter in the search report.",
      "default": "desktop",
      "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:83.0) Gecko/20100101 Firefox/83.0"
    }
  }
}