Subsite.getStatistics (Method)

Returns a structure that has statistics about the subsite; for example, the number of pages, uploaded documents, images, page sets, and so on. Optionally, this can include statistics for all of the subsite's descendants.

Returns:

Subsite_GetStatistics_Result (struct)

Each row of the returned query results has the following fields:

Field Name	Type	Description
BaseTemplatesCount	NonNegativeInteger	If the includeChildSubsites argument is set to true, this is the number of base templates in the subsite and descendant subsites. Otherwise, this is the number of base templates in the current subsite.
CanDelete	Boolean	True if subsite can be deleted, False otherwise (see NoDeleteReason).
ChildSubsiteCount	NonNegativeInteger	If the includeChildSubsites argument is set to true, this is the number of child subsites and descendant subsites that exist.
ImagesCount	NonNegativeInteger	If the includeChildSubsites argument is true, this is the number of images in the subsite and descendant subsites. Otherwise, this is the number of images within the current subsite.
LockedPagesCount	NonNegativeInteger	If the includeChildSubsites argument is true, this is the number of locked pages in the subsite and descendant subsites. Otherwise, this is the number of locked pages within the current subsite.
MultimediaFilesCount	NonNegativeInteger	If the includeChildSubsites argument is true, this is the number of multimedia files in the subsite and descendant subsites, Otherwise, this is the number in the current subsite.
MultimediaPlaylistsCount	NonNegativeInteger	If the includeChildSubsites argument is true, this is the number of multimedia playlists in the subsite and descendant subsites. Otherwise, this is the number of multimedia playlists in the current subsite.
NoDeleteReason	PlainText_255	If CanDelete is false, this is the explanation.
PagesCount	NonNegativeInteger	If the includeChildSubsites argument is true, this is the number of pages in the subsite and descendant subsites. Otherwise, this is the number of pages in the current subsite. Otherwise, this is the number of pages within the current subsite.
PageSetsCount	NonNegativeInteger	If the includeChildSubsites argument is true, this is the number of Page Sets in the subsite and descendant subsites, Otherwise, this is the number of Page Sets in the current subsite.
RegisteredURLCount	NonNegativeInteger	If the includeChildSubsites argument is set to true, this is the number of registered URLs in the subsite and descendant subsites. Otherwise, this is the number of registered URLs in the current subsite.
TemplatesCount	NonNegativeInteger	If the includeChildSubsites argument is true, this is the number of templates in the subsite and descendant subsites. Otherwise, this is the number of templates in the current subsite.
UploadedDocumentCount	NonNegativeInteger	If the includeChildSubsites argument is true, this is the number of uploaded documents in the subsite and descendant subsites. Otherwise, this is the number of uploaded documents in the current subsite.

Arguments:

Name	Type	Required	Description
subsiteIDOrURL	SubsiteIDorURL_EmptyString	Required	The ID of the target subsite, or the server relative path to the target subsite, or an empty string for the current subsite.
includeChildSubsites	Boolean	Required	Boolean flag which when set to true indicates the that CommonSpot returns information about this subsite's children.

Context:

License Requirements	None
Permission Requirements	ContributorOrServerCode
Deny Context	None
Require Context	None
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	This method may be customized at the site level

Error Codes:

None

Notes:

None