Site

Represents a public website that is integrated with an org. This object is available in API version 16.0 and later.

To access this object, Salesforce Sites, Sites, or Site.com must be enabled for your organization.

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

Fields

Field Description
AdminId
Type
reference
Properties
Filter, Group, Sort
Description
The site administrator designated as the contact for the site. This user receives site-related communications from site visitors and from Salesforce.
AnalyticsTrackingCode
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The tracking code associated with your site. This code can be used by services like Google Analytics to track page request data for your site.
ClickjackProtectionLevel
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Sets the clickjack protection level. The options are:
  • AllowAllFraming—Allow framing by any page (no protection)
  • SameOriginOnly—Allow framing by the same origin only (recommended)
  • NoFraming—Don’t allow framing by any page (most protection)
This field is available in API version 30.0 and later.
DailyBandwidthLimit
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The rolling 24-hour daily bandwidth limit for the sites in your organization.
DailyBandwidthUsed
Type
double
Properties
Filter, Group, Nillable, Sort
Description
The current rolling 24-hour daily bandwidth usage for the sites in your organization.
DailyRequestTimeLimit
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The rolling 24-hour daily service request time limit for the sites in your organization. Service request time is calculated as the total server time in minutes required to generate pages for the site.
DailyRequestTimeUsed
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The current rolling 24-hour daily service request time for the sites in your organization.
Description
Type
textarea
Properties
Filter, Nillable, Sort
Description
An optional description of the site.
GuestUserId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The site or Salesforce Communities specific user that anonymous, unauthenticated users run as when interacting with the site.
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
The name of the site as it appears in the user interface.
MonthlyPageViewsEntitlement
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of page views allowed for the current calendar month for the sites in your organization.
Name
Type
string
Properties
Filter, Group, Sort
Description
The name used when referencing the site in the API.
OptionsAllowGuestSupportApi
Type
boolean
Properties
Filter
Description
The option to enable unauthenticated users to access the Support API.
OptionsAllowHomePage
Type
boolean
Properties
Filter
Description
The option to enable the standard page associated with the Home tab (/home/home.jsp).
OptionsAllowStandardAnswersPages
Type
boolean
Properties
Filter
Description
The option to enable standard pages associated with an answers community. If you want to use default Answers pages (such as AnswersHome), enable these pages.
OptionsAllowStandardIdeasPages
Type
boolean
Properties
Filter
Description
The option to enable standard pages associated with an Ideas community. If you want to use default Ideas pages (such as IdeasHome), enable these pages.
OptionsAllowStandardLookups
Type
boolean
Properties
Filter
Description
The option to enable the standard lookup pages. These are the popup windows associated with lookup fields on Visualforce pages.
OptionsAllowStandardPortalPages
Type
boolean
Properties
Filter
Description
The option to enable authenticated users to access the standard Salesforce pages.
OptionsAllowStandardSearch
Type
boolean
Properties
Filter
Description
The option to enable the standard search pages. To allow public users to perform standard searches, enable these pages.
OptionsBrowserXssProtection
Type
boolean
Properties
Filter
Description
The option to enable the browser's cross-site scripting protection.
OptionsContentSniffingProtection
Type
boolean
Properties
Filter
Description
The option to enable content-sniffing protection.
OptionsCspUpgradeInsecureRequests
Type
boolean
Properties
Filter
Description
The option to upgrade all requests to HTTPS (Content Security Policy : Upgrade Insecure Requests).
OptionsEnableFeeds
Type
boolean
Properties
Filter
Description
The option that displays the Syndication Feeds related list, where you can create and manage syndication feeds for users on your public sites. This field is visible only if you have the feature enabled for your organization.
OptionsReferrerPolicyOriginWhenCrossOrigin
Type
boolean
Properties
Filter
Description
The option to enable referrer policy (origin-when-cross-origin).
OptionsRequireHttps
Type
boolean
Properties
Filter
Description
When true, the site requires secure connections. When false, the site operates normally via insecure connections instead of redirecting to a secure connection.
SiteType
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Identifies whether the site is a Visualforce (Salesforce Sites) or a Site.com site. SiteType is available in API version 21.0 and later. In API version 26.0 and later, if Salesforce communities is enabled for your organization, the site could also be a Network Visualforce or Network Site.com site.
Status
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The status for the site. For example, Active or In Maintenance.
Subdomain
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The Salesforce domain that you registered for your site. For example, if your domain is mycompany.force.com, then mycompany is the subdomain.
TopLevelDomain
Type
url
Properties
Filter, Nillable
Description
The optional branded custom Web address that you registered with a third-party domain name registrar. The custom Web address acts as an alias to your Salesforce address.

Beginning with API version 21.0, TopLevelDomain is no longer available. Instead, use the Domain and DomainSite objects.

UrlPathPrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The unique Salesforce URL that the public uses to access this site.

Usage

Use this read-only object to query or retrieve information on your Salesforce site.