API reference · Similarweb

similarweb/traffic-by-demographics-aggregated

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/traffic-by-demographics-aggregated
Model IDsimilarweb/traffic-by-demographics-aggregated
01

Input Schema

10 parameters · 6 required · 4 optional

ParameterTypeRequiredDescription
domainstringRequireddomain
metricsstringRequiredComma-separated metrics. Supported: share.
end_datestringRequiredend_date
age_bucketstringRequiredSelect one age bucket; age_bucket must be provided exactly once. · Options: 18, 25, 35, 45, 55, 65
182535455565
start_datestringRequiredstart_date
granularitystringRequiredgranularity · Options: monthly
monthly
formatstringOptionalformat · Options: json
json
countrystringOptionalWorldwide data only; values are case-insensitive. · Options: ww · Default: "ww"
ww
web_sourcestringOptionalweb_source · Options: total
total
main_domain_onlybooleanOptionalmain_domain_only
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description
03

Code Examples

Ready-to-run snippets

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

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