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. |
JSON Schema
{
"$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"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vtex-sessionping"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.