API reference · Similarweb

similarweb/website-traffic-snapshot

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APISynchronousOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/api/similarweb/website-traffic-snapshot

Model IDsimilarweb/website-traffic-snapshot

Input Schema

3 parameters · 1 required · 2 optional

Parameter	Type	Required	Description
`domain`	string	Required	Bare website hostname without scheme, path, port, or credentials.
`month`	string	Optional	Complete month in YYYY-MM.
`country`	string	Optional	Worldwide data only; values are case-insensitive. · Options: ww · Default: "ww" ww

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Code Examples

Ready-to-run snippets

const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/api/similarweb/website-traffic-snapshot", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "country": "ww"
  }),
});

if (!response.ok) throw new Error(await response.text());
console.log(await response.json());