Skip to main content

Site

A site with derived activity/install status plus optional tracking and settings data normalized for GraphQL clients. Returned by site and sites.

type Site {
  id: Int
  name: String
  createdAt: Int
  sessionRecording: Boolean
  installed: Boolean!
  lastData: Int
  recordingFirstDataAt: Int
  active: Boolean!
  recordingRatio: Int
  estimatedVisitsDay: Int
  estimatedMaxRecordingsDay: Int
  recordingSettings: RecordingSettings
  webAnalyticsEnabled: Boolean!
  webAnalyticsEnabledAt: Int
  webAnalyticsFirstDataAt: Int
  metadata: String
  apiKey: String
  publicTrackingApi: Boolean
  settings: SiteSettingsDetails
}

Fields​

Site.id ● Int scalar​

Site.name ● String scalar​

Site.createdAt ● Int scalar​

Site creation time in Unix seconds.

Site.sessionRecording ● Boolean scalar​

Whether session recording is enabled; null in shared-session details.

Site.installed ● Boolean! non-null scalar​

True when installation is marked confirmed or the site has received data.

Site.lastData ● Int scalar​

Last received site data in Unix seconds; null before data arrives.

Site.recordingFirstDataAt ● Int scalar​

First received recording data in Unix seconds; null before data arrives or in shared-session details.

Site.active ● Boolean! non-null scalar​

Whether site data was received within the last 28 days.

Site.recordingRatio ● Int scalar​

Sampling denominator, one recording per this many visits; null when unavailable or in shared-session details.

Site.estimatedVisitsDay ● Int scalar​

Estimated visits per day; null when unavailable or in shared-session details.

Site.estimatedMaxRecordingsDay ● Int scalar​

Estimated maximum recordings per day; null when unavailable or in shared-session details.

Site.recordingSettings ● RecordingSettings object​

Recording configuration; null when absent, not loaded, or accessed through a shared session.

Site.webAnalyticsEnabled ● Boolean! non-null scalar​

Whether Web Analytics has an enablement timestamp.

Site.webAnalyticsEnabledAt ● Int scalar​

Web Analytics enablement time in Unix seconds; null when disabled or in shared-session details.

Site.webAnalyticsFirstDataAt ● Int scalar​

First Web Analytics data time in Unix seconds; null before data arrives or in shared-session details.

Site.metadata ● String scalar​

Site metadata such as saved colors and fonts, as a JSON object string; {} when empty, null in shared-session details.

Site.apiKey ● String scalar​

Site API key; null if absent or accessed through a shared session.

Site.publicTrackingApi ● Boolean scalar​

Whether the public tracking API is enabled; null in shared-session details.

Site.settings ● SiteSettingsDetails object​

Site tracking settings returned by site and sites, falling back to account tracking defaults when absent. Null in shared-session details or when neither settings nor defaults are available.

Returned By​

addSite mutation ● deleteSiteAndAssociatedData mutation ● regenerateSiteApiKey mutation ● setSiteColors mutation ● setSiteFonts mutation ● setSiteRecording mutation ● site query ● siteEnableAnalytics mutation ● sites query ● updateSitePublicTrackingApi mutation ● updateSiteSettings mutation

Member Of​

UserAccount object