Site

Some features and limits mentioned on this page vary by plan. Visit our Pricing page to review the plans.

Fields

Features

enum SiteFeatureTypes {
  MONITOR_WHOIS      # Enables WHOIS/domain registration monitoring.
  MONITOR_SSL        # Enables SSL/TLS certificate monitoring.
  MONITOR_DNS        # Enables DNS record monitoring.
  LINK_CRAWLER       # Enables the link crawler.
  SITEMAP_CRAWLER    # Enables sitemap discovery and crawling.
}

Check Results

ssl, certificate, whois, dns, robotsTxt, and sitemap above share a common wrapper shape:

mainPage does not share this shape — see SiteMainPage below. link is a separate, lightweight stats object — see SiteLinkStats below.

SiteSSL

Adds to the common shape above:

SiteCertificate

Adds to the common shape above:

SiteWhois

Adds to the common shape above:

SiteDNS

Adds to the common shape above:

SiteDnsPayload

SiteDnsRecordError is the shared { code: DnsErrorCode!, message: String! } shape used by each derived-record error field above — see Error Codes: DNS.

KeyValues (plural) — used for ptr and the SPF/BIMI raw payloads: { key: String, values: [String!]!, payload: [KeyValues!] }, allowing nested key/value groups. Distinct from KeyValue (singular value).

SiteDnsBimiPayload — { value: String, version: String, logoUrl: String, authorityUrl: String }.

SiteDnsTlsRptPayload — { value: String, version: String, rua: String }.

SiteDnsMtaStsPayload — { value: String, version: String, id: String }.

SiteRobotsTxt

Adds to the common shape above:

SiteRobotsTxtPayload is a union of:

SiteRobotsTxtMessage is itself a union of LineMessage ({ line: Int!, message: String!, code: RobotsTxtValidationErrorCode! }) and Message ({ message: String!, code: RobotsTxtValidationErrorCode! }) — LineMessage is used when an issue is tied to a specific line. See Error Codes: Robots.txt for the codes.

SiteSitemap

Adds to the common shape above. This is the summary object at sitemap itself — distinct from SiteSitemapFile / SiteSitemapLink, the findSiteSitemap / findSiteSitemapLink response items documented under Sitemap below.

SiteSitemapSummary

Other Site Types

SiteMainPage

Does not share the common wrapper shape above — it describes the latest check of the homepage, with no checkTime / syncTime.

MainWebpage

Same fields as Webpage, plus:

BrowserPayload

SiteLinkStats

link — a lightweight link-crawler summary. Distinct from SiteLink (individual crawled links, returned by findSiteLink — see Links below).

The same situation shows up per tag in siteLinkSummary as hasMore.

SiteAttachment

attachments — screenshots and favicons captured for the site.

Queries

getSite

Look up a single monitored site by domain.

query {
  getSite(domain: "acme.io") {
    id
    domain
    features
  }
}

Parameters

Response: a Site (see Fields above), or null if not found.

findSite

Paginated, filterable list of your monitored sites.

query {
  findSite(query: "isFavorite = TRUE", limit: 25) {
    pagination {
      count
    }
    items {
      domain
      features
    }
  }
}

Parameters

Response: a SiteList — pagination + items: [Site!]!. See Pagination & Sorting.

analyzeSite

Returns the domain's latest site analysis results.

query {
  analyzeSite(domain: "acme.io") {
    status
    summary {
      score
    }
  }
}

Parameters

Response: an AnalyzeResult — see Types: Analysis for the nested AnalyzeSummary/SubAnalyzeResult shapes.

status shows how complete the result is: PENDING (no check has run yet, so the result is empty), IN_PROGRESS (some enabled checks haven't produced results yet), or DONE. For a newly added site, query again later until the status is DONE.

Mutations

createSite

Adds a new domain to monitor.

mutation {
  createSite(
    domain: "acme.io"
    features: [MONITOR_WHOIS, MONITOR_SSL, MONITOR_DNS, LINK_CRAWLER]
    notification: { all: true }
  ) {
    id
    domain
    features
  }
}

Parameters

Response: the created Site.

Limits: creation fails once your workspace has reached its plan's site limit, or once you have created that many sites in one day (UTC). Deleted sites still count toward that day's total.

updateSite

Updates a site's enabled features, notification settings, tags and/or folder. Passing features or tags replaces the full set. Turning a feature off also deletes that feature's incidents for the site.

Parameters

Response: the updated Site.

deleteSite

Stops monitoring a domain and removes its data.

mutation {
  deleteSite(domain: "acme.io") {
    affectedRecords
  }
}

Parameters

Response: a DeleteResult — { affectedRecords: Int! }.

Certificates

findSiteCertificate

Unexpired certificates of a domain and its subdomains, taken from public Certificate Transparency logs. Filterable, but not paginated or sortable.

query {
  findSiteCertificate(domain: "acme.io") {
    items {
      commonName
      notBefore
      notAfter
      issuerName
    }
  }
}

Parameters

Response: a SiteCertificateList — items: [SiteCertificateRecord!]!:

getSiteCertificateIdentities

Subdomains named on the domain's certificates. Empty when SSL monitoring is off for the site.

query {
  getSiteCertificateIdentities(domain: "acme.io")
}

Parameters

Response: [String!]!.

Errors: see Error Codes: Certificates.

Sitemap

findSiteSitemap

Paginated, filterable list of sitemap files discovered for a domain.

query {
  findSiteSitemap(domain: "acme.io", limit: 25) {
    items {
      url
      type
      status
      linkCount
    }
  }
}

Parameters

Response: a SiteSitemapFileList — items: [SiteSitemapFile!]!:

findSiteSitemapLink

Paginated, filterable list of a domain's sitemap files, each with all of its URL entries. Paging is by file, so limit counts files, not URLs.

query {
  findSiteSitemapLink(domain: "acme.io", limit: 25) {
    items {
      sitemapUrl
      linkCount
    }
  }
}

Parameters

Response: a SiteSitemapLinkList — items: [SiteSitemapLink!]!:

SiteSitemapUrlEntry

Errors: see Error Codes: Sitemap.

Links

findSiteLink

Paginated, filterable list of crawled links. The query must include a domain condition, e.g. domain = acme.io.

query {
  findSiteLink(query: "domain = acme.io AND status = CRAWL_COMPLETE", limit: 25) {
    items {
      url
      status
      mainPage
    }
  }
}

Parameters

Response: a SiteLinkList — items: [SiteLink!]!:

getSiteLink

Look up a single crawled link by its exact URL.

query {
  getSiteLink(domain: "acme.io", url: "https://acme.io/pricing") {
    url
    status
    page {
      statusCode
    }
  }
}

Parameters

Response: a SiteLink (see findSiteLink above), or null if the link isn't found, or is outside your key's scope or plan limit.

siteLinkSummary

Counts of crawled links grouped by system tag (OK, REDIRECT, NOT_FOUND, etc.).

query {
  siteLinkSummary(query: "domain = acme.io") {
    total
    items {
      tag
      count
    }
  }
}

Parameters

Response: a SiteLinkSummary:

siteLinkBacklinks

Paginated list of crawled links pointing to a given URL.

query {
  siteLinkBacklinks(
    url: "https://acme.io/pricing"
    query: "domain = acme.io"
    limit: 25
  ) {
    items {
      url
      status
    }
  }
}

Parameters

Response: a SiteLinkList — same shape as findSiteLink above.

Errors: see Error Codes: Links.