Guides

The API reference lists every endpoint. These guides take the other way round: one page per resource, explaining what it is in Skoup, how it lives (its statuses), which call to make for what you want to do, the webhook events to listen to, and the traps to avoid.

Resource	In one sentence
Brands & markets	Who you measure, and in which countries.
Metrics	The headline numbers of a brand on a market: visibility, accuracy, readiness, perception.
Queries	The questions Skoup asks the AI assistants every week.
Samplings	One measurement cycle: every query asked to every model.
Alerts	What went wrong in the AI answers — a wrong price, a wrong stock, a drop, a new competitor.
Tasks	The backlog of fixes, from “to do” to “verified”.
Products & write-backs	The catalogue Skoup measures, and what Skoup wrote back in your store.
Competitors	The brands you track against.
Readiness	How ready a site is for AI shopping, out of 100.
Revenue	Orders, traffic and revenue that came from AI assistants.
Events & webhook endpoints	Being told when something happens, instead of asking.

Every example uses a test key (skoup_test_…): it works on a sandbox with realistic data, and its writes are rolled back. Swap it for a live key when you are ready.