Types

Reference for object types that are nested inside the responses documented on other resource pages, rather than returned directly by a query or mutation of their own. Types used by only one resource are documented on that resource's own page instead — e.g. Site's check result types (SiteSSL, SiteDNS, SiteMainPage, etc.) are on Site.

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

WHOIS

SiteWhoisPayload — appears as site.whois.payload, and inside domain incident types (see Incidents). All fields are optional; presence depends on what the registry/registrar publishes.

Raw data

Field	Type
`text`	`String`
`json`	`JSON`
`whoisServer`	`String`
`rdapServer`	`String`
`rdapServers`	`[String!]`
`dnssec`	`[String!]`

Dates & status

Field	Type
`creationDate`	`String`
`expirationDate`	`String`
`updatedDate`	`String`
`nameServers`	`[String!]`
`status`	`[String!]`

Registrar

Field	Type
`registrarName`	`String`
`registrarOrg`	`String`
`registrarUrl`	`[String!]`
`registrarIanaId`	`String`
`registrarAddress`	`String`
`registrarEmails`	`[String!]`
`registrarPhone`	`String`
`registrarFax`	`String`
`registrarAbuseTel`	`[String!]`
`registrarAbuseEmail`	`[String!]`
`registrarAbuseUrl`	`[String!]`
`reseller`	`String`

Registrant, Admin, Tech

Each of these three contacts exposes the same shape, prefixed registrant* / admin* / tech*:

Suffix	Type
`Name`	`String`
`Org`	`String`
`Address`	`String`
`PostalCode`	`String`
`Emails`	`[String!]`
`Phone`	`String`
`PhoneExt`	`String`
`Fax`	`String`
`FaxExt`	`String`

(e.g. registrantName, registrantEmails, adminPhone, techFax, etc.)

SSL

SiteSSLPayload — appears as site.ssl.payload, and inside SSL incident types.

Field	Type	Description
`issuer`	`SiteSSLPayloadIssuer!`	Certificate issuer — see X509Name shape below.
`subject`	`SiteSSLPayloadSubject!`	Certificate subject — same shape as `issuer`.
`serialNumber`	`String!`
`version`	`Int!`
`notBefore` / `notAfter`	`String!`	Validity window.
`subjectAltName`	`[KeyValue!]`
`extendedKeyUsage`	`[String!]`
`OCSP`	`[String!]`
`ocspStatus`	`SslRevocationStatus`	Revocation status reported by the certificate's OCSP responder. `UNKNOWN` means the responder doesn't recognize the certificate. `null` if it gave no answer.
`crlStatus`	`SslRevocationStatus`	Revocation status from the certificate revocation list (CRL). `null` if OCSP gave an answer.
`caIssuers`	`[String!]`	`null` when the certificate lists no CA issuer URLs.
`crlDistributionPoints`	`[String!]`
`cipher` / `protocol`	`String!`	Negotiated TLS parameters.
`keyExchange`	`String`	Negotiated key exchange. `null` for legacy ciphers that don't report one.
`cipherStrength`	`Int!`
`chain`	`SiteSSLChain`	The full certificate chain — see `SiteSSLChain` below.
`peerConsistency`	`SiteSSLPeerConsistency`	Whether all IPs the domain resolves to serve the same certificate — see `SiteSSLPeerConsistency` below.

`SiteSSLPayloadIssuer` / `SiteSSLPayloadSubject`

Both use the same X.509 distinguished-name shape as X509Name below (also used for SiteCertificateRecord.issuer and ChainCertificate.issuer/.subject).

`SiteSSLChain`

Field	Type	Description
`error`	`SiteSslError`	Set if the chain couldn't be retrieved/verified — see Error Codes: SSL.
`payload`	`SiteSSLChainPayload`	The chain data — see below.

`SiteSSLChainPayload`

Field	Type	Description
`validation`	`Boolean!`	Whether the chain's order, signatures and validity dates are correct.
`selfSigned`	`Boolean!`	Whether the leaf certificate is self-signed.
`certificates`	`[ChainCertificate!]!`	Every certificate in the chain, leaf first — see below.
`errors`	`[String!]`	Raw validation error messages, if any.

`ChainCertificate`

One certificate within SiteSSLChainPayload.certificates. Shares issuer, subject, serialNumber, version, notBefore, notAfter, subjectAltName, and extendedKeyUsage with SiteSSLPayload above, plus:

Field	Type	Description
`signatureAlgorithm`	`String!`
`publicKeyAlgorithm`	`String!`
`publicKeyType`	`String`
`publicKeySize`	`Int`
`keyUsage`	`[String!]!`
`isLeaf`	`Boolean!`	Whether this is the end-entity (leaf) certificate.
`isCa`	`Boolean!`	Whether this certificate is a CA certificate.

`SiteSSLPeerConsistency`

Whether every IP the domain resolves to serves the same certificate.

Field	Type	Description
`baselineIp`	`String!`	The IP the baseline certificate was fetched from.
`consistent`	`Boolean!`	Whether all checked peers returned a matching certificate.
`checked`	`[SiteSSLPeerCheck!]!`	Per-peer results — see below.

`SiteSSLPeerCheck`

Field	Type	Description
`ip`	`String!`	The peer IP that was checked.
`error`	`SiteSslError`	Set if this peer's certificate couldn't be fetched or didn't match — see Error Codes: SSL.

Common

`X509Name`

Field	Type
`countryName`	`String`
`organizationName`	`String`
`organizationalUnitName`	`String`
`commonName`	`String`
`localityName`	`String`
`stateOrProvinceName`	`String`
`streetAddress`	`String`
`postalAddress`	`String`
`postalCode`	`String`
`serialNumber`	`String`
`surname`	`String`
`givenName`	`String`
`title`	`String`
`initials`	`String`
`generationQualifier`	`String`
`pseudonym`	`String`
`businessCategory`	`String`
`organizationIdentifier`	`String`
`userId`	`String`
`domainComponent`	`String`
`x500UniqueIdentifier`	`String`
`dnQualifier`	`String`
`jurisdictionCountryName`	`String`
`jurisdictionLocalityName`	`String`
`jurisdictionStateOrProvinceName`	`String`
`inn` / `ogrn` / `snils`	`String`

`Webpage`

The fetched-page response shape used by UptimeLinkRecord.page and PagePath.page. SiteLink.page uses SiteLinkPage, which has the same fields.

Field	Type
`statusCode`	`Int!`
`contentSize`	`Int!`
`responseTime`	`Float!`
`headers`	`[KeyValue!]!`
`httpVersion`	`HttpVersion`
`content`	`String`
`title`	`String`
`meta`	`[KeyValue!]`
`favicon`	`String`
`canonicals` / `alternates`	`[SiteSubLink!]`

`SiteLinkPage`

The fetched-page response shape used by SiteLink.page. It has the same fields as Webpage.

`HttpAuth` / `HttpAuthInput`

Field	Type
`type`	`HttpAuthType!` — `BLANK`, `BASIC`, `DIGEST`, or `TOKEN`
`payload`	`KeyValue` (output) / `KeyValueInput` (input)

On input, BASIC and DIGEST take the username as key and the password as value; TOKEN takes the token as value and is sent as Authorization: Bearer <token>.

On output, the password or token is never returned: value is always an empty string, and BASIC and DIGEST still return the username as key.

On update, sending the same type with an empty value keeps the stored credential. Changing the type requires new credentials. Omitting auth or sending BLANK removes the stored authentication.

`HttpBody` / `HttpBodyInput`

Field	Type
`type`	`HttpFormDataType!` — `JSON`, `FORM_DATA`, or `RAW`
`payload`	`[KeyValue!]!` (output) / `[KeyValueInput!]!` (input) — for `FORM_DATA`, one entry per field; for `JSON` and `RAW`, the body is the first entry's `value`.

`KeyValue` / `KeyValueInput`

Field	Type
`key`	`String!`
`value`	`String!`
`payload`	`[KeyValue!]` — nested key/value pairs, when applicable.

`HttpResponse`

Raw HTTP response info without a parsed page body — used by SiteSitemapFile.page.

Field	Type
`statusCode`	`Int!`
`contentSize`	`Int!`
`responseTime`	`Float!`
`headers`	`[KeyValue!]!`
`httpVersion`	`HttpVersion`

`SiteSubLink`

A link found on a crawled page — used by SiteLink.links and Webpage.canonicals/.alternates.

Field	Type	Description
`href`	`String!`	The link's target URL.
`rel`	`[String!]!`	`rel` attribute values found on the link (e.g. `nofollow`, `canonical`).
`text`	`[String!]!`	Anchor text associated with the link.
`count`	`Int!`	Number of times this exact link appears on the page.
`type`	`SiteLinkTypes!`	`INTERNAL` or `EXTERNAL`.
`payload`	`[KeyValue!]`	Additional attributes captured on the link.
`data`	`SiteLink`	The corresponding crawled `SiteLink` record, if this URL is also tracked as its own link.

Uptime

`UptimeLinkBase`

Snapshot shape used by UptimeLinkRecord.uptimeLinkSnapshot — the monitor's configuration at the time of a check.

Field	Type	Description
`type`	`UptimeLinkType!`	The check type — currently always `HTTP`.
`locations`	`[UptimeLocations!]`	Monitoring locations the check runs from.
`target`	`String!`	The URL being checked.
`notification`	`UptimeLinkNotificationConfig!`	Notification settings.
`name`	`String!`	The monitor's display name.
`commonName`	`String!`	The monitor's name as shown on its public status page.
`checkInterval`	`Int!`	Seconds between checks.
`timeout`	`Int!`	Request timeout in seconds.
`http`	`UptimeLinkHttp`	HTTP-specific check configuration — see Uptime: UptimeLinkHttp.

`UptimeLinkSummaryRecord`

One bucket within findUptimeLinkSummary's records array.

Field	Type
`responseTime`	`Float!`
`uptime` / `uptimePercent`	`Float!`
`downtime` / `downtimePercent`	`Float!`
`unmonitored` / `unmonitoredPercent`	`Float!`
`startTime`	`String!`

Analysis

Types nested inside analyzeSite's response — see Site: analyzeSite.

Type	Fields
`AnalyzeSummary`	`score: Int`, `issues: AnalyzeIssueSummary!`
`AnalyzeIssueSummary`	`critical` / `high` / `medium` / `low` / `info`: `Int!`
`SubAnalyzeResult`	`summary: AnalyzeSummary!`, `items: [AnalyzeCategory!]!`
`AnalyzeCategory`	`key: String!`, `value: [AnalyzeItems!]!`
`AnalyzeItems`	`key: String!`, `value: [AnalyzeItem!]!`
`AnalyzeItem`	`rank: Int!`, `category/code/message: String!`, `points/effectivePoints: Int!`, `effectiveOverallPoints: Float!`, `references: [AnalyzeReference!]`
`AnalyzeReference`	`standard/code/severity/category: String!`, `title/url: String`

Subscription

Subscription — appears as AuthorizedWorkspace.subscription (see Account: myWorkspaces).

Field	Type	Description
`status`	`SubscriptionStatus!`	`INCOMPLETE`, `INCOMPLETE_EXPIRED`, `TRIALING`, `ACTIVE`, `PAST_DUE`, `CANCELED`, `UNPAID`, or `PAUSED`.
`package`	`SubscriptionPackage!`	`FREE`, `STARTER`, `PRO`, or `ENTERPRISE`.
`capabilities`	`SubscriptionPlanCapabilities!`	The plan's limits and enabled features — see below.
`price`	`Float!`
`period`	`SubscriptionPeriod`	`MONTHLY` or `YEARLY`.
`startTime` / `endTime`	`String!` / `String`	ISO 8601 timestamps for the subscription's start / end.
`periodStartTime` / `periodEndTime`	`String!` / `String`	ISO 8601 timestamps for the current billing period.
`schedule`	`SubscriptionSchedule`	A pending plan change scheduled to take effect at the next period, if any.

`SubscriptionPlanCapabilities`

Field	Type	Description
`userLimit`	`Int`	Max workspace users. `null` means unlimited.
`siteLimit`	`Int`	Max monitored sites. `null` means unlimited.
`siteLinkCrawlerLimit`	`Int`	Max links per site the link crawler will follow. `null` means unlimited.
`uptimeLinkLimit`	`Int`	Max uptime monitors. `null` means unlimited.
`uptimeLinkMinInterval`	`Int!`	Minimum allowed `checkInterval`, in seconds, for this plan.
`uptimeLinkLocationLimit`	`Int`	Max monitoring locations per uptime monitor. `null` means unlimited.
`incidentManagement`	`Boolean!`	Whether incident management is enabled.
`apiAccess`	`Boolean!`	Whether GraphQL API access is enabled.
`sitemapCrawler`	`Boolean!`	Whether the sitemap crawler is enabled.
`notification`	`SubscriptionPlanNotificationCapabilities!`	Which notification channels are available — see below.
`securityMonitoring`	`SubscriptionPlanSecurityMonitoring`	`BASIC` or `ADVANCED`, if included.
`dataRetention`	`Int`	Data retention window, in months. `null` means unlimited.
`reportInterval`	`SubscriptionPlanReportInterval`	Which periodic report cadences are available — see below.
`support`	`SubscriptionPlanSupport`	`PRIORITY` or `DEDICATED`. `null` means standard support.

`SubscriptionPlanNotificationCapabilities`

Field	Type
`email`	`Boolean!`
`slack`	`Boolean!`
`webhook`	`Boolean!`

`SubscriptionPlanReportInterval`

Field	Type
`weekly`	`Boolean!`
`biWeekly`	`Boolean!`
`monthly`	`Boolean!`

`SubscriptionSchedule`

Field	Type	Description
`package`	`SubscriptionPackage!`	The plan the workspace will change to.
`price`	`Float!`
`period`	`SubscriptionPeriod`	`MONTHLY` or `YEARLY`.
`startTime`	`String!`	ISO 8601 timestamp when the change takes effect.

Results

Generic result shapes returned by delete/bulk-update mutations across every resource.

Type	Fields
`DeleteResult`	`affectedRecords: Int!`
`UpdateResult`	`affectedRecords: Int!`

Error Object Shape

Every *Error type referenced throughout the API (SiteWhoisError, SiteSslError, SiteLinkError, UptimeError, etc.) has the same two-field shape:

Field	Type
`code`	The resource's `*ErrorCode` enum — see Error Codes.
`message`	`String!` — a human-readable message.

Two exceptions carry an extra payload: [KeyValue!] field with additional structured context: SiteMainPageError (see Site: SiteMainPage) and SiteSitemapEntryError (see Site: Sitemap).

Enum Value Reference

Enums referenced across resource pages that aren't already shown in full elsewhere:

Enum	Values
`UptimeLocations`	The locations your workspace can use — query `uptimeLocation` for the list.
`UptimeLinkAccessibilityStatus`	`UP`, `DOWN`, `UNVERIFIED`
`SiteAnalyzeStatus`	`PENDING`, `IN_PROGRESS`, `DONE`
`CrawlStatus`	`NEW`, `PROCESSING`, `CRAWL_COMPLETE`, `CRAWL_FAIL`, `CRAWL_BLOCK`
`SiteLinkStatus`	`NEW`, `CRAWL_COMPLETE`, `CRAWL_FAIL`, `CRAWL_BLOCK`
`SiteLinkSystemTag`	`OK`, `REDIRECT`, `NOT_FOUND`, `AUTH_REQUIRED`, `CLIENT_ERROR`, `SERVER_ERROR`, `UNREACHABLE`, `ROBOTS_DISALLOWED`, `NOT_FOUND_IN_SITEMAP`
`SslRevocationStatus`	`GOOD`, `REVOKED`, `UNKNOWN`
`SitemapFileType`	`INDEX`, `LEAF`
`SitemapFormat`	`XML`, `TEXT`
`HttpVersion`	`HTTP10`, `HTTP11`, `HTTP2`, `HTTP3`
`Language`	`EN`, `TR`
`WorkspaceUserRole`	`OWNER`, `ADMIN`, `USER`
`IncidentLevel`	`INFO`, `LOW`, `MEDIUM`, `HIGH`, `CRITICAL`

On this page