Project creation

Method ProjectProcedure.createProject allows to create a new project without using Serpstat's interface.

Request parameters
Parameter Description Type Optional Default value Value options
id A request id: the response contains the same id. int / str no Text or number value.
For example: 1, test
method API method name string no ProjectProcedure.createProject
params The object with parameters {...}, it lists all the following parameters and arrays [...]
no
domain Name of the domain string no String value in format domain.com (for example: test.com, domain.com)
name Name of the project you create string no Text value.
For example: test, my project 
groups Group for the new project array yes Choose existing group or create new. (for example "name": "test") 
name Name of the group, should be inside of the "groups" array. string yes Default group Text value.
For example: test, my group

Response parameters
Parameters Description
id

Response id corresponds the request id

result Contains the answer
project_id Your created project's ID

 API credits are not required. Method requires 1 project credit.

Example
Request data:
{
    "id": 1,
    "method": "ProjectProcedure.createProject",
    "params": {
        "domain": "test.com",
        "name": "test.com",
        "groups": [
            {
                "name": "test"
            }
        ]
    }
}
Response data:
{
    "id": "1",
    "result": {
        "project_id": "1051615"
    }
}

Share this article with your friends

Are you sure?

Introducing Serpstat

Find out about the main features of the service in a convenient way for you!

Please send a request, and our specialist will offer you education options: a personal demonstration, a trial period, or materials for self-study and increasing expertise — everything for a comfortable start to work with Serpstat.

Name

Email

Phone

We are glad of your comment
I agree to Serpstat`s Privacy Policy.

Thank you, we have saved your new mailing settings.

Open support chat