# Projects

Last modified:
02/02/2021

## Object structure: "Project"

| Field                        | Type                                    | Description                                                                                                                                               |
|------------------------------|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Main**                     |                                         |                                                                                                                                                           |
| id                           | int                                     | Project ID                                                                                                                                               |
| user_id                      | int                                     | User ID                                                                                                                                                  |
| name                         | string                                  | Project name                                                                                                                                             |
| site                         | string                                  | Website URL                                                                                                                                             |
| on                           | int                                     | Project status: <br>- **0**  regular project<br>- **-1**  archived                                                                          |
| date                         | datetime                                | Creation time                                                                                                                                           |
| right                        | string                                  | Access rights                                                                                                                                           |
| favorite                     | boolean                                 | Favorite project                                                                                                                                       |
| tags                         | set(от 1 до 10)                         | Tag number                                                                                                                                              |
| user_email                   | string                                  | Owner Email                                                                                                                                             |
| **Status**                   |                                         |                                                                                                                                                           |
| status_positions             | enum(0,1,2,3)                          | Rank check status                                                                                                                                      |
| positions_time               | datetime                                | Last rank check time                                                                                                                                   |
| positions_percent            | int                                     | Rank check progress in percents                                                                                                                        |
| status_volumes              | enum(0,1,2,3)                          | Search volume check status                                                                                                                                       |
| status_claster               | boolean                                 | Keyword clustering check                                                                                                                                 |
| **Schedule settings**        |                                         |                                                                                                                                                           |
| subdomains                   | boolean                                 | Include/exclude subdomains                                                                                                                               |
| filter                       | int                                     | Filter: <br>- **0**  do not filter<br>- **1**  moderate filtering<br>- **2**  family search                                             |
| auto_correct                 | boolean                                 | Correct/do not correct spelling                                                                                                                          |
| with_snippets                | boolean                                 | Collect/do not collect snippets                                                                                                                          |
| do_snapshots                 | int                                     | Snapshots: <br>- **0**  do not save SERP snapshots;<br>- **1** collect SERP Snapshots TOP 100 in Yandex and the same TOP as depth in Google |
| **Extra settings**           |                                         |                                                                                                                                                           |
| common_traffic               | boolean                                 | Traffic<br>- **0**  local traffic<br>- **1**  global traffic                                                                                |
| guest_link_right             | string                                  | Guest link options                                                                                                                                       |
| **Extra**                    |                                         |                                                                                                                                                           |
| broker_count_campaigns       | int                                     | Added ad campaigns count                                                                                                                                 |
| broker_count_banners         | int                                     | Active ads count                                                                                                                                         |
| broker_count_banners_off     | int                                     | Inactive ads count                                                                                                                                       |
| domain_expire                | object                                  | Domain info                                                                                                                                              |
| COUNT(*)                     | int                                     | Found objects count<br>- Do not use with other fields<br>- Returns a single object                                                                      |

## Available methods to manage projects

- [get](/content/api/v2-services/projects_2/projects/get/index.html)  get a list of projects
- [add](/content/api/v2-services/projects_2/projects/add/index.html)  add a project
- [edit: projects/copy](/content/api/v2-services/projects_2/projects/add-projects_copy/index.html)  copy a project
- [edit: projects/name](/content/api/v2-services/projects_2/projects/edit-projects_name/index.html)  set a project name
- [edit: projects/on](/content/api/v2-services/projects_2/projects/edit-projects_on/index.html)  set project mode: active or inactive
- [edit: projects/tags](/content/api/v2-services/projects_2/projects/edit-projects_tags/index.html)  assign a tag to a project
- [edit: projects/favorite](/content/api/v2-services/projects_2/projects/edit-projects_favorite/index.html)  make a project favorite
- [edit: projects/move](/content/api/v2-services/projects_2/projects/edit-projects_move/index.html)  move a project in the project list
- [edit: projects/sort](/content/api/v2-services/projects_2/projects/edit-projects_sort/index.html)  sort projects in the project list
- [del](/content/api/v2-services/projects_2/projects/del/index.html)  delete a project