shelfatlas-com · Schema

SteeringEventRequest

CompanyGroceryDenmarkRetail

Properties

Name Type Description
product_id string
winning_store_id string The store the "best choice" card actually pointed to.
visitor_key string Opaque per-device key the consumer surface generates and keeps locally, used only for the report's COUNT(DISTINCT visitor). Omit to skip unique-visitor counting for this render.
involved array One entry per candidate chain compared for this render.
View JSON Schema on GitHub

JSON Schema

shelfatlas-com-steering-event-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/shelfatlas-com/json-schema/shelfatlas-com-steering-event-request-schema.json",
  "title": "SteeringEventRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/shelfatlas-com-observations-api-openapi.yml#/components/schemas/SteeringEventRequest",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "product_id",
    "winning_store_id",
    "involved"
  ],
  "properties": {
    "product_id": {
      "type": "string",
      "format": "uuid"
    },
    "winning_store_id": {
      "type": "string",
      "format": "uuid",
      "description": "The store the \"best choice\" card actually pointed to."
    },
    "visitor_key": {
      "type": "string",
      "format": "uuid",
      "description": "Opaque per-device key the consumer surface generates and keeps locally, used only for the report's COUNT(DISTINCT visitor). Omit to skip unique-visitor counting for this render."
    },
    "involved": {
      "type": "array",
      "minItems": 1,
      "maxItems": 25,
      "description": "One entry per candidate chain compared for this render.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "nearest_store_id",
          "distance_band",
          "price_gap_cents"
        ],
        "properties": {
          "nearest_store_id": {
            "type": "string",
            "format": "uuid",
            "description": "The candidate chain's store nearest the visitor."
          },
          "distance_band": {
            "type": "string",
            "enum": [
              "<1",
              "1-3",
              "3-10",
              ">10"
            ],
            "description": "Client-computed distance bucket, kilometres — never a raw coordinate."
          },
          "price_gap_cents": {
            "type": "integer",
            "description": "This candidate's price minus the winning store's, in cents."
          }
        }
      }
    }
  }
}

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.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/shelfatlas-com-steering-event-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.