{ "uuid": "f4bd95b6-6ef7-4e80-9ef4-714152c1b597", "lastMigration": 29, "name": "Google Search Console API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "f3abae27-a292-4f36-bb43-8ddb42699182", "documentation": "Index inspection.", "method": "post", "endpoint": "v1/urlInspection/index:inspect", "responses": [ { "uuid": "15378713-3e3b-4fa5-9b7a-c46905f9daee", "body": "{\n \"inspectionResult\": {\n \"ampResult\": {\n \"ampIndexStatusVerdict\": \"{{oneOf (array 'VERDICT_UNSPECIFIED' 'PASS' 'PARTIAL' 'FAIL' 'NEUTRAL')}}\",\n \"ampUrl\": \"\",\n \"indexingState\": \"{{oneOf (array 'AMP_INDEXING_STATE_UNSPECIFIED' 'AMP_INDEXING_ALLOWED' 'BLOCKED_DUE_TO_NOINDEX' 'BLOCKED_DUE_TO_EXPIRED_UNAVAILABLE_AFTER')}}\",\n \"issues\": [\n {\n \"issueMessage\": \"\",\n \"severity\": \"{{oneOf (array 'SEVERITY_UNSPECIFIED' 'WARNING' 'ERROR')}}\"\n }\n ],\n \"lastCrawlTime\": \"\",\n \"pageFetchState\": \"{{oneOf (array 'PAGE_FETCH_STATE_UNSPECIFIED' 'SUCCESSFUL' 'SOFT_404' 'BLOCKED_ROBOTS_TXT' 'NOT_FOUND' 'ACCESS_DENIED' 'SERVER_ERROR' 'REDIRECT_ERROR' 'ACCESS_FORBIDDEN' 'BLOCKED_4XX' 'INTERNAL_CRAWL_ERROR' 'INVALID_URL')}}\",\n \"robotsTxtState\": \"{{oneOf (array 'ROBOTS_TXT_STATE_UNSPECIFIED' 'ALLOWED' 'DISALLOWED')}}\",\n \"verdict\": \"{{oneOf (array 'VERDICT_UNSPECIFIED' 'PASS' 'PARTIAL' 'FAIL' 'NEUTRAL')}}\"\n },\n \"indexStatusResult\": {\n \"coverageState\": \"\",\n \"crawledAs\": \"{{oneOf (array 'CRAWLING_USER_AGENT_UNSPECIFIED' 'DESKTOP' 'MOBILE')}}\",\n \"googleCanonical\": \"\",\n \"indexingState\": \"{{oneOf (array 'INDEXING_STATE_UNSPECIFIED' 'INDEXING_ALLOWED' 'BLOCKED_BY_META_TAG' 'BLOCKED_BY_HTTP_HEADER' 'BLOCKED_BY_ROBOTS_TXT')}}\",\n \"lastCrawlTime\": \"\",\n \"pageFetchState\": \"{{oneOf (array 'PAGE_FETCH_STATE_UNSPECIFIED' 'SUCCESSFUL' 'SOFT_404' 'BLOCKED_ROBOTS_TXT' 'NOT_FOUND' 'ACCESS_DENIED' 'SERVER_ERROR' 'REDIRECT_ERROR' 'ACCESS_FORBIDDEN' 'BLOCKED_4XX' 'INTERNAL_CRAWL_ERROR' 'INVALID_URL')}}\",\n \"referringUrls\": [\n \"\"\n ],\n \"robotsTxtState\": \"{{oneOf (array 'ROBOTS_TXT_STATE_UNSPECIFIED' 'ALLOWED' 'DISALLOWED')}}\",\n \"sitemap\": [\n \"\"\n ],\n \"userCanonical\": \"\",\n \"verdict\": \"{{oneOf (array 'VERDICT_UNSPECIFIED' 'PASS' 'PARTIAL' 'FAIL' 'NEUTRAL')}}\"\n },\n \"inspectionResultLink\": \"\",\n \"mobileUsabilityResult\": {\n \"issues\": [\n {\n \"issueType\": \"{{oneOf (array 'MOBILE_USABILITY_ISSUE_TYPE_UNSPECIFIED' 'USES_INCOMPATIBLE_PLUGINS' 'CONFIGURE_VIEWPORT' 'FIXED_WIDTH_VIEWPORT' 'SIZE_CONTENT_TO_VIEWPORT' 'USE_LEGIBLE_FONT_SIZES' 'TAP_TARGETS_TOO_CLOSE')}}\",\n \"message\": \"\",\n \"severity\": \"{{oneOf (array 'SEVERITY_UNSPECIFIED' 'WARNING' 'ERROR')}}\"\n }\n ],\n \"verdict\": \"{{oneOf (array 'VERDICT_UNSPECIFIED' 'PASS' 'PARTIAL' 'FAIL' 'NEUTRAL')}}\"\n },\n \"richResultsResult\": {\n \"detectedItems\": [\n {\n \"items\": [\n {\n \"issues\": [\n {\n \"issueMessage\": \"\",\n \"severity\": \"{{oneOf (array 'SEVERITY_UNSPECIFIED' 'WARNING' 'ERROR')}}\"\n }\n ],\n \"name\": \"\"\n }\n ],\n \"richResultType\": \"\"\n }\n ],\n \"verdict\": \"{{oneOf (array 'VERDICT_UNSPECIFIED' 'PASS' 'PARTIAL' 'FAIL' 'NEUTRAL')}}\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b8f0ade3-2b05-4508-89a2-81b6619526a9", "documentation": "Runs Mobile-Friendly Test for a given URL.", "method": "post", "endpoint": "v1/urlTestingTools/mobileFriendlyTest:run", "responses": [ { "uuid": "40a8fb09-10b3-4e3e-a0e0-2f1a441ee02a", "body": "{\n \"mobileFriendliness\": \"{{oneOf (array 'MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED' 'MOBILE_FRIENDLY' 'NOT_MOBILE_FRIENDLY')}}\",\n \"mobileFriendlyIssues\": [\n {\n \"rule\": \"{{oneOf (array 'MOBILE_FRIENDLY_RULE_UNSPECIFIED' 'USES_INCOMPATIBLE_PLUGINS' 'CONFIGURE_VIEWPORT' 'FIXED_WIDTH_VIEWPORT' 'SIZE_CONTENT_TO_VIEWPORT' 'USE_LEGIBLE_FONT_SIZES' 'TAP_TARGETS_TOO_CLOSE')}}\"\n }\n ],\n \"resourceIssues\": [\n {\n \"blockedResource\": {\n \"url\": \"\"\n }\n }\n ],\n \"screenshot\": {\n \"data\": \"\",\n \"mimeType\": \"\"\n },\n \"testStatus\": {\n \"details\": \"\",\n \"status\": \"{{oneOf (array 'TEST_STATUS_UNSPECIFIED' 'COMPLETE' 'INTERNAL_ERROR' 'PAGE_UNREACHABLE')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e5f0a551-69d6-48f3-933d-c353502f3d4d", "documentation": " Lists the user's Search Console sites.", "method": "get", "endpoint": "webmasters/v3/sites", "responses": [ { "uuid": "a8420256-4b7b-43f3-a0c7-358f2d370d0d", "body": "{\n \"siteEntry\": [\n {\n \"permissionLevel\": \"{{oneOf (array 'SITE_PERMISSION_LEVEL_UNSPECIFIED' 'SITE_OWNER' 'SITE_FULL_USER' 'SITE_RESTRICTED_USER' 'SITE_UNVERIFIED_USER')}}\",\n \"siteUrl\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b36c95b5-9628-4efe-bb3d-82c2dd8a076e", "documentation": " Removes a site from the set of the user's Search Console sites.", "method": "delete", "endpoint": "webmasters/v3/sites/:siteUrl", "responses": [ { "uuid": "069264b2-6fb0-4bf8-8472-15139d748cb9", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4659265b-bb76-434d-8ff3-395a4d93bdfe", "documentation": " Retrieves information about specific site.", "method": "get", "endpoint": "webmasters/v3/sites/:siteUrl", "responses": [ { "uuid": "9570ae3a-45df-4e9c-8a89-7303e63deaed", "body": "{\n \"permissionLevel\": \"{{oneOf (array 'SITE_PERMISSION_LEVEL_UNSPECIFIED' 'SITE_OWNER' 'SITE_FULL_USER' 'SITE_RESTRICTED_USER' 'SITE_UNVERIFIED_USER')}}\",\n \"siteUrl\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "50ac302a-cf5b-4ad6-8164-5301521fb50b", "documentation": " Adds a site to the set of the user's sites in Search Console.", "method": "put", "endpoint": "webmasters/v3/sites/:siteUrl", "responses": [ { "uuid": "f6b42298-7099-4a4c-a91a-db0b261b40bc", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b4172754-d427-4cd3-a610-66e3effd53c1", "documentation": "Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days. When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.", "method": "post", "endpoint": "webmasters/v3/sites/:siteUrl/searchAnalytics/query", "responses": [ { "uuid": "7457c05b-3699-4e67-8474-c48861eada37", "body": "{\n \"responseAggregationType\": \"{{oneOf (array 'AUTO' 'BY_PROPERTY' 'BY_PAGE')}}\",\n \"rows\": [\n {\n \"clicks\": {{faker 'number.float'}},\n \"ctr\": {{faker 'number.float'}},\n \"impressions\": {{faker 'number.float'}},\n \"keys\": [\n \"\"\n ],\n \"position\": {{faker 'number.float'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "155b5438-9abe-4071-a233-d105875ab876", "documentation": " Lists the [sitemaps-entries](/webmaster-tools/v3/sitemaps) submitted for this site, or included in the sitemap index file (if `sitemapIndex` is specified in the request).", "method": "get", "endpoint": "webmasters/v3/sites/:siteUrl/sitemaps", "responses": [ { "uuid": "5e5e67c6-9a6e-46f6-abc1-81c1a8b890c2", "body": "{\n \"sitemap\": [\n {\n \"contents\": [\n {\n \"indexed\": \"\",\n \"submitted\": \"\",\n \"type\": \"{{oneOf (array 'WEB' 'IMAGE' 'VIDEO' 'NEWS' 'MOBILE' 'ANDROID_APP' 'PATTERN' 'IOS_APP' 'DATA_FEED_ELEMENT')}}\"\n }\n ],\n \"errors\": \"\",\n \"isPending\": {{faker 'datatype.boolean'}},\n \"isSitemapsIndex\": {{faker 'datatype.boolean'}},\n \"lastDownloaded\": \"\",\n \"lastSubmitted\": \"\",\n \"path\": \"\",\n \"type\": \"{{oneOf (array 'NOT_SITEMAP' 'URL_LIST' 'SITEMAP' 'RSS_FEED' 'ATOM_FEED' 'PATTERN_SITEMAP' 'OCEANFRONT')}}\",\n \"warnings\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e0f745d2-9963-4c05-a0c1-839cfd01afc2", "documentation": "Deletes a sitemap from the Sitemaps report. Does not stop Google from crawling this sitemap or the URLs that were previously crawled in the deleted sitemap.", "method": "delete", "endpoint": "webmasters/v3/sites/:siteUrl/sitemaps/:feedpath", "responses": [ { "uuid": "7f756f71-4a13-44fa-b8b1-dc2f56a26e34", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3aeeb1ee-30ec-46ac-af03-1b8f31fb95c4", "documentation": "Retrieves information about a specific sitemap.", "method": "get", "endpoint": "webmasters/v3/sites/:siteUrl/sitemaps/:feedpath", "responses": [ { "uuid": "3291a6b7-cb48-4f45-856f-bf7d688dad99", "body": "{\n \"contents\": [\n {\n \"indexed\": \"\",\n \"submitted\": \"\",\n \"type\": \"{{oneOf (array 'WEB' 'IMAGE' 'VIDEO' 'NEWS' 'MOBILE' 'ANDROID_APP' 'PATTERN' 'IOS_APP' 'DATA_FEED_ELEMENT')}}\"\n }\n ],\n \"errors\": \"\",\n \"isPending\": {{faker 'datatype.boolean'}},\n \"isSitemapsIndex\": {{faker 'datatype.boolean'}},\n \"lastDownloaded\": \"\",\n \"lastSubmitted\": \"\",\n \"path\": \"\",\n \"type\": \"{{oneOf (array 'NOT_SITEMAP' 'URL_LIST' 'SITEMAP' 'RSS_FEED' 'ATOM_FEED' 'PATTERN_SITEMAP' 'OCEANFRONT')}}\",\n \"warnings\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "000d71b0-f483-44bb-83ec-c0bfeb892214", "documentation": "Submits a sitemap for a site.", "method": "put", "endpoint": "webmasters/v3/sites/:siteUrl/sitemaps/:feedpath", "responses": [ { "uuid": "4c8a0283-42df-40a2-bd80-34133486792b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "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": "f3abae27-a292-4f36-bb43-8ddb42699182" }, { "type": "route", "uuid": "b8f0ade3-2b05-4508-89a2-81b6619526a9" }, { "type": "route", "uuid": "e5f0a551-69d6-48f3-933d-c353502f3d4d" }, { "type": "route", "uuid": "b36c95b5-9628-4efe-bb3d-82c2dd8a076e" }, { "type": "route", "uuid": "4659265b-bb76-434d-8ff3-395a4d93bdfe" }, { "type": "route", "uuid": "50ac302a-cf5b-4ad6-8164-5301521fb50b" }, { "type": "route", "uuid": "b4172754-d427-4cd3-a610-66e3effd53c1" }, { "type": "route", "uuid": "155b5438-9abe-4071-a233-d105875ab876" }, { "type": "route", "uuid": "e0f745d2-9963-4c05-a0c1-839cfd01afc2" }, { "type": "route", "uuid": "3aeeb1ee-30ec-46ac-af03-1b8f31fb95c4" }, { "type": "route", "uuid": "000d71b0-f483-44bb-83ec-c0bfeb892214" } ] }