CSApplication.GetDocumentStatistics Method

CSApplicationGetDocumentStatistics Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Gets the document statistics for a specific web site. This statistic includes the

The total number of documents.
The number of published (live) documents.
The number of archived documents.
The number of not published documents (including the ones in the recycling bin).
The number of not classified documents

Namespace: ContentStudio
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

public DocumentStatisticsInformation GetDocumentStatistics(
	ConnectionId connectionId,
	SessionId sessionId
)

Public Function GetDocumentStatistics ( 
	connectionId As ConnectionId,
	sessionId As SessionId
) As DocumentStatisticsInformation

connectionId: Type: ContentStudioConnectionId
A value that identifies the web site
sessionId: Type: ContentStudio.SecuritySessionId
A value that identifies the users session. This value usually originates from a call to OpenSession(ConnectionId).

Type: DocumentStatisticsInformation
a DocumentStatisticsInformation object containing statistical information about documents on the site.

Content Studio permissions

All authenticated and anonymous users, can call this method.

Remarks

This method is new in Content Studio 5.2

Note
The statistics is maintained by the Service Manager and depending on how busy the Service Manager is, the returned data sometimes can differ from the actual values when one or more documents has recently changed their statuses.