Get list of Rank Tracker projects
Use the RtApiProjectProcedure.getProjects method to get a list of your projects.
The method will save you time on getting information on your project ID, name, date of creation without the need of entering the platform.
Request parameters | |||||
Parameter | Description | Type | Optional | Default value | Value options |
id | A request id: the response contains the same id. | int / string | no | Any text or number value, for example: 1, test | |
method | API method name | string | no | RtApiProjectProcedure.getProjects | |
params | The object with parameters {...}, it lists all the following parameters and arrays [...] | yes | |||
page | Page number in the projects list | int | yes | 1 | Number value, for example: 1, 5 |
size | Number of results per page in the project list | int | yes | 100 | Choose any number from the following: 20, 50, 100, 200, 500 |
Response parameters | |
Parameters | Description |
id | Request id |
result | Contains the answer. |
data | Array with data |
id (in data array) | Your project's ID |
projectName | Your project's name |
domain | Project's domain name |
createdAt | Date and time when the project was created |
group | Project's group |
type | Project's type ("owner" — you are the owner of this project, "reader" — the project's owner is a member of your team. In case you use Team management.) |
status | Project status. 0 - deleted, 8 - active and not configured, 9 - active and configured. |
enableTracking | Availability of the Rank Tracker project by domain |
summary_info | Object with general data |
page | Page number |
page_total | Number of pages per request |
count | Number of responses per request |
total | Total amount of projects |
Credits for this method are not deducted.
{
"id": 1,
"method": "RtApiProjectProcedure.getProjects",
"params": {
"page": 1,
"pageSize": 20
}
}
{
"id": "1",
"result": {
"data": [
{
"id": "865802",
"projectName": "serpstat.com",
"domain": "serpstat.com",
"createdAt": "2021-04-02 17:58:17",
"group": "Default group",
"type": "owner",
"status": 8,
"enableTracking": true
},
{
"id": "865801",
"projectName": "serpstat.com",
"domain": "serpstat.com",
"createdAt": "2021-04-02 17:35:34",
"group": "Default group",
"type": "owner",
"status": 9,
"enableTracking": true
},
{
"id": "864988",
"projectName": "sardayal.ru",
"domain": "sardayal.ru",
"createdAt": "2021-03-31 13:29:29",
"group": "Default group",
"type": "owner",
"status": 9,
"enableTracking": true
},
{
"id": "864774",
"projectName": "insightedge.jp",
"domain": "insightedge.jp",
"createdAt": "2021-03-31 00:29:42",
"group": "Default group",
"type": "owner",
"status": 9,
"enableTracking": true
},
{
"id": "864510",
"projectName": "serpstat.com 3003",
"domain": "serpstat.com",
"createdAt": "2021-03-30 16:11:29",
"group": "Default group",
"type": "owner",
"status": 9,
"enableTracking": true
},
{
"id": "864390",
"projectName": ".chula.ac.th",
"domain": "chula.ac.th",
"createdAt": "2021-03-30 13:39:53",
"group": "Default group",
"type": "owner",
"status": 9,
"enableTracking": true
}
],
"summary_info": {
"page": 1,
"page_total": 5,
"count": 20,
"total": 100
}
}
}