Domain overview
Organic search overview for a domain
Returns a domain's organic search footprint: how many keywords it ranks for, estimated monthly organic traffic, position distribution (top 3/10/20/100), and how its rankings are moving. Costs 5 credits.
POST
/v1/domain-overview/Authorization
accessKey x-access-key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/domain-overview/" \ -H "Content-Type: application/json" \ -d '{ "domain": "string" }'{
"success": true,
"credits": {
"charged": 0,
"remaining": 0
},
"data": {
"domain": "string",
"location": "string",
"organic_keywords": 0,
"organic_traffic": 0,
"estimated_traffic_cost": null,
"positions": {
"top_3": 0,
"top_10": 0,
"top_20": 0,
"top_100": 0
},
"movement": {
"up": 0,
"down": 0,
"new": 0,
"lost": 0
}
}
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}