SEMrush API v4.0 is only intended for applications registered in the SEMrush Authentication service (Google Data Studio, Zapier, etc.).
If you’d like to use this API, contact us.
https://api.semrush.com/apis/v4/
The response body contains a JSON-encoded object, which has a top-level object meta, followed by either a data object or an error object, but not both. An explanation of each of these properties can be found below.
Object meta
Key | Type | Description | Optional |
---|---|---|---|
success | boolean | Status of the request | Mandatory |
status_code | int | HTTP status code | Mandatory |
request_id | string | Unique ID of the request | Optional |
Success response example
{
"meta": {
"success": true,
"status_code": 200,
"request_id": "IAD-as5656as776",
},
"data": [
{
"id": "590e",
"kind": "dog",
"name": "Penny"
},
{
"id": "a45f",
"kind": "cat",
"name": "Tommy"
}
]
}
Object error
Key | Type | Description | Optional |
---|---|---|---|
code | int | Error code | Mandatory |
message | string | Error message | Mandatory |
description | string | Error description | Optional |
Failed response example
{
"meta": {
"success": false,
"status_code": 400,
"request_id": "IAD-123ade456",
},
"error": {
"code": 120200,
"message": "This was bad",
"description": "google.me?error=120200"
}
}
This request allows you to get a list of Siteaudit campaigns for your account.
GET
https://api.semrush.com/apis/v4/siteaudit/campaigns/
This request allows you to get a list of tasks for your Site Audit campaign.
GET
https://api.semrush.com/apis/v4/siteaudit/campaigns/{campaign_id:[0-9]+}/tasks
This request allows you to get the Site Audit Overview report.
GET
https://api.semrush.com/apis/v4/siteaudit/campaigns/{campaign_id:[0-9]+}/reports/overview
This request allows you to create a new project and set up a Site Audit campaign.
POST
https://api.semrush.com/apis/v4/siteaudit/campaigns/