{
  "url": "https://telipot.com/catalog/capabilities/search-console.sitemaps.get",
  "id": "search-console.sitemaps.get",
  "description": "One sitemap's status, errors, warnings and submitted URLs",
  "platform": "search-console",
  "providers": [
    {
      "slug": "google-search-console",
      "name": "Google Search Console"
    }
  ],
  "tasks": 1,
  "taskPages": [
    {
      "id": "google-search-console.sitemaps.get",
      "name": "One sitemap's status, errors and warnings by its URL",
      "provider": {
        "slug": "google-search-console",
        "name": "Google Search Console"
      },
      "capability": "search-console.sitemaps.get",
      "platform": "search-console",
      "kind": "data",
      "tier": "core",
      "identity": "account",
      "identityLabel": "Company account",
      "price": {
        "amount": "Free",
        "state": "free",
        "label": "Free",
        "detail": "Free from the tool",
        "type": "free"
      },
      "providers": 1,
      "retention": "standard",
      "runsOn": "free",
      "live": true,
      "summary": "Retrieves information about a specific sitemap.",
      "method": "GET",
      "path": "/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}",
      "host": "https://searchconsole.googleapis.com",
      "docsUrl": "https://developers.google.com/webmaster-tools/v1/sitemaps/get",
      "auth": {
        "scheme": "oauth",
        "label": "oauth · OAuth 2.0 with PKCE",
        "short": "oauth · OAuth 2.0"
      },
      "scope": "own_account",
      "principal": "organization",
      "requiredScopes": [
        "webmasters.readonly"
      ],
      "verification": {
        "state": "none",
        "label": "Not verified yet",
        "detail": "Not checked yet. We test with a real request before we mark it."
      },
      "input": [
        {
          "name": "siteUrl",
          "location": "pathParams",
          "type": "string",
          "required": true,
          "constraints": [],
          "note": "The property as sites.list returns it, a URL-prefix property with its trailing slash or a domain property written sc-domain:example.com"
        },
        {
          "name": "feedpath",
          "location": "pathParams",
          "type": "string",
          "required": true,
          "constraints": [],
          "note": "The URL of the sitemap, as sitemaps.list returns it"
        }
      ],
      "sampleInput": {
        "siteUrl": "sc-domain:example.com",
        "feedpath": "https://www.example.com/sitemap.xml"
      },
      "inputSchema": {
        "type": "object",
        "properties": {
          "siteUrl": {
            "type": "string",
            "description": "The property as sites.list returns it, a URL-prefix property with its trailing slash or a domain property written sc-domain:example.com",
            "examples": [
              "sc-domain:example.com"
            ]
          },
          "feedpath": {
            "type": "string",
            "description": "The URL of the sitemap, as sitemaps.list returns it",
            "examples": [
              "https://www.example.com/sitemap.xml"
            ]
          }
        },
        "required": [
          "siteUrl",
          "feedpath"
        ],
        "additionalProperties": false
      },
      "output": [
        {
          "name": "path",
          "type": "string",
          "description": "The URL of the sitemap"
        },
        {
          "name": "lastSubmitted",
          "type": "string",
          "description": "RFC 3339 time"
        },
        {
          "name": "lastDownloaded",
          "type": "string",
          "description": "RFC 3339 time"
        },
        {
          "name": "isPending",
          "type": "boolean",
          "description": "True when Google has not processed it yet"
        },
        {
          "name": "isSitemapsIndex",
          "type": "boolean",
          "description": "True when it is a collection of sitemaps"
        },
        {
          "name": "type",
          "type": "string",
          "description": "The kind of sitemap such as sitemap or rssFeed"
        },
        {
          "name": "warnings",
          "type": "string",
          "description": "Count as an int64 string"
        },
        {
          "name": "errors",
          "type": "string",
          "description": "Count as an int64 string"
        },
        {
          "name": "contents",
          "type": "object[]"
        }
      ],
      "outputSchema": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "The URL of the sitemap"
          },
          "lastSubmitted": {
            "type": "string",
            "description": "RFC 3339 time"
          },
          "lastDownloaded": {
            "type": "string",
            "description": "RFC 3339 time"
          },
          "isPending": {
            "type": "boolean",
            "description": "True when Google has not processed it yet"
          },
          "isSitemapsIndex": {
            "type": "boolean",
            "description": "True when it is a collection of sitemaps"
          },
          "type": {
            "type": "string",
            "description": "The kind of sitemap such as sitemap or rssFeed"
          },
          "warnings": {
            "type": "string",
            "description": "Count as an int64 string"
          },
          "errors": {
            "type": "string",
            "description": "Count as an int64 string"
          },
          "contents": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The kind of content such as web or image"
                },
                "submitted": {
                  "type": "string",
                  "description": "URLs submitted as an int64 string"
                }
              }
            }
          }
        }
      },
      "example": {
        "file": "examples/google-search-console.sitemaps.get.json",
        "json": {
          "path": "https://www.example.com/sitemap.xml",
          "lastSubmitted": "2026-09-12T08:15:30.123Z",
          "lastDownloaded": "2026-10-03T21:04:11.456Z",
          "isPending": false,
          "isSitemapsIndex": false,
          "type": "sitemap",
          "warnings": "0",
          "errors": "0",
          "contents": [
            {
              "type": "web",
              "submitted": "1842"
            }
          ]
        }
      },
      "commands": {
        "mode": "run",
        "cli": "telipot run google-search-console.sitemaps.get \\\n  --input-json '{\"siteUrl\":\"sc-domain:example.com\",\"feedpath\":\"https://www.example.com/sitemap.xml\"}'",
        "http": "curl https://api.telipot.com/v1/tasks/google-search-console.sitemaps.get/run \\\n  -H \"Authorization: Bearer $TELIPOT_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"siteUrl\":\"sc-domain:example.com\",\"feedpath\":\"https://www.example.com/sitemap.xml\"}'",
        "quote": "telipot run google-search-console.sitemaps.get \\\n  --input-json '{\"siteUrl\":\"sc-domain:example.com\",\"feedpath\":\"https://www.example.com/sitemap.xml\"}' \\\n  --quote"
      },
      "siblings": []
    }
  ]
}
