{ "item": [ { "name": "Account", "description": "Balance and top-up invoices.", "item": [ { "id": "c5f76a04-c838-4f8f-b082-8d64fd9b7bae", "name": "Check the balance", "request": { "name": "Check the balance", "description": { "content": "Returns your current balance across all services.", "type": "text/plain" }, "url": { "path": [ "v2", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "97e54ac9-7bf0-4d44-bb97-9c8ee6c4f1e2", "name": "Balance", "originalRequest": { "url": { "path": [ "v2", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"balance\": {\n \"tokens\": \"\",\n \"indexer\": \"\",\n \"checker\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb68647f-90ce-4f7f-af24-1af31b71ddf3", "name": "The API key is missing or wrong", "originalRequest": { "url": { "path": [ "v2", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2afb2d9b-85f4-471f-9aef-5befbaafddc6", "name": "Create an invoice to purchase tokens", "request": { "name": "Create an invoice to purchase tokens", "description": { "content": "Available packages: $5 (5,000), $20 (30,000), $50 (120,000), $100 (250,000), $250 (700,000), $500 (1,500,000 tokens).\nPayPal: +10% fee. YooKassa: USD to RUB (1 USD = 100 RUB), requires email.\n", "type": "text/plain" }, "url": { "path": [ "v2", "account", "invoice", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"price\": 20,\n \"method\": \"yookassa\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "706e20fe-4b23-497b-af6b-5f4c78ec832b", "name": "Invoice created", "originalRequest": { "url": { "path": [ "v2", "account", "invoice", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"price\": 20,\n \"method\": \"yookassa\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"result\": \"\",\n \"tokens_amount\": \"\",\n \"price\": \"\",\n \"currency\": \"USD\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "855fd36d-7ba4-4731-8406-2bb6194d7f3d", "name": "The API key is missing or wrong", "originalRequest": { "url": { "path": [ "v2", "account", "invoice", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"price\": 20,\n \"method\": \"yookassa\",\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Indexing and index checks", "description": "Tasks that submit URLs for indexing (Google, Yandex) or check index status (Google, Yandex, Bing).", "item": [ { "id": "f0c9c805-de8e-4b36-acaa-ef42563bca23", "name": "Create an indexing or index check task", "request": { "name": "Create an indexing or index check task", "description": { "content": "`search_engine`: google, yandex, bing. `task_type`: indexer, checker. Bing supports checker only.\n\nCurrently only the `pay_per_indexed: true` mode is available for Google indexing tasks; standard Google indexing is temporarily unavailable.\nGoogle indexer: 100 tokens/URL, 100% refund for unindexed links after 7 days.\nYandex indexer: Pay per Indexed is always on, 20 tokens/URL, 100% refund for unindexed links after 15 days.\nIndexing credits are spent first (1 credit/URL); tokens are charged only for the URLs left uncovered.\n\nDrip Feed (google/indexer only): set `drip_feed: true` and `drip_feed_days` (2-30) to spread submissions\nacross several days in equal daily batches. The number of URLs must be at least `drip_feed_days`.\n", "type": "text/plain" }, "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "google", "key": "search_engine", "disabled": false, "description": { "content": "(Required) google, yandex or bing (bing supports checker only)", "type": "text/plain" } }, { "type": "any", "value": "checker", "key": "task_type", "disabled": false, "description": { "content": "(Required) indexer (submit for indexing) or checker (index status check)", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"urls\": [\n \"\",\n \"\"\n ],\n \"title\": \"\",\n \"pay_per_indexed\": \"\",\n \"drip_feed\": \"\",\n \"drip_feed_days\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3bd3432d-cd60-43ec-957f-fcb3122cd46b", "name": "Task created (code 0), or refused: code 1 insufficient balance, code 2 validation error", "originalRequest": { "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"urls\": [\n \"\",\n \"\"\n ],\n \"title\": \"\",\n \"pay_per_indexed\": \"\",\n \"drip_feed\": \"\",\n \"drip_feed_days\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"task_id\": \"\",\n \"type\": \"\",\n \"pay_per_indexed\": \"\",\n \"drip_feed\": \"\",\n \"drip_feed_days\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcf66bd7-e9e4-4071-b0c5-d8e1e209499f", "name": "The API key is missing or wrong", "originalRequest": { "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"urls\": [\n \"\",\n \"\"\n ],\n \"title\": \"\",\n \"pay_per_indexed\": \"\",\n \"drip_feed\": \"\",\n \"drip_feed_days\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08daf9cd-6f9c-49dd-9030-747d6d7756f5", "name": "Not enough balance", "originalRequest": { "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"urls\": [\n \"\",\n \"\"\n ],\n \"title\": \"\",\n \"pay_per_indexed\": \"\",\n \"drip_feed\": \"\",\n \"drip_feed_days\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b00aa87f-81b4-4570-87f2-264fefadcbba", "name": "The request body is too large", "originalRequest": { "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"urls\": [\n \"\",\n \"\"\n ],\n \"title\": \"\",\n \"pay_per_indexed\": \"\",\n \"drip_feed\": \"\",\n \"drip_feed_days\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Request Entity Too Large", "code": 413, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ebf23ed-a18e-4cf3-987e-e5b6ad6c4e91", "name": "Rate limit exceeded; wait for Retry-After seconds", "originalRequest": { "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"urls\": [\n \"\",\n \"\"\n ],\n \"title\": \"\",\n \"pay_per_indexed\": \"\",\n \"drip_feed\": \"\",\n \"drip_feed_days\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c35b1770-57c7-420d-b973-19985e239624", "name": "List tasks", "request": { "name": "List tasks", "description": { "content": "Up to 1000 tasks per page, newest first. Pages start at 0.\n`filter` (google/indexer only): standard, pay_per_indexed or drip_feed. Without a filter: standard and Pay per Indexed tasks (no Drip Feed).\nCombine `filter=drip_feed` with `pay_per_indexed=true|false` to filter Drip Feed tasks by type.\n", "type": "text/plain" }, "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "list", ":page" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "standard" }, { "disabled": false, "description": { "content": "With filter=drip_feed only.", "type": "text/plain" }, "key": "pay_per_indexed", "value": "" } ], "variable": [ { "type": "any", "value": "google", "key": "search_engine", "disabled": false, "description": { "content": "(Required) google, yandex or bing (bing supports checker only)", "type": "text/plain" } }, { "type": "any", "value": "checker", "key": "task_type", "disabled": false, "description": { "content": "(Required) indexer (submit for indexing) or checker (index status check)", "type": "text/plain" } }, { "type": "any", "value": "", "key": "page", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "34bc8903-22d2-4e46-9b0f-6537c3ccbc0a", "name": "A page of tasks", "originalRequest": { "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "list", ":page" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "standard" }, { "disabled": false, "description": { "content": "With filter=drip_feed only.", "type": "text/plain" }, "key": "pay_per_indexed", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"page\": \"\",\n \"last_page\": \"\",\n \"result\": [\n {\n \"id\": \"\",\n \"size\": \"\",\n \"processed_count\": \"\",\n \"indexed_count\": \"\",\n \"title\": \"\",\n \"is_completed\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"pay_per_indexed\": \"\",\n \"status\": \"\",\n \"tokens_charged\": \"\",\n \"tokens_refunded\": \"\",\n \"check_after\": \"\",\n \"days\": \"\",\n \"days_passed\": \"\",\n \"is_stopped\": \"\",\n \"child_task_ids\": [\n \"\",\n \"\"\n ],\n \"children\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"size\": \"\",\n \"processed_count\": \"\",\n \"indexed_count\": \"\",\n \"title\": \"\",\n \"is_completed\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"pay_per_indexed\": \"\",\n \"status\": \"\",\n \"tokens_charged\": \"\",\n \"tokens_refunded\": \"\",\n \"check_after\": \"\",\n \"days\": \"\",\n \"days_passed\": \"\",\n \"is_stopped\": \"\",\n \"child_task_ids\": [\n \"\",\n \"\"\n ],\n \"children\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d488086-cc78-4c00-9ea9-2f31ce00c993", "name": "The API key is missing or wrong", "originalRequest": { "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "list", ":page" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "standard" }, { "disabled": false, "description": { "content": "With filter=drip_feed only.", "type": "text/plain" }, "key": "pay_per_indexed", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1af5243b-8619-4754-b8e1-4a74c5961d84", "name": "Get the status of tasks", "request": { "name": "Get the status of tasks", "description": { "content": "Provide either `task_id` or `task_ids`. Pay per Indexed tasks add status, tokens_charged, tokens_refunded and check_after.\nFor a single Drip Feed task the response adds days, days_passed, is_stopped, child_task_ids and a `children` array.\n", "type": "text/plain" }, "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "google", "key": "search_engine", "disabled": false, "description": { "content": "(Required) google, yandex or bing (bing supports checker only)", "type": "text/plain" } }, { "type": "any", "value": "checker", "key": "task_type", "disabled": false, "description": { "content": "(Required) indexer (submit for indexing) or checker (index status check)", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\",\n \"task_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "11757782-126b-47d5-987d-5dc25cd4c33b", "name": "Task or tasks", "originalRequest": { "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\",\n \"task_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"result\": {\n \"id\": \"\",\n \"size\": \"\",\n \"processed_count\": \"\",\n \"indexed_count\": \"\",\n \"title\": \"\",\n \"is_completed\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"pay_per_indexed\": \"\",\n \"status\": \"\",\n \"tokens_charged\": \"\",\n \"tokens_refunded\": \"\",\n \"check_after\": \"\",\n \"days\": \"\",\n \"days_passed\": \"\",\n \"is_stopped\": \"\",\n \"child_task_ids\": [\n \"\",\n \"\"\n ],\n \"children\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "521b6ecc-183d-4dfc-8f97-87347f9bee3b", "name": "The API key is missing or wrong", "originalRequest": { "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\",\n \"task_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "66a176d6-92ca-448b-9c48-ce8c85d2e529", "name": "Download a task report", "request": { "name": "Download a task report", "description": { "content": "Indexed and unindexed URL lists. For a Drip Feed task the lists are aggregated across all child tasks.", "type": "text/plain" }, "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "google", "key": "search_engine", "disabled": false, "description": { "content": "(Required) google, yandex or bing (bing supports checker only)", "type": "text/plain" } }, { "type": "any", "value": "checker", "key": "task_type", "disabled": false, "description": { "content": "(Required) indexer (submit for indexing) or checker (index status check)", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "15a806a6-1f20-4243-8715-9d42569352a0", "name": "Report", "originalRequest": { "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"result\": {\n \"id\": \"\",\n \"size\": \"\",\n \"processed_count\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"created_at\": \"\",\n \"pay_per_indexed\": \"\",\n \"tokens_charged\": \"\",\n \"tokens_refunded\": \"\",\n \"drip_feed\": \"\",\n \"days\": \"\",\n \"days_passed\": \"\",\n \"indexed_links\": [\n \"\",\n \"\"\n ],\n \"unindexed_links\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daf19ede-8497-4308-9e18-a753fbb6feaf", "name": "The API key is missing or wrong", "originalRequest": { "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "081975f7-4e9a-4d44-abb6-9593d9d56a10", "name": "Download a full task report with page titles", "request": { "name": "Download a full task report with page titles", "description": { "content": "Same as the report, but each indexed link is `{url, title}`, where title is the page title in the search results\nof the selected engine (empty string if unavailable). Unindexed links are `{url, error_code}` for standard tasks\nand `{url}` for Pay per Indexed and Drip Feed tasks.\nerror_code: -1 meta noindex found, 0 no errors, other values are the HTTP status found on the page.\nyandex/indexer: links are marked indexed only after the automatic final check 15 days after the task is created.\n", "type": "text/plain" }, "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "fullreport" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "google", "key": "search_engine", "disabled": false, "description": { "content": "(Required) google, yandex or bing (bing supports checker only)", "type": "text/plain" } }, { "type": "any", "value": "checker", "key": "task_type", "disabled": false, "description": { "content": "(Required) indexer (submit for indexing) or checker (index status check)", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "89fcbe67-a41f-450a-a16c-9bf931493086", "name": "Full report", "originalRequest": { "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "fullreport" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"result\": {\n \"id\": \"\",\n \"size\": \"\",\n \"processed_count\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"created_at\": \"\",\n \"pay_per_indexed\": \"\",\n \"tokens_charged\": \"\",\n \"tokens_refunded\": \"\",\n \"drip_feed\": \"\",\n \"days\": \"\",\n \"days_passed\": \"\",\n \"indexed_links\": [\n {\n \"url\": \"\",\n \"title\": \"\"\n },\n {\n \"url\": \"\",\n \"title\": \"\"\n }\n ],\n \"unindexed_links\": [\n {\n \"url\": \"\",\n \"error_code\": \"\"\n },\n {\n \"url\": \"\",\n \"error_code\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61e364b3-9bc5-4232-afb5-7f2460afb787", "name": "The API key is missing or wrong", "originalRequest": { "url": { "path": [ "v2", "task", ":search_engine", ":task_type", "fullreport" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Single URL indexing", "description": "Submit one URL without creating a task manually.", "item": [ { "id": "db439476-d681-442d-8918-15168a2b8612", "name": "Index a single link", "request": { "name": "Index a single link", "description": { "content": "`search_engine`: google or yandex.\nGoogle: pass `pay_per_indexed: true` for 100 tokens/URL with a 100% refund for unindexed links after 7 days; without it, standard indexing credits are used (1 credit/URL).\nYandex: Pay per Indexed is always on (refund after 15 days). Indexing credits are spent first; when they run out, 20 tokens/URL are charged. The flag is accepted but has no effect.\n", "type": "text/plain" }, "url": { "path": [ "v2", ":search_engine", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "google", "key": "search_engine", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"pay_per_indexed\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8d079ba7-68b5-4e4d-b164-06cb96204134", "name": "code 0 success, 1 insufficient balance, 2 invalid URL, 3 daily limit exceeded or the task could not be created (the charge is refunded)", "originalRequest": { "url": { "path": [ "v2", ":search_engine", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"pay_per_indexed\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"task_id\": \"\",\n \"type\": \"\",\n \"pay_per_indexed\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ab50b93-8302-4684-942b-a14aa942b364", "name": "The API key is missing or wrong", "originalRequest": { "url": { "path": [ "v2", ":search_engine", "url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"pay_per_indexed\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Backlink checker", "description": "Open donor pages and find links to your target domains.", "item": [ { "id": "3c3fe1bf-0538-414a-a06c-98e9645d1f31", "name": "Create a backlink check task", "request": { "name": "Create a backlink check task", "description": { "content": "Check donor pages for backlinks to your target domains. Up to 10,000 donor URLs and 50 target domains per task.", "type": "text/plain" }, "url": { "path": [ "v2", "task", "backlink", "checker", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"urls\": [\n \"\",\n \"\"\n ],\n \"target_domains\": [\n \"\",\n \"\"\n ],\n \"title\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "93a9efed-589f-4d75-a79a-a79f2822f41b", "name": "Task created (code 0), or refused: code 1 insufficient balance, code 2 validation error", "originalRequest": { "url": { "path": [ "v2", "task", "backlink", "checker", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"urls\": [\n \"\",\n \"\"\n ],\n \"target_domains\": [\n \"\",\n \"\"\n ],\n \"title\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"task_id\": \"\",\n \"type\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b10a9a5-2d65-4573-a5ee-13c0a342ec15", "name": "The API key is missing or wrong", "originalRequest": { "url": { "path": [ "v2", "task", "backlink", "checker", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"urls\": [\n \"\",\n \"\"\n ],\n \"target_domains\": [\n \"\",\n \"\"\n ],\n \"title\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a262525-ea05-4897-ad4b-613748b4ff0b", "name": "Not enough balance", "originalRequest": { "url": { "path": [ "v2", "task", "backlink", "checker", "create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"urls\": [\n \"\",\n \"\"\n ],\n \"target_domains\": [\n \"\",\n \"\"\n ],\n \"title\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4d2ed4be-1f82-4655-b219-f7917f68a7b8", "name": "Get the status of backlink check tasks", "request": { "name": "Get the status of backlink check tasks", "description": {}, "url": { "path": [ "v2", "task", "backlink", "checker", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\",\n \"task_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2ea57225-ea75-46c1-9efb-af6501148ff0", "name": "Task or tasks", "originalRequest": { "url": { "path": [ "v2", "task", "backlink", "checker", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\",\n \"task_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"result\": {\n \"id\": \"\",\n \"size\": \"\",\n \"processed_count\": \"\",\n \"title\": \"\",\n \"target_domains\": [\n \"\",\n \"\"\n ],\n \"is_completed\": \"\",\n \"type\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63f2bc6a-5595-4d82-b313-beddfb301523", "name": "The API key is missing or wrong", "originalRequest": { "url": { "path": [ "v2", "task", "backlink", "checker", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\",\n \"task_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa99447f-d648-4901-9a62-5cb8a69bd688", "name": "Download a backlink check report", "request": { "name": "Download a backlink check report", "description": { "content": "For each donor URL — HTTP status, Moz Domain Authority, Moz spam score, indexability and the links found to the target domains. Paged, up to 100 donors per page.", "type": "text/plain" }, "url": { "path": [ "v2", "task", "backlink", "checker", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\",\n \"page\": 0,\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "58c44859-aebc-4335-92ba-cb76d24ce05f", "name": "A page of the report", "originalRequest": { "url": { "path": [ "v2", "task", "backlink", "checker", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\",\n \"page\": 0,\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"result\": {\n \"id\": \"\",\n \"size\": \"\",\n \"processed_count\": \"\",\n \"is_completed\": \"\",\n \"page\": \"\",\n \"last_page\": \"\",\n \"donors\": [\n {\n \"donor_url\": \"\",\n \"processed\": \"\",\n \"error\": \"\",\n \"http_status\": \"\",\n \"canonical_url\": \"\",\n \"page_language\": \"\",\n \"moz_domain_authority\": \"\",\n \"moz_spam_score\": \"\",\n \"internal_links_count\": \"\",\n \"external_links_count\": \"\",\n \"indexing\": {},\n \"target_links\": [\n {\n \"url\": \"\",\n \"anchor\": \"\",\n \"anchor_type\": \"\",\n \"nofollow\": \"\",\n \"is_ugc\": \"\",\n \"is_sponsored\": \"\"\n },\n {\n \"url\": \"\",\n \"anchor\": \"\",\n \"anchor_type\": \"\",\n \"nofollow\": \"\",\n \"is_ugc\": \"\",\n \"is_sponsored\": \"\"\n }\n ]\n },\n {\n \"donor_url\": \"\",\n \"processed\": \"\",\n \"error\": \"\",\n \"http_status\": \"\",\n \"canonical_url\": \"\",\n \"page_language\": \"\",\n \"moz_domain_authority\": \"\",\n \"moz_spam_score\": \"\",\n \"internal_links_count\": \"\",\n \"external_links_count\": \"\",\n \"indexing\": {},\n \"target_links\": [\n {\n \"url\": \"\",\n \"anchor\": \"\",\n \"anchor_type\": \"\",\n \"nofollow\": \"\",\n \"is_ugc\": \"\",\n \"is_sponsored\": \"\"\n },\n {\n \"url\": \"\",\n \"anchor\": \"\",\n \"anchor_type\": \"\",\n \"nofollow\": \"\",\n \"is_ugc\": \"\",\n \"is_sponsored\": \"\"\n }\n ]\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "519e2f03-9275-4fa2-94f4-5eec95160efb", "name": "The API key is missing or wrong", "originalRequest": { "url": { "path": [ "v2", "task", "backlink", "checker", "report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"task_id\": \"\",\n \"page\": 0,\n \"limit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Rank Tracker - reference", "description": "Limits, prices, locations, groups and spending.", "item": [ { "id": "361b1cf5-9a66-4fea-bbd6-55dffa2da914", "name": "Limits, prices and balance", "request": { "name": "Limits, prices and balance", "description": { "content": "Your account's limits and usage, current prices, balance and tokens held by running checks. Read limits from here rather than hardcoding them.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "limits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4cd34a8a-4afa-4b7e-9f3c-697aa1f1129a", "name": "Limits", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "limits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"limits\": {\n \"projects\": {\n \"limit\": \"\",\n \"used\": \"\"\n },\n \"tracked_rows\": {\n \"limit\": \"\",\n \"used\": \"\"\n },\n \"keywords_per_project\": \"\",\n \"regions_per_project\": \"\",\n \"tags_per_project\": \"\",\n \"rows_per_check\": \"\",\n \"keywords_per_request\": \"\"\n },\n \"prices\": {\n \"page\": \"\",\n \"page_with_ai_overview\": \"\",\n \"promo\": {\n \"discount\": \"\",\n \"until\": \"\"\n }\n },\n \"balance\": \"\",\n \"tokens_held\": \"\",\n \"depths\": [\n \"\",\n \"\"\n ],\n \"devices\": [\n \"\",\n \"\"\n ],\n \"webhook_events\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a3dc601-6de6-45ca-b3f1-91d488c43e65", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "limits" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1fa1999e-bf2f-4f56-a062-3dc24705306b", "name": "Find a location", "request": { "name": "Find a location", "description": { "content": "Google locations by the start of their name. Use canonical_name as a region's location and country_code as its gl.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "gl", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "344fb8da-5189-4979-9734-1748eec4c438", "name": "Locations", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "gl", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"locations\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"canonical_name\": \"\",\n \"country_code\": \"\",\n \"target_type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"canonical_name\": \"\",\n \"country_code\": \"\",\n \"target_type\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9209ee4-27c8-463e-a47f-ef47f1cdce5f", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "locations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "gl", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c94e526b-bb5f-4e66-bbac-f2e7e993bf25", "name": "Project groups", "request": { "name": "Project groups", "description": {}, "url": { "path": [ "v2", "rank-tracker", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dd184315-9af1-4657-8e6b-8739ad3355dc", "name": "Groups with project counts; group \"\" is the projects without a group", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"items\": [\n {\n \"group\": \"\",\n \"projects\": \"\",\n \"archived\": \"\"\n },\n {\n \"group\": \"\",\n \"projects\": \"\",\n \"archived\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10e28e6c-6778-4db9-afff-8abfae94a24b", "name": "Spending", "request": { "name": "Spending", "description": { "content": "Tokens spent on checks by day and by project. The last 30 days by default, up to 366 days.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "YYYY-MM-DD (midnight in tz) or an ISO time", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "IANA time zone of the days", "type": "text/plain" }, "key": "tz", "value": "UTC" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "group", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "project_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7a8241f7-12d2-488a-81ef-1c222cb8ac88", "name": "Spending", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "YYYY-MM-DD (midnight in tz) or an ISO time", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "IANA time zone of the days", "type": "text/plain" }, "key": "tz", "value": "UTC" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "group", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "project_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"tz\": \"\",\n \"total\": {\n \"tokens\": \"\",\n \"checks\": \"\"\n },\n \"days\": [\n {\n \"date\": \"\",\n \"tokens\": \"\",\n \"checks\": \"\"\n },\n {\n \"date\": \"\",\n \"tokens\": \"\",\n \"checks\": \"\"\n }\n ],\n \"projects\": [\n {\n \"project_id\": \"\",\n \"project_name\": \"\",\n \"group\": \"\",\n \"tokens\": \"\",\n \"checks\": \"\"\n },\n {\n \"project_id\": \"\",\n \"project_name\": \"\",\n \"group\": \"\",\n \"tokens\": \"\",\n \"checks\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Rank Tracker - projects", "description": "Sites tracked in Google with their regions, keywords, competitors and schedule.", "item": [ { "id": "32178f30-941c-4234-a15d-4bb7a925526d", "name": "List projects", "request": { "name": "List projects", "description": {}, "url": { "path": [ "v2", "rank-tracker", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sort", "value": "created" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "archived", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "group", "value": "" }, { "disabled": false, "description": { "content": "Part of the name or domain", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "next_cursor of the previous page. Opaque; only next_cursor null means the end.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7bd1298c-5cca-4acd-bd0e-1ac49c5bed51", "name": "A page of projects", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sort", "value": "created" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "archived", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "group", "value": "" }, { "disabled": false, "description": { "content": "Part of the name or domain", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "next_cursor of the previous page. Opaque; only next_cursor null means the end.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"group\": \"\",\n \"ref\": \"\",\n \"source\": \"api\",\n \"depth\": 50,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"status\": \"checking\",\n \"archived\": \"\",\n \"keywords_count\": \"\",\n \"last_check_at\": \"\",\n \"next_check_at\": \"\",\n \"last_summaries\": {\n \"tempor3d_\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n },\n \"pariatur64\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n },\n \"sint093\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n }\n },\n \"last_skipped\": null,\n \"webhook_url\": \"\",\n \"check_emails\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"group\": \"\",\n \"ref\": \"\",\n \"source\": \"api\",\n \"depth\": 100,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"status\": \"checking\",\n \"archived\": \"\",\n \"keywords_count\": \"\",\n \"last_check_at\": \"\",\n \"next_check_at\": \"\",\n \"last_summaries\": {\n \"quisba\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n }\n },\n \"last_skipped\": {},\n \"webhook_url\": \"\",\n \"check_emails\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"total\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfb70ad6-d117-4643-8a1a-15f27e8427a9", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "sort", "value": "created" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "archived", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "group", "value": "" }, { "disabled": false, "description": { "content": "Part of the name or domain", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" }, { "disabled": false, "description": { "content": "next_cursor of the previous page. Opaque; only next_cursor null means the end.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f18dc653-0c5a-4a0b-b055-92c9ca53b126", "name": "Create a project", "request": { "name": "Create a project", "description": { "content": "Creates a project, optionally with its keywords. If the keywords are refused (over a limit), the project is not created.\nSend `ref` (your own id) to make the request safe to repeat after a timeout: the same ref returns the same project with `repeated: true`.\n", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"domain\": \"\",\n \"regions\": [\n {\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"desktop\"\n }\n ],\n \"name\": \"\",\n \"depth\": 30,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"group\": \"\",\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"webhook_url\": \"\",\n \"check_emails\": false,\n \"ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "78fc8577-e9f8-471f-a675-177e3abe2641", "name": "The project made earlier by a request with the same ref (repeated true)", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"domain\": \"\",\n \"regions\": [\n {\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"desktop\"\n }\n ],\n \"name\": \"\",\n \"depth\": 30,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"group\": \"\",\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"webhook_url\": \"\",\n \"check_emails\": false,\n \"ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"project\": {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"group\": \"\",\n \"ref\": \"\",\n \"source\": \"cabinet\",\n \"depth\": 50,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"status\": \"checking\",\n \"archived\": \"\",\n \"keywords_count\": \"\",\n \"last_check_at\": \"\",\n \"next_check_at\": \"\",\n \"last_summaries\": {\n \"enim_dd\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n },\n \"ea_c\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n },\n \"mollit_bef\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n }\n },\n \"last_skipped\": null,\n \"webhook_url\": \"\",\n \"check_emails\": \"\",\n \"created_at\": \"\"\n },\n \"keywords\": {\n \"code\": \"\",\n \"added\": \"\",\n \"updated\": \"\",\n \"skipped\": \"\",\n \"errors\": [\n {\n \"index\": \"\",\n \"q\": \"\",\n \"error\": \"invalid_target_url\"\n },\n {\n \"index\": \"\",\n \"q\": \"\",\n \"error\": \"invalid_target_url\"\n }\n ],\n \"items\": [\n {\n \"index\": \"\",\n \"id\": \"\",\n \"q\": \"\",\n \"status\": \"updated\"\n },\n {\n \"index\": \"\",\n \"id\": \"\",\n \"q\": \"\",\n \"status\": \"updated\"\n }\n ]\n },\n \"repeated\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ddd55b3-8eb0-4b96-b413-5c85eee6b2b0", "name": "Project created", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"domain\": \"\",\n \"regions\": [\n {\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"desktop\"\n }\n ],\n \"name\": \"\",\n \"depth\": 30,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"group\": \"\",\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"webhook_url\": \"\",\n \"check_emails\": false,\n \"ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"project\": {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"group\": \"\",\n \"ref\": \"\",\n \"source\": \"cabinet\",\n \"depth\": 50,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"status\": \"checking\",\n \"archived\": \"\",\n \"keywords_count\": \"\",\n \"last_check_at\": \"\",\n \"next_check_at\": \"\",\n \"last_summaries\": {\n \"enim_dd\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n },\n \"ea_c\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n },\n \"mollit_bef\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n }\n },\n \"last_skipped\": null,\n \"webhook_url\": \"\",\n \"check_emails\": \"\",\n \"created_at\": \"\"\n },\n \"keywords\": {\n \"code\": \"\",\n \"added\": \"\",\n \"updated\": \"\",\n \"skipped\": \"\",\n \"errors\": [\n {\n \"index\": \"\",\n \"q\": \"\",\n \"error\": \"invalid_target_url\"\n },\n {\n \"index\": \"\",\n \"q\": \"\",\n \"error\": \"invalid_target_url\"\n }\n ],\n \"items\": [\n {\n \"index\": \"\",\n \"id\": \"\",\n \"q\": \"\",\n \"status\": \"updated\"\n },\n {\n \"index\": \"\",\n \"id\": \"\",\n \"q\": \"\",\n \"status\": \"updated\"\n }\n ]\n },\n \"repeated\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f39545b-7b2e-4e6e-8bfc-4942a0da0c6d", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"domain\": \"\",\n \"regions\": [\n {\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"desktop\"\n }\n ],\n \"name\": \"\",\n \"depth\": 30,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"group\": \"\",\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"webhook_url\": \"\",\n \"check_emails\": false,\n \"ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c46ba59-71db-49e2-b81f-4896a38d1e5a", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"domain\": \"\",\n \"regions\": [\n {\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"desktop\"\n }\n ],\n \"name\": \"\",\n \"depth\": 30,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"group\": \"\",\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"webhook_url\": \"\",\n \"check_emails\": false,\n \"ref\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "682a4067-0405-4c52-9a60-a3f4a5a99826", "name": "Get a project", "request": { "name": "Get a project", "description": { "content": "The project with its tags, removed regions, the cost of its next check, and its running and last finished checks.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6e02f970-e6f8-448d-82a6-c9c19b42c8d7", "name": "Project", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"project\": {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"group\": \"\",\n \"ref\": \"\",\n \"source\": \"cabinet\",\n \"depth\": 30,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"status\": \"idle\",\n \"archived\": \"\",\n \"keywords_count\": \"\",\n \"last_check_at\": \"\",\n \"next_check_at\": \"\",\n \"last_summaries\": {\n \"fugiat_f\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n },\n \"ut1\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n },\n \"ullamcof7d\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n },\n \"autecb4\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n }\n },\n \"last_skipped\": null,\n \"webhook_url\": \"\",\n \"check_emails\": \"\",\n \"created_at\": \"\",\n \"past_regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"tags\": [\n {\n \"tag\": \"\",\n \"count\": \"\"\n },\n {\n \"tag\": \"\",\n \"count\": \"\"\n }\n ],\n \"tag_colors\": {\n \"ex_cb\": \"\",\n \"tempor219\": \"\",\n \"aliquip09\": \"\"\n },\n \"cost\": {\n \"min\": \"\",\n \"max\": \"\",\n \"rows\": \"\",\n \"promo\": {\n \"discount\": \"\",\n \"until\": \"\"\n }\n }\n },\n \"active_check\": {\n \"id\": \"\",\n \"project_id\": \"\",\n \"trigger\": \"manual\",\n \"source\": \"api\",\n \"status\": \"failed\",\n \"error\": \"\",\n \"partial\": \"\",\n \"cancelled\": \"\",\n \"cancel_requested\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"depth\": \"\",\n \"rows\": \"\",\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"summaries\": {\n \"veniam_e11\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n }\n },\n \"tokens_spent\": \"\",\n \"tokens_held\": \"\",\n \"progress\": {\n \"keywords\": \"\",\n \"wave\": \"\",\n \"wave_keywords\": \"\",\n \"wave_done\": \"\",\n \"retry\": \"\",\n \"retry_at\": \"\",\n \"failed_pages\": \"\",\n \"eta_sec\": \"\"\n },\n \"rows_expire_at\": \"\"\n },\n \"last_check\": {\n \"id\": \"\",\n \"project_id\": \"\",\n \"trigger\": \"queued\",\n \"source\": \"cabinet\",\n \"status\": \"queued\",\n \"error\": \"\",\n \"partial\": \"\",\n \"cancelled\": \"\",\n \"cancel_requested\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"depth\": \"\",\n \"rows\": \"\",\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"summaries\": {\n \"esse566\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"incididuntf9\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n }\n },\n \"tokens_spent\": \"\",\n \"tokens_held\": \"\",\n \"progress\": null,\n \"rows_expire_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78411d95-ce2a-4aef-a3b1-e9bbd986b115", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "327fb0eb-c136-4536-8b6a-acb76ddefafe", "name": "Update a project", "request": { "name": "Update a project", "description": { "content": "Changes the fields sent; the others stay. An archived project is not checked by its schedule until it is restored.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"depth\": 100,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"group\": \"\",\n \"check_emails\": \"\",\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"webhook_url\": \"\",\n \"archived\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7a9b8310-9cb9-4df4-b533-188c24b88fb3", "name": "Project", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"depth\": 100,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"group\": \"\",\n \"check_emails\": \"\",\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"webhook_url\": \"\",\n \"archived\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"project\": {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"group\": \"\",\n \"ref\": \"\",\n \"source\": \"api\",\n \"depth\": 100,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"status\": \"checking\",\n \"archived\": \"\",\n \"keywords_count\": \"\",\n \"last_check_at\": \"\",\n \"next_check_at\": \"\",\n \"last_summaries\": {\n \"deserunt_9\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n }\n },\n \"last_skipped\": null,\n \"webhook_url\": \"\",\n \"check_emails\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91b16c22-85ed-480f-8356-27abe3547996", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"depth\": 100,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"group\": \"\",\n \"check_emails\": \"\",\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"webhook_url\": \"\",\n \"archived\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "481baadc-aa6e-46d6-be73-f53f09e59105", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"depth\": 100,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"group\": \"\",\n \"check_emails\": \"\",\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"webhook_url\": \"\",\n \"archived\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "959ac525-107c-4b03-b529-9a44f138ee53", "name": "Delete a project", "request": { "name": "Delete a project", "description": { "content": "Deletes the project with its keywords and history. A running check is stopped and its unspent tokens come back.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "5361a29e-5ee8-45ed-9459-bba9830f8ec5", "name": "Deleting", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"id\": \"\",\n \"deleting\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a24cbaf-02da-4ffa-9373-8deb400993bb", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ed013ee5-0fce-4ce7-82bd-4d0add221ac1", "name": "Act on many projects", "request": { "name": "Act on many projects", "description": { "content": "One action for up to 500 projects; each succeeds or fails on its own. `check` queues a check of every project.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"action\": \"unarchive\",\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"group\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "82a9a374-6c2e-4b2c-aa70-25a357116076", "name": "Results per project", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"action\": \"unarchive\",\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"group\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"ok\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"check_id\": \"\"\n },\n {\n \"id\": \"\",\n \"ok\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"check_id\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "50637d27-24c6-4844-99fb-d2b8f35ab8e6", "name": "Status of many projects", "request": { "name": "Status of many projects", "description": { "content": "A light status of up to 500 projects at once, for dashboards that poll.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"project_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ab1f3d2d-5c48-422c-85d2-7548d579b421", "name": "Statuses", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", "summary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"project_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"status\": \"checking\",\n \"archived\": \"\",\n \"last_check_at\": \"\",\n \"next_check_at\": \"\",\n \"last_summaries\": {}\n },\n {\n \"id\": \"\",\n \"status\": \"idle\",\n \"archived\": \"\",\n \"last_check_at\": \"\",\n \"next_check_at\": \"\",\n \"last_summaries\": {}\n }\n ],\n \"not_found\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Rank Tracker - regions", "description": "Every keyword is checked in every region of its project. A removed region keeps its history.", "item": [ { "id": "3b0666d5-b847-43e8-9c7e-d30edc95451f", "name": "Add a region", "request": { "name": "Add a region", "description": { "content": "Adds a region (keywords x 1 rows of the tracked rows limit). Adding a region the project had before brings its history back.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"desktop\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5989bd07-4cd0-45ea-918f-36d258a0f32d", "name": "Region added", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"desktop\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"region\": {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n \"project\": {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"group\": \"\",\n \"ref\": \"\",\n \"source\": \"api\",\n \"depth\": 30,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"status\": \"idle\",\n \"archived\": \"\",\n \"keywords_count\": \"\",\n \"last_check_at\": \"\",\n \"next_check_at\": \"\",\n \"last_summaries\": {\n \"sint_b\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n }\n },\n \"last_skipped\": null,\n \"webhook_url\": \"\",\n \"check_emails\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "590a9213-95a7-4d4d-adde-8f17173609ec", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"desktop\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ec148e1-9727-48dd-b4a0-c0ea808f39b2", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"desktop\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e17976c-aff6-4f92-849c-83d4c416dec6", "name": "Remove a region", "request": { "name": "Remove a region", "description": { "content": "Removes a region; its history stays. Not the project's last region (400 last_region) and not while a check runs (409).", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "regions", ":region_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "region_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "514e9e29-98f9-4771-b6e7-c255d3fbda38", "name": "Project", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "regions", ":region_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"project\": {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"group\": \"\",\n \"ref\": \"\",\n \"source\": \"api\",\n \"depth\": 100,\n \"competitors\": [\n \"\",\n \"\"\n ],\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"schedule\": {\n \"days\": [\n \"\",\n \"\"\n ],\n \"hour\": \"\",\n \"tz\": \"\"\n },\n \"status\": \"checking\",\n \"archived\": \"\",\n \"keywords_count\": \"\",\n \"last_check_at\": \"\",\n \"next_check_at\": \"\",\n \"last_summaries\": {\n \"deserunt_9\": {\n \"check_id\": \"\",\n \"at\": \"\",\n \"summary\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"change\": {}\n }\n },\n \"last_skipped\": null,\n \"webhook_url\": \"\",\n \"check_emails\": \"\",\n \"created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af88b3a3-f011-46dd-909c-ccceeddff30a", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "regions", ":region_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "375eccdb-c965-4595-9294-a4f83b728878", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "regions", ":region_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Rank Tracker - keywords and tags", "description": "Keywords are matched by text ignoring case and spaces. Tags are lowercase, up to 40 characters, at most 10 per keyword.", "item": [ { "id": "2d83b747-b705-46af-991b-24434d753905", "name": "List keywords", "request": { "name": "List keywords", "description": { "content": "The project's keywords, oldest first.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "tag", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "1000" }, { "disabled": false, "description": { "content": "next_cursor of the previous page. Opaque; only next_cursor null means the end.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bb5fddc6-c10d-489a-a08b-0450c66a0beb", "name": "A page of keywords", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "tag", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "1000" }, { "disabled": false, "description": { "content": "next_cursor of the previous page. Opaque; only next_cursor null means the end.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"q\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"target_url\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"q\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"target_url\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"total\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e6ef2a7-41fa-4e98-a27d-18a7afbee76e", "name": "Add keywords", "request": { "name": "Add keywords", "description": { "content": "Adds keywords. A keyword the project already has gets the new tags and the target_url if one is sent.\nA keyword that is too long or has a target_url on another domain is skipped and listed in errors; over a limit nothing is added (400).\n", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "579c1c00-9fed-44e7-adf4-1fdaa5c2d18a", "name": "Counts per status", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"added\": \"\",\n \"updated\": \"\",\n \"skipped\": \"\",\n \"errors\": [\n {\n \"index\": \"\",\n \"q\": \"\",\n \"error\": \"invalid_target_url\"\n },\n {\n \"index\": \"\",\n \"q\": \"\",\n \"error\": \"too_long\"\n }\n ],\n \"items\": [\n {\n \"index\": \"\",\n \"id\": \"\",\n \"q\": \"\",\n \"status\": \"added\"\n },\n {\n \"index\": \"\",\n \"id\": \"\",\n \"q\": \"\",\n \"status\": \"skipped\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43c56550-d982-40e4-bffc-21735dcfad2b", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bdf2d1be-9f44-4ce5-b6e7-9dcfe76ed7fd", "name": "Replace the keyword list", "request": { "name": "Replace the keyword list", "description": { "content": "Makes the project's keywords exactly the ones sent. Missing keywords are removed with their history. If any keyword is refused, nothing changes (400 invalid_keywords).", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "80474b86-1395-4311-9c24-f69111521414", "name": "Counts", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"added\": \"\",\n \"removed\": \"\",\n \"updated\": \"\",\n \"unchanged\": \"\",\n \"items\": [\n {\n \"index\": \"\",\n \"id\": \"\",\n \"q\": \"\",\n \"status\": \"skipped\"\n },\n {\n \"index\": \"\",\n \"id\": \"\",\n \"q\": \"\",\n \"status\": \"added\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7530669-7293-4155-9451-305135eccc51", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"keywords\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3618fbf3-83c9-444a-87ac-1c69287557a8", "name": "Edit tags and target URLs", "request": { "name": "Edit tags and target URLs", "description": { "content": "Adds or removes tags and sets the target URL of many keywords at once. The keyword text never changes.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"add_tags\": [\n \"\",\n \"\"\n ],\n \"remove_tags\": [\n \"\",\n \"\"\n ],\n \"target_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "817e75f0-3af7-4b0d-8390-5e34e40ba94f", "name": "Matched keywords", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ],\n \"add_tags\": [\n \"\",\n \"\"\n ],\n \"remove_tags\": [\n \"\",\n \"\"\n ],\n \"target_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"matched\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16cd5c16-3b3f-4137-8c93-aec80a92a8f2", "name": "Delete keywords", "request": { "name": "Delete keywords", "description": { "content": "Deletes keywords with their history.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "13d8f252-07a5-48ce-84c4-fc225b79a67f", "name": "Deleted count", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"deleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "39efc450-89d5-4371-a801-514b87feea9c", "name": "Keyword history", "request": { "name": "Keyword history", "description": { "content": "A keyword's positions and its competitors' over the region's finished checks, oldest first.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords", ":keyword_id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A current or removed region (its history stays); the project's first region by default.", "type": "text/plain" }, "key": "region_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "90" } ], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "2e994785390f910786f65cf0", "key": "keyword_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "db1e600a-8e00-4403-981a-c1ae800d69ae", "name": "History", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "keywords", ":keyword_id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A current or removed region (its history stays); the project's first region by default.", "type": "text/plain" }, "key": "region_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "90" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"region\": {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n \"items\": [\n {\n \"check_id\": \"\",\n \"at\": \"\",\n \"position\": \"\",\n \"approx\": \"\",\n \"unknown\": \"\",\n \"url\": \"\",\n \"competitors\": {\n \"eu_953\": \"\",\n \"ut_d\": \"\"\n }\n },\n {\n \"check_id\": \"\",\n \"at\": \"\",\n \"position\": \"\",\n \"approx\": \"\",\n \"unknown\": \"\",\n \"url\": \"\",\n \"competitors\": {\n \"pariatur9\": \"\",\n \"Duis_ce_\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce977bf8-ba72-486a-b9d3-a79eaa4d670b", "name": "List tags", "request": { "name": "List tags", "description": {}, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c0f95f24-9dfc-471d-8713-2f8c7e14ac71", "name": "Tags with keyword counts and colors", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"items\": [\n {\n \"tag\": \"\",\n \"count\": \"\",\n \"color\": \"\"\n },\n {\n \"tag\": \"\",\n \"count\": \"\",\n \"color\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bed1d0db-0951-4219-b583-8e79fdebbf6d", "name": "Rename a tag", "request": { "name": "Rename a tag", "description": { "content": "Renames a tag on every keyword. Renaming to an existing tag merges the two; an empty `to` removes the tag.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "tags", "rename" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e8de71c4-f4ab-4998-bedb-398a0680cfca", "name": "The project's tags", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "tags", "rename" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"to\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ce95499-54d6-4dd2-a11c-92436c984eaf", "name": "Set a tag's color", "request": { "name": "Set a tag's color", "description": {}, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "tags", "color" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\",\n \"color\": \"violet\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "831d82a6-0e89-40df-8cb0-80308e49b701", "name": "Colors by tag", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "tags", "color" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\",\n \"color\": \"violet\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"tag_colors\": {\n \"nisi_b1a\": \"\",\n \"Duis_1e9\": \"\",\n \"nostrudc77\": \"\",\n \"mollit_2\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Rank Tracker - checks", "description": "A check holds cost.max tokens when it starts and gives back what it did not spend when it ends. One check runs per project at a time.", "item": [ { "id": "7cd43658-38c1-445e-9318-e47cba1d3864", "name": "Cost of a check", "request": { "name": "Cost of a check", "description": { "content": "What the project's next check can cost, in tokens. The balance must cover cost.max.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "cost" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only this region; all regions by default", "type": "text/plain" }, "key": "region_id", "value": "" } ], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e4ad045d-3e51-4641-a296-8d9b96fc0fba", "name": "Cost", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "cost" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only this region; all regions by default", "type": "text/plain" }, "key": "region_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"cost\": {\n \"min\": \"\",\n \"max\": \"\",\n \"rows\": \"\",\n \"promo\": {\n \"discount\": \"\",\n \"until\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "513019ae-69cb-481a-9ef1-b97981e4c89e", "name": "Run a check", "request": { "name": "Run a check", "description": { "content": "Starts a check of all regions or one. Not enough tokens for cost.max returns 402 insufficient_balance; a check already running returns 409 already_running with its check_id.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "checks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"region_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "91482f9c-e3dc-4d25-9fef-439d387bd7fe", "name": "The check, queued", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "checks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"region_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"check\": {\n \"id\": \"\",\n \"project_id\": \"\",\n \"trigger\": \"queued\",\n \"source\": \"api\",\n \"status\": \"running\",\n \"error\": \"\",\n \"partial\": \"\",\n \"cancelled\": \"\",\n \"cancel_requested\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"depth\": \"\",\n \"rows\": \"\",\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"summaries\": {\n \"idd\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"esse_507\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n }\n },\n \"tokens_spent\": \"\",\n \"tokens_held\": \"\",\n \"progress\": {\n \"keywords\": \"\",\n \"wave\": \"\",\n \"wave_keywords\": \"\",\n \"wave_done\": \"\",\n \"retry\": \"\",\n \"retry_at\": \"\",\n \"failed_pages\": \"\",\n \"eta_sec\": \"\"\n },\n \"rows_expire_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59d0dd40-47f0-4155-85e7-be2b1fbccd91", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "checks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"region_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9880336d-a0dc-43b6-ab06-a5d25fa99260", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "checks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"region_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c55140b-cf57-4197-9e16-320350083507", "name": "List checks", "request": { "name": "List checks", "description": { "content": "The project's checks, newest first.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "checks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "region_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "next_cursor of the previous page. Opaque; only next_cursor null means the end.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7b7ee567-a643-4354-96df-bd8108427ce5", "name": "A page of checks", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "checks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "region_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "next_cursor of the previous page. Opaque; only next_cursor null means the end.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"project_id\": \"\",\n \"trigger\": \"manual\",\n \"source\": \"api\",\n \"status\": \"done\",\n \"error\": \"\",\n \"partial\": \"\",\n \"cancelled\": \"\",\n \"cancel_requested\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"depth\": \"\",\n \"rows\": \"\",\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"summaries\": {\n \"est07\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"ipsumd74\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n }\n },\n \"tokens_spent\": \"\",\n \"tokens_held\": \"\",\n \"progress\": null,\n \"rows_expire_at\": \"\"\n },\n {\n \"id\": \"\",\n \"project_id\": \"\",\n \"trigger\": \"schedule\",\n \"source\": \"cabinet\",\n \"status\": \"failed\",\n \"error\": \"\",\n \"partial\": \"\",\n \"cancelled\": \"\",\n \"cancel_requested\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"depth\": \"\",\n \"rows\": \"\",\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"summaries\": {\n \"ine1\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"aliquip_\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n }\n },\n \"tokens_spent\": \"\",\n \"tokens_held\": \"\",\n \"progress\": null,\n \"rows_expire_at\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3cf8923d-bae8-4628-829c-60e7a91eb7d5", "name": "Get a check", "request": { "name": "Get a check", "description": { "content": "A check with its progress while it runs. Poll every 15-60 seconds, or wait for the webhook.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "checks", ":check_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "check_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "aef3d6fb-7239-4edc-aa10-1804d6448f13", "name": "Check", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "checks", ":check_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"check\": {\n \"id\": \"\",\n \"project_id\": \"\",\n \"trigger\": \"queued\",\n \"source\": \"api\",\n \"status\": \"running\",\n \"error\": \"\",\n \"partial\": \"\",\n \"cancelled\": \"\",\n \"cancel_requested\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"depth\": \"\",\n \"rows\": \"\",\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"summaries\": {\n \"idd\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"esse_507\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n }\n },\n \"tokens_spent\": \"\",\n \"tokens_held\": \"\",\n \"progress\": {\n \"keywords\": \"\",\n \"wave\": \"\",\n \"wave_keywords\": \"\",\n \"wave_done\": \"\",\n \"retry\": \"\",\n \"retry_at\": \"\",\n \"failed_pages\": \"\",\n \"eta_sec\": \"\"\n },\n \"rows_expire_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "051cbb0a-7d3e-4bbb-9d32-2e2d38e14525", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "checks", ":check_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2209d10b-e484-4059-bbbf-e910c67ad61f", "name": "Status of many checks", "request": { "name": "Status of many checks", "description": {}, "url": { "path": [ "v2", "rank-tracker", "checks", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"check_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "010a7163-5b1d-41d1-8924-68418b73b0dc", "name": "Checks", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "checks", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"check_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"project_id\": \"\",\n \"trigger\": \"schedule\",\n \"source\": \"cabinet\",\n \"status\": \"queued\",\n \"error\": \"\",\n \"partial\": \"\",\n \"cancelled\": \"\",\n \"cancel_requested\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"depth\": \"\",\n \"rows\": \"\",\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"summaries\": {\n \"qui_c_\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"amet_4\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n }\n },\n \"tokens_spent\": \"\",\n \"tokens_held\": \"\",\n \"progress\": null,\n \"rows_expire_at\": \"\"\n },\n {\n \"id\": \"\",\n \"project_id\": \"\",\n \"trigger\": \"queued\",\n \"source\": \"cabinet\",\n \"status\": \"running\",\n \"error\": \"\",\n \"partial\": \"\",\n \"cancelled\": \"\",\n \"cancel_requested\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"depth\": \"\",\n \"rows\": \"\",\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"summaries\": {\n \"adipisicingc\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n }\n },\n \"tokens_spent\": \"\",\n \"tokens_held\": \"\",\n \"progress\": null,\n \"rows_expire_at\": \"\"\n }\n ],\n \"not_found\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d525db66-a598-4ada-a88f-3f69cd31158e", "name": "Cancel a check", "request": { "name": "Cancel a check", "description": { "content": "Stops a check. What it has checked stays (partial, cancelled); unspent tokens come back. A finished check returns 409 check_finished.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "checks", ":check_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "check_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "bdc06f8e-a945-4dc5-9480-7c6679ccb213", "name": "The check, cancel_requested true", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "checks", ":check_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"check\": {\n \"id\": \"\",\n \"project_id\": \"\",\n \"trigger\": \"queued\",\n \"source\": \"api\",\n \"status\": \"running\",\n \"error\": \"\",\n \"partial\": \"\",\n \"cancelled\": \"\",\n \"cancel_requested\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"depth\": \"\",\n \"rows\": \"\",\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"summaries\": {\n \"idd\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"esse_507\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n }\n },\n \"tokens_spent\": \"\",\n \"tokens_held\": \"\",\n \"progress\": {\n \"keywords\": \"\",\n \"wave\": \"\",\n \"wave_keywords\": \"\",\n \"wave_done\": \"\",\n \"retry\": \"\",\n \"retry_at\": \"\",\n \"failed_pages\": \"\",\n \"eta_sec\": \"\"\n },\n \"rows_expire_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f17584e-b456-4e32-b20d-4721ca73a734", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "checks", ":check_id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Rank Tracker - results", "description": "Positions, trends, keyword details with AI Overview data, and exports. Positions are kept for 365 days.", "item": [ { "id": "d4ca4d55-d035-4d8f-a6b4-5ff606a12a14", "name": "Positions", "request": { "name": "Positions", "description": { "content": "Every keyword's result in a check and region, with the change against the region's previous check. The latest finished check by default.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "positions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A current or removed region (its history stays); the project's first region by default.", "type": "text/plain" }, "key": "region_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "check_id", "value": "latest" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "tag", "value": "" }, { "disabled": false, "description": { "content": "Only keywords that moved this way", "type": "text/plain" }, "key": "changed_only", "value": "new" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "500" }, { "disabled": false, "description": { "content": "next_cursor of the previous page. Opaque; only next_cursor null means the end.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ee13b6fe-c7b0-47b9-9d03-0b53563a6951", "name": "A page of positions", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "positions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A current or removed region (its history stays); the project's first region by default.", "type": "text/plain" }, "key": "region_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "check_id", "value": "latest" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "tag", "value": "" }, { "disabled": false, "description": { "content": "Only keywords that moved this way", "type": "text/plain" }, "key": "changed_only", "value": "new" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "500" }, { "disabled": false, "description": { "content": "next_cursor of the previous page. Opaque; only next_cursor null means the end.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"check\": {\n \"id\": \"\",\n \"project_id\": \"\",\n \"trigger\": \"queued\",\n \"source\": \"cabinet\",\n \"status\": \"done\",\n \"error\": \"\",\n \"partial\": \"\",\n \"cancelled\": \"\",\n \"cancel_requested\": \"\",\n \"created_at\": \"\",\n \"started_at\": \"\",\n \"finished_at\": \"\",\n \"depth\": \"\",\n \"rows\": \"\",\n \"regions\": [\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n }\n ],\n \"summaries\": {\n \"Duis374\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"incididunt_cff\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n \"et_\": {\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n }\n },\n \"tokens_spent\": \"\",\n \"tokens_held\": \"\",\n \"progress\": {\n \"keywords\": \"\",\n \"wave\": \"\",\n \"wave_keywords\": \"\",\n \"wave_done\": \"\",\n \"retry\": \"\",\n \"retry_at\": \"\",\n \"failed_pages\": \"\",\n \"eta_sec\": \"\"\n },\n \"rows_expire_at\": \"\"\n },\n \"region\": {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n \"items\": [\n {\n \"keyword_id\": \"\",\n \"q\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"target_url\": \"\",\n \"status\": \"pending\",\n \"position\": \"\",\n \"found\": \"\",\n \"unknown\": \"\",\n \"approx\": \"\",\n \"url\": \"\",\n \"urls\": [\n {\n \"url\": \"\",\n \"position\": \"\"\n },\n {\n \"url\": \"\",\n \"position\": \"\"\n }\n ],\n \"prev_position\": \"\",\n \"prev_found\": \"\",\n \"change\": \"\",\n \"movement\": \"down\",\n \"competitors\": null,\n \"features\": null,\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"snippet_own\": \"\",\n \"snippet_owner\": \"\",\n \"wrong_url\": \"\",\n \"cannibal\": \"\",\n \"compact\": \"\"\n },\n {\n \"keyword_id\": \"\",\n \"q\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"target_url\": \"\",\n \"status\": \"not_checked\",\n \"position\": \"\",\n \"found\": \"\",\n \"unknown\": \"\",\n \"approx\": \"\",\n \"url\": \"\",\n \"urls\": null,\n \"prev_position\": \"\",\n \"prev_found\": \"\",\n \"change\": \"\",\n \"movement\": null,\n \"competitors\": {},\n \"features\": null,\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"snippet_own\": \"\",\n \"snippet_owner\": \"\",\n \"wrong_url\": \"\",\n \"cannibal\": \"\",\n \"compact\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1fbf63e-418f-4331-bf1c-fb7a684e5514", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "positions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A current or removed region (its history stays); the project's first region by default.", "type": "text/plain" }, "key": "region_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "check_id", "value": "latest" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "tag", "value": "" }, { "disabled": false, "description": { "content": "Only keywords that moved this way", "type": "text/plain" }, "key": "changed_only", "value": "new" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "500" }, { "disabled": false, "description": { "content": "next_cursor of the previous page. Opaque; only next_cursor null means the end.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Gone", "code": 410, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3727b5c1-de15-4607-a75a-61ef1d13376b", "name": "Trend", "request": { "name": "Trend", "description": { "content": "A region's summary over its last 90 finished checks, oldest first.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "trend" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A current or removed region (its history stays); the project's first region by default.", "type": "text/plain" }, "key": "region_id", "value": "" } ], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "431f5a75-7627-4e80-98e8-0b1b92836d61", "name": "Trend", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "trend" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A current or removed region (its history stays); the project's first region by default.", "type": "text/plain" }, "key": "region_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"region\": {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n \"items\": [\n {\n \"check_id\": \"\",\n \"at\": \"\",\n \"partial\": \"\",\n \"depth\": \"\",\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n },\n {\n \"check_id\": \"\",\n \"at\": \"\",\n \"partial\": \"\",\n \"depth\": \"\",\n \"total\": \"\",\n \"known\": \"\",\n \"found\": \"\",\n \"visibility\": \"\",\n \"avg_position\": \"\",\n \"top3\": \"\",\n \"top10\": \"\",\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"distribution\": {\n \"top3\": \"\",\n \"top10\": \"\",\n \"top20\": \"\",\n \"top50\": \"\",\n \"top100\": \"\",\n \"not_found\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc31028c-3ca4-46e3-b67a-16a43cdb0a4d", "name": "Keyword in a check", "request": { "name": "Keyword in a check", "description": { "content": "One keyword's result in a finished check with the top 10 domains and the AI Overview (sources, whether the site is cited and how). The full overview text (blocks) is kept for the region's latest check only.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "checks", ":check_id", "keywords", ":keyword_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A current or removed region (its history stays); the project's first region by default.", "type": "text/plain" }, "key": "region_id", "value": "" } ], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "check_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "2e994785390f910786f65cf0", "key": "keyword_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a172689e-7841-4128-b5a0-bd24e8f253cb", "name": "Keyword result", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "checks", ":check_id", "keywords", ":keyword_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "A current or removed region (its history stays); the project's first region by default.", "type": "text/plain" }, "key": "region_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"check_id\": \"\",\n \"region\": {\n \"id\": \"\",\n \"location\": \"\",\n \"gl\": \"\",\n \"device\": \"\",\n \"google_domain\": \"\",\n \"label\": \"\"\n },\n \"keyword\": {\n \"keyword_id\": \"\",\n \"q\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"target_url\": \"\",\n \"status\": \"not_checked\",\n \"position\": \"\",\n \"found\": \"\",\n \"unknown\": \"\",\n \"approx\": \"\",\n \"url\": \"\",\n \"urls\": null,\n \"prev_position\": \"\",\n \"prev_found\": \"\",\n \"change\": \"\",\n \"movement\": \"new\",\n \"competitors\": {},\n \"features\": null,\n \"ai_present\": \"\",\n \"ai_cited\": \"\",\n \"snippet_own\": \"\",\n \"snippet_owner\": \"\",\n \"wrong_url\": \"\",\n \"cannibal\": \"\",\n \"compact\": \"\",\n \"top10\": [\n \"\",\n \"\"\n ]\n },\n \"ai_overview\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44d5f823-fcf4-4287-8db6-2bfca67513db", "name": "Export positions", "request": { "name": "Export positions", "description": { "content": "All positions of a check and region in one streamed file, CSV (UTF-8 with BOM) or JSON. At most 2 exports at once per account (429 too_many_heavy_requests).", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "format", "value": "csv" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "check_id", "value": "" }, { "disabled": false, "description": { "content": "A current or removed region (its history stays); the project's first region by default.", "type": "text/plain" }, "key": "region_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "tag", "value": "" } ], "variable": [ { "type": "any", "value": "2e994785390f910786f65cf0", "key": "project_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2ced77d9-07cf-480e-b8d4-bd8b98073057", "name": "The export file", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "format", "value": "csv" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "check_id", "value": "" }, { "disabled": false, "description": { "content": "A current or removed region (its history stays); the project's first region by default.", "type": "text/plain" }, "key": "region_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "tag", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04a7ff0d-9d78-4404-a7d0-d428921b7005", "name": "Rank Tracker error. `error` is a stable name to branch on, for example invalid_domain, projects_limit,\narchived, no_api_key, invalid_api_key, insufficient_balance, project_not_found, already_running,\nref_conflict, ref_in_progress, check_finished, rows_expired, body_too_large, rate_limited,\ntoo_many_heavy_requests, internal_error, serp_unavailable.\n", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "projects", ":project_id", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "format", "value": "csv" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "check_id", "value": "" }, { "disabled": false, "description": { "content": "A current or removed region (its history stays); the project's first region by default.", "type": "text/plain" }, "key": "region_id", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "tag", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"error\": \"\",\n \"message\": \"\",\n \"incididunt_3\": \"eiusmod adipisicing eu\",\n \"id_d9\": false,\n \"reprehenderitf0\": false,\n \"mollit_6\": -94805507\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Rank Tracker - webhooks", "description": "One webhook URL per account gets the events of all projects; a project's own webhook_url gets that project's events instead.", "item": [ { "id": "d535d815-61b8-4248-82f6-c8d6a1069123", "name": "Get the webhook", "request": { "name": "Get the webhook", "description": {}, "url": { "path": [ "v2", "rank-tracker", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "585d7e3c-6992-471a-b7ed-351d824cc3e4", "name": "The account webhook", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"webhook\": {\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"has_secret\": \"\",\n \"previous_secret_valid_until\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef4cf330-c763-4aa3-acf1-c098f0b6f595", "name": "Set the webhook", "request": { "name": "Set the webhook", "description": { "content": "Sets the URL and events. The first time, the response has the signing `secret`; store it, it is not shown again.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"check.skipped\",\n \"check.skipped\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "31a3169e-7f13-4020-afe4-496ebc70aa2f", "name": "Webhook (and the secret the first time)", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"check.skipped\",\n \"check.skipped\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"webhook\": {\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"has_secret\": \"\",\n \"previous_secret_valid_until\": \"\"\n },\n \"secret\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e513746-25c5-4731-a276-7381a2d91c55", "name": "Remove the webhook", "request": { "name": "Remove the webhook", "description": { "content": "Stops the account's events. Projects with their own webhook_url still get theirs. The secret stays.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "207a3e23-0590-46a8-bab5-f5cbaf6ba0bb", "name": "Webhook", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"webhook\": {\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"has_secret\": \"\",\n \"previous_secret_valid_until\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f13d7cbf-e14d-4f1f-a73b-113f3835bc32", "name": "Rotate the secret", "request": { "name": "Rotate the secret", "description": { "content": "Makes a new signing secret. For 24 hours events are signed with both, newest first.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "webhook", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "d6b06fd8-bf37-4cd3-9de2-b62b820836dc", "name": "New secret", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "webhook", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"webhook\": {\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"has_secret\": \"\",\n \"previous_secret_valid_until\": \"\"\n },\n \"secret\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d022bfb7-bc4f-4c79-beca-87957785a705", "name": "Send a test event", "request": { "name": "Send a test event", "description": { "content": "Sends a signed webhook.test event now and returns how your server replied.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "webhook", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fd641e3a-42c8-4bd7-926c-9257d9f112ee", "name": "Delivery result", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "webhook", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"delivery\": {\n \"id\": \"\",\n \"event_id\": \"\",\n \"url\": \"\",\n \"ok\": \"\",\n \"status\": \"\",\n \"error\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ea0a52d-f2fc-4e0e-8cc4-43990d65e4e9", "name": "Deliveries", "request": { "name": "Deliveries", "description": { "content": "Events sent in the last 7 days, newest first, with their state.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "webhook", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "next_cursor of the previous page. Opaque; only next_cursor null means the end.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f5eff3f3-b19d-4637-9f16-82b79ae1b487", "name": "A page of deliveries", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "webhook", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "next_cursor of the previous page. Opaque; only next_cursor null means the end.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"event\": \"\",\n \"url\": \"\",\n \"state\": \"done\",\n \"attempts\": \"\",\n \"last_status\": \"\",\n \"last_error\": \"\",\n \"created_at\": \"\",\n \"delivered_at\": \"\",\n \"next_at\": \"\",\n \"project_id\": \"\",\n \"check_id\": \"\",\n \"payload\": {}\n },\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"event\": \"\",\n \"url\": \"\",\n \"state\": \"done\",\n \"attempts\": \"\",\n \"last_status\": \"\",\n \"last_error\": \"\",\n \"created_at\": \"\",\n \"delivered_at\": \"\",\n \"next_at\": \"\",\n \"project_id\": \"\",\n \"check_id\": \"\",\n \"payload\": {}\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6cfe2ff7-33e5-483f-b376-0506c2086f97", "name": "Send a delivery again", "request": { "name": "Send a delivery again", "description": { "content": "Sends an event again with the same event_id; retries start anew.", "type": "text/plain" }, "url": { "path": [ "v2", "rank-tracker", "webhook", "deliveries", ":delivery_id", "redeliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "delivery_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "ffd65db2-5db9-4cb2-bf24-681fc8edb744", "name": "Queued", "originalRequest": { "url": { "path": [ "v2", "rank-tracker", "webhook", "deliveries", ":delivery_id", "redeliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"id\": \"\",\n \"state\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "Authorization", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.speedyindex.com" }, { "key": "apiKey", "value": "", "type": "string", "description": "Your SpeedyIndex API key (API section of the dashboard)" } ], "info": { "_postman_id": "eec842c9-5d55-4e8b-8a9c-3dd68b664a97", "name": "SpeedyIndex API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "SpeedyIndex API v2 lets you submit URLs for indexing in Google and Yandex, check whether URLs are indexed\nin Google, Yandex and Bing, check donor pages for backlinks, and track Google rankings and AI Overview\ncitations with the Rank Tracker.\n\n**Authentication.** Send your API key in the `Authorization` header as it is, without `Bearer`.\nCopy the key from the API section of your SpeedyIndex dashboard. POST, PUT and PATCH requests send JSON\nwith `Content-Type: application/json`.\n\n**Responses.** Every response has a numeric `code`: `0` means success. Indexing endpoints use\n`1` insufficient balance or not found, `2` validation error, `3` rate limit or server error.\nRank Tracker errors also have `error` (a stable machine-readable name) and `message`.\n\n**Rate limits.** Indexing, checking and backlink endpoints: 120 requests per minute per IP address.\nRank Tracker: per API key, 600 reads (GET) and 120 writes a minute, at most 8 requests at once.\nOver a limit you get HTTP 429 with `Retry-After`.\n\n**Prices.** Google indexing runs in Pay per Indexed mode: 100 tokens per URL, 100% refund for URLs not\nindexed after 7 days. Yandex indexing: 20 tokens per URL, Pay per Indexed always on, refund after 15 days.\nA Rank Tracker check costs tokens per loaded results page; read current prices from `GET /v2/rank-tracker/limits`.\n\nSource: the official SpeedyIndex API documentation, https://app.speedyindex.com/Documentation.pdf", "type": "text/markdown" } } }