Domain Detective

API Reference

Class

SitemapAnalysis

Namespace DomainDetective
Assembly DomainDetective
Implements
Modifiers sealed

Downloads, parses, and validates sitemap XML documents and optionally probes listed URLs.

Inheritance

  • Object
  • SitemapAnalysis

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

Methods

public async Task AnalyzeAsync(String subject, InternalLogger logger = null, SitemapAnalysisOptions options = null, CancellationToken cancellationToken = null) #
Returns: Task

Executes sitemap analysis for a domain, host, sitemap URL, or HTTP/HTTPS URL.

Parameters

subject System.String requiredposition: 0
logger DomainDetective.InternalLogger = null optionalposition: 1
options DomainDetective.SitemapAnalysisOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3

Properties

public String Subject { get; set; } #

Subject that was analyzed.

public Uri OriginUri { get; set; } #

Origin URL selected for relative sitemap discovery.

public List<String> SitemapUrls { get; } #

Sitemap URLs discovered from input, robots.txt, and conventional locations.

public List<SitemapDocument> Documents { get; } #

Sitemap XML documents fetched during analysis.

public List<SitemapUrlEntry> Entries { get; } #

URL entries parsed from urlset documents.

public List<SitemapUrlProbe> UrlProbes { get; } #

URL probes for parsed sitemap entries.

public virtual List<Assessment> Assessments { get; } #

Structured assessments captured during the analysis.

public IReadOnlyList<RecommendationAdvice> Recommendations { get; } #

Actionable recommendations derived from assessments.

public Int32 DuplicateLocationCount { get; set; } #

Number of duplicate loc entries.

public Int32 InvalidLocationCount { get; set; } #

Number of parsed loc entries with invalid URL syntax.

public Int32 RedirectCount { get; set; } #

Number of probed URLs that redirected.

public Int32 RedirectLoopCount { get; set; } #

Number of probed URLs with redirect loops.

public Int32 ClientErrorCount { get; set; } #

Number of probed URLs returning 4xx.

public Int32 ServerErrorCount { get; set; } #

Number of probed URLs returning 5xx.

public Int32 NoIndexCount { get; set; } #

Number of probed URLs marked noindex.

public Int32 CanonicalMismatchCount { get; set; } #

Number of probed URLs whose canonical target differs from the final URL.

public Func<HttpMessageHandler> HttpHandlerFactory { get; set; } #

Factory for HTTP message handlers; mainly useful for tests.

{{ include "footer" }}