Site

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.
}

Site Pillars

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! }) and Message ({ message: String! }) — LineMessage is used when an issue is tied to a specific line.

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.

SiteMainPage

Does not share the common wrapper shape above — it's the site's most recent snapshot crawl of its homepage, with no hash / 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).

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.

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.

updateSite

Updates a site's enabled features and/or notification settings. Passing features replaces the full set of enabled features.

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! }.

Filterable Fields

SiteFilterableFields — see Discovering Filterable Fields for how to use this with findSite.

enum SiteFilterableFields {
  ID
  USER_ID
  IS_FAVORITE
  DOMAIN
  ROOT_DOMAIN
  FEATURES
  CREATE_TIME
  UPDATE_TIME
}

Certificates

findSiteCertificate

Filterable list of a domain's certificate history. Not paginated or sortable.

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

Parameters

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

getSiteCertificateIdentities

Distinct identity names (SANs) seen across a domain's certificate history.

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

Parameters

Response: [String!]!.

Filterable fields: SiteCertificateFilterableFields — COMMON_NAME, NOT_BEFORE, NOT_AFTER, IDENTITY_NAME, CHECK_TIME, SYNC_TIME, CREATE_TIME, UPDATE_TIME.

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 individual URL entries within a domain's sitemaps.

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

Parameters

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

SiteSitemapUrlEntry

Filterable fields: SiteSitemapFilterableFields (for findSiteSitemap) — URL, FINAL_URL, TYPE, STATUS, PARENT_URL, FORMAT, LINK_COUNT, CHECK_TIME, SYNC_TIME, CREATE_TIME, UPDATE_TIME, DOMAIN. SiteSitemapLinkFilterableFields (for findSiteSitemapLink) — SITEMAP_URL, URL, DOMAIN.

Errors: see Error Codes: Sitemap.

Links

findSiteLink

Paginated, filterable list of crawled links across your sites. Filter by domain in the query string to scope to one site.

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

Parameters

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

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", limit: 25) {
    items {
      url
      status
    }
  }
}

Parameters

Response: a SiteLinkList — same shape as findSiteLink above.

Filterable fields: SiteLinkFilterableFields — ID, STATUS, URL, PAGE_TITLE, PAGE_STATUS_CODE, PAGE_RESPONSE_TIME, PAGE_CONTENT_SIZE, MAIN_PAGE, CRAWL_TIME, CREATE_TIME, UPDATE_TIME, DOMAIN, SEVERITY, SYSTEM_TAGS.

Errors: see Error Codes: Links.