{ "uuid": "674e5e3a-e9cb-4c74-b060-276833c0a64d", "lastMigration": 29, "name": "SheerSEO API", "endpointPrefix": "seo/api", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "e278ffec-6a33-44a9-a6c3-8cc1d1899265", "documentation": "Submit serp jobs", "method": "post", "endpoint": "rank-collect", "responses": [ { "uuid": "c985be11-3036-4b78-acc1-dbe28c0182f9", "body": "{\n \"tasks\": [\n {\n \"task_id\": {\n \"error_message\": \"\",\n \"keyword\": \"seo software\",\n \"local_pack_rank\": 1,\n \"localization_code\": \"{{oneOf (array 'us' 'uk' 'au' 'br' 'be_dutch' 'be_french' 'ca' 'de' 'es' 'ie' 'il' 'nl' 'sg' 'za' 'it' 'is' 'ch' 'fr' 'se' 'at' 'dk' 'nz' 'gr' 'no' 'in' 'ms' 'pl' 'hk' 'id' 'ru' 'ae' 'fi' 'pt' 'mx' 'tr' 'cl' 'jp' 'ar')}}\",\n \"localization_zip\": \"\",\n \"rank\": 1,\n \"ready\": \"{{oneOf (array 'true' 'false')}}\",\n \"search_engine\": \"{{oneOf (array 'google' 'bing' 'google_mobile')}}\",\n \"status\": \"{{oneOf (array 'ok' 'invalid')}}\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7cda08a7-7052-457f-bdc2-48eb3882f4fa", "body": "{\n \"error_message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c9cb82ff-7640-4f1f-8eae-e032efd3bbfa", "body": "{\n \"error_message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "18311b2e-8208-497b-b6b0-fd9c9cb2f71a", "body": "{\n \"error_message\": \"\"\n}", "latency": 0, "statusCode": 503, "label": "Server Overload", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fecd66ea-5086-464d-b432-2d36b6e2e281", "documentation": "Submit rank jobs", "method": "post", "endpoint": "rank-submit", "responses": [ { "uuid": "3f419f25-c03a-4b30-8e18-79d5728cbfb7", "body": "{\n \"error_message\": \"\",\n \"response_code\": 200,\n \"tasks\": [\n {\n \"keyword\": \"seo software\",\n \"localization_code\": \"{{oneOf (array 'us' 'uk' 'au' 'br' 'be_dutch' 'be_french' 'ca' 'de' 'es' 'ie' 'il' 'nl' 'sg' 'za' 'it' 'is' 'ch' 'fr' 'se' 'at' 'dk' 'nz' 'gr' 'no' 'in' 'ms' 'pl' 'hk' 'id' 'ru' 'ae' 'fi' 'pt' 'mx' 'tr' 'cl' 'jp' 'ar')}}\",\n \"localization_zip\": 90210,\n \"search_engine\": \"{{oneOf (array 'google' 'bing' 'google_mobile')}}\",\n \"status\": \"{{oneOf (array 'ok' 'invalid')}}\",\n \"task_id\": \"16ad9957b23x140753\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "226b103a-c3e1-403e-a621-a675d3b3c6e8", "body": "{\n \"error_message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9f54f4a3-15b9-4145-bb4e-743eadda18e3", "body": "{\n \"error_message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5532a888-d04a-4817-aed9-3fbf4702483b", "body": "{\n \"error_message\": \"\"\n}", "latency": 0, "statusCode": 503, "label": "Server Overload", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b6119bc2-203b-430b-ae2f-6a74095a8a97", "documentation": "Submit serp jobs", "method": "post", "endpoint": "serp-collect", "responses": [ { "uuid": "111161d1-22ff-4aa2-a46b-e2a6e25e20e7", "body": "{\n \"tasks\": [\n {\n \"task_id\": {\n \"error_message\": \"\",\n \"keyword\": \"seo software\",\n \"localization_code\": \"{{oneOf (array 'us' 'uk' 'au' 'br' 'be_dutch' 'be_french' 'ca' 'de' 'es' 'ie' 'il' 'nl' 'sg' 'za' 'it' 'is' 'ch' 'fr' 'se' 'at' 'dk' 'nz' 'gr' 'no' 'in' 'ms' 'pl' 'hk' 'id' 'ru' 'ae' 'fi' 'pt' 'mx' 'tr' 'cl' 'jp' 'ar')}}\",\n \"localization_zip\": \"\",\n \"num_results\": 100,\n \"organic_results\": [\n {\n \"rank\": 1,\n \"url\": \"www.sheerseo.com\"\n }\n ],\n \"ready\": \"{{oneOf (array 'true' 'false')}}\",\n \"search_engine\": \"google\",\n \"status\": \"{{oneOf (array 'ok' 'invalid')}}\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9fdac7e2-f7de-4373-8ee3-11f8f68f2f28", "body": "{\n \"error_message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ffa2626e-3189-4579-9e13-e9b755b03c49", "body": "{\n \"error_message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0a119ea6-bb06-467c-9336-7560d9aa16cb", "body": "{\n \"error_message\": \"\"\n}", "latency": 0, "statusCode": 503, "label": "Server Overload", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "33a975ae-d410-423c-8eca-41f22a28a635", "documentation": "Submit serp jobs", "method": "post", "endpoint": "serp-submit", "responses": [ { "uuid": "9e3a1d0a-6d33-45cc-8016-3dfa8afba13d", "body": "{\n \"error_message\": \"\",\n \"response_code\": 200,\n \"tasks\": [\n {\n \"keyword\": \"seo software\",\n \"localization_code\": \"{{oneOf (array 'us' 'uk' 'au' 'br' 'be_dutch' 'be_french' 'ca' 'de' 'es' 'ie' 'il' 'nl' 'sg' 'za' 'it' 'is' 'ch' 'fr' 'se' 'at' 'dk' 'nz' 'gr' 'no' 'in' 'ms' 'pl' 'hk' 'id' 'ru' 'ae' 'fi' 'pt' 'mx' 'tr' 'cl' 'jp' 'ar')}}\",\n \"localization_zip\": 90210,\n \"search_engine\": \"{{oneOf (array 'google' 'bing' 'google_mobile')}}\",\n \"status\": \"{{oneOf (array 'ok' 'invalid')}}\",\n \"task_id\": \"16ad9957b23x140753\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "58f93170-509d-4786-9a0f-b12c7d904c3b", "body": "{\n \"error_message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "930b3a4a-7baf-47a7-b580-dd42b4390adb", "body": "{\n \"error_message\": \"\"\n}", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fcbb632f-b311-40d6-9a7a-0fcefd575f49", "body": "{\n \"error_message\": \"\"\n}", "latency": 0, "statusCode": 503, "label": "Server Overload", "headers": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "e278ffec-6a33-44a9-a6c3-8cc1d1899265" }, { "type": "route", "uuid": "fecd66ea-5086-464d-b432-2d36b6e2e281" }, { "type": "route", "uuid": "b6119bc2-203b-430b-ae2f-6a74095a8a97" }, { "type": "route", "uuid": "33a975ae-d410-423c-8eca-41f22a28a635" } ] }