Obtaining the list of projects and their status
The RtApiProjectProcedure.getProjects method returns the list of projects (all not removed) and their status.
General request parameters and instructions for using Serpstat API
Request parameters | |||
Parameter | Value | Description | |
id | required | any number or string | Request ID |
method | required | RtApiProjectProcedure.getProjects | API method name |
params | required | {...} | Object with parameters |
page | optional | 1 | Page number. 1 — by default |
pageSize | optional | 100 | Number of results per page. 100 — by default. |
Response parameters | |
Parameter | Description |
id | Response id corresponds the request id |
result | Contains the answer |
data | Array with objects |
projectId | Project ID |
projectName | Project name |
domain | Domain for which the project created |
createdAt | Project's creation date |
group | Group that is connected with the project |
type | Connection type between owner and project: * owner — owner of a project * read — read only * editor — edit access |
status | Project status: * 8 — the project is not configured; * 9 — the project is configured |
enableTracking | The parameter indicates whether automatic position removal is enabled in the project: * true — turned on; * false — turned off |
summary_info | Summary data block |
page | Current page |
page_total | Number of pages with the results for the selected parameter pageSize |
count | Number of results per page |
total | Total number of results |
Credits for this method are not deducted.
{
"id": 1,
"method": "RtApiProjectProcedure.getProjects",
"params": {
"page": 1,
"pageSize": 10
}
}
{
"id": "1",
"result": {
"data": [
{
"id": "898826",
"projectName": "northwestnumbersltd.co.uk",
"domain": "northwestnumbersltd.co.uk",
"createdAt": "2021-06-11 14:52:03",
"group": "Default group",
"type": "owner",
"status": 9,
"enableTracking": true
},
{
"id": "897094",
"projectName": "ganeshaspeaks.com",
"domain": "ganeshaspeaks.com",
"createdAt": "2021-06-08 15:31:40",
"group": "Default group",
"type": "owner",
"status": 8,
"enableTracking": true
},
{
"id": "890650",
"projectName": "splitmyfare.co.uk",
"domain": "splitmyfare.co.uk",
"createdAt": "2021-05-26 11:17:30",
"group": "Default group",
"type": "owner",
"status": 9,
"enableTracking": false
},
{
"id": "853932",
"projectName": "adidas.com",
"domain": "adidas.com",
"createdAt": "2021-03-10 10:48:23",
"group": "Default group",
"type": "owner",
"status": 9,
"enableTracking": true
},
{
"id": "829378",
"projectName": "eschareschartsts.com",
"domain": "escharts.com",
"createdAt": "2021-01-20 18:27:06",
"group": "Default group",
"type": "editor",
"status": 9,
"enableTracking": true
}
],
"summary_info": {
"page": 1,
"page_total": 1,
"count": 50,
"total": 30
}
}
}