MisarMisar Docs
MisarMailMisarBlogMisarReachMisarPostMisarDevMisarCoderMisarSEOMisar PlatformMisar SSO
API Reference

Domain Overview

GET /seo/domain/overview — aggregate authority, traffic, and visibility metrics for any domain.

Aggregate metrics for a domain: authority, estimated traffic, and organic visibility. Works on domains you do not own — the projectId only scopes billing and access, not the target.

GET/seo/domain/overview

Query parameters

projectIdstringqueryrequired

Owning project.

domainstringqueryrequired

Hostname to analyse. Must contain a dot and must already be lowercase and trimmed. Values containing /, \, ?, #, or @ are rejected — pass a bare hostname, not a URL.

includeSubdomainsstringquery

Pass true to include subdomains. Any other value is treated as false.

locationCodenumberquerydefault: 2840

Numeric location code.

languageCodestringquerydefault: en

Two-letter language code.

Response fields

overviewobject

The domain metrics payload.

Request
curl "https://api.misar.io/seo/domain/overview?projectId=5b1c7d2e-…&domain=acme.com&locationCode=2840&languageCode=en" \
  -H "Authorization: Bearer $MISARSEO_API_KEY"
400 — Bad hostname
{ "error": "domain is not a valid hostname", "code": "VALIDATION_ERROR" }

Rate limit: 20 requests per 60 s.

Pass a hostname, not a URL

https://acme.com/pricing is rejected. Strip the scheme and path first — acme.com. The validator also requires the value to round-trip unchanged through lowercasing and trimming, so Acme.com fails too.

Status codes

CodeMeaning
200Metrics returned
400VALIDATION_ERROR — missing projectId, missing domain, or an invalid hostname
401UNAUTHENTICATED
404NOT_FOUND — project not found
429RATE_LIMITED
501SEO_DATA_UNAVAILABLE — no honest data source in this deployment's data mode
502UPSTREAM_UNAVAILABLE — the data provider failed

Expect 501 in free data mode

Domain authority in free mode is derived from open public datasets and some sub-metrics are simply unavailable. When a metric has no honest source it is returned as null, or the whole request fails with 501 rather than returning a fabricated figure.