API Description

Marketing plan

List of plan items

The method returns a list of sections, items, and notes.

Request format

Title of the code block
Copy
GET /checklist/{site_id}

Request parameters

NameRequiredDescription
site_idYesSite ID

Result

If successful, the server returns a list of sections, items, and notes.

Response example

Title of the code block
Copy
[
{
"title": "Step 1. Semantic core and keyword research",
"items": [
  {
"id": "analyze_competitors",
"title": "Analyze competitors’ keywords",
"checked": true
}, 
{
"id": "makeup_final_list",
"title": "Collect core keywords",
"checked": true
},
...
],
"id": "keywords_research",
"items_count": 3,
"items_checked": 3
},
...
]

Response parameters

NameDescription
idSection ID
titleSection name
items_countTotal number of items in a section 
items_checkedTotal number of completed items
itemsSection items
NameDescriptionidItem IDtitleItem namecheckedItem status

Adding tasks

Request format

Title of the code block
Copy
POST /checklist/{site_id}/task
{"title": "text","text": "text description","for_all" : false}

Request parameters

NameRequiredDescription
titleYesName
textYesDescription
for_allNoFor all projects

Result

If successful, the server returns the ID of the created task.

Response example

Title of the code block
Copy
{"id": 1}

Errors

HTTP code Error message
400Empty title
400Empty text

Changing a task

Request format

Title of the code block
Copy
PUT /checklist/{site_id}/task/
{ "task_id" : "makeup_final_list", "title": "text", "text": "text description",}

Request parameters

NameRequiredDescription
task_idYesTask ID
titleYesName
textYesDescription

Result

If successful, the server returns the 200 HTTP code.

Errors

HTTP code Error message
400Empty title
400Empty text

Deleting a task

Only tasks created via the method (POST /checklist/{site_id}/task) can be deleted

Request format

Title of the code block
Copy
DELETE /checklist/{site_id}/task/{task_id}

Result

If successful, the server returns the 204 HTTP code.

Setting a task’s status

Request format

Title of the code block
Copy
PUT /checklist/{site_id}/task/
{"task_id" : "makeup_final_list","checked": true}

Request parameters

NameRequiredDescription
task_idYesTask ID
checkedYestrue – completed

Result

If successful, the server returns the 200 HTTP code.