Reports (Component)

The Report object contains built-in report methods that you can use to obtain information about your CommonSpot installation.

Transactions are not logged for any methods in this component.

Customization is not supported for this component.

Methods:

getBaseTemplates	Returns zero or more structures, each containing information about the specified subsite's base templates.
getBlockedApprovals	Returns zero or more structures containing information about pages that are pending approval and whose approval is blocked by a user who's account has expired or is no longer a contributor.
getBlockedApprovalsCount	Returns the count of pages that are pending approval and whose approval is blocked by a user who's account has expired or is no longer a contributor.
getExpiredPages	Returns information about pages scheduled to expire within the next year.
getExpiredPagesCount	Returns the count of pages scheduled to expire within the next year.
getImageReportData	Returns zero or more structures, each containing information about an image. Structure information includes the image's description, file name, file size, ID, and so on.
getImagesByLinkReference	Returns zero or more structures, each containing image information and how many links exist to the image.
getInactivePages	Returns zero or more structures, each containing information about inactive pages; for example, 'Description', 'FileName', 'MyApprovalNeeded', 'MyWIP', 'OthersApprovalNeeded' and so on. This method's arguments let you limit the amount of information CommonSpot returns.
getInactivePagesCount	Returns the number of inactive pages . This method's arguments tell CommonSpot to return a number for a subset of these pages.
getInvalidUploadedDocumentsLocation	Returns zero or more structures, each containing information about uploaded documents which are not in correct location or are invalid.
getLockedPages	Returns zero or more structures, each containing information on locked pages. This method's arguments limit the information returned.
getLockedPagesCount	Returns the number of locked pages. This method's argument's tell CommonSpot to only include some of the locks.
getMissingWebPOrBaseImages	Returns zero or more structures, each containing information about missing WebP versions of an image. Structure information includes the image's description, file name, file size, ID, and so on.
getMultimediaFilesByLinkReference	Returns zero or more structures, each containing multimedia file information and how many links exist to the file.
getMultimediaReportData	Returns zero or more structures, each containing information about a multimedia file. Structure information includes the item's description, file name, file size, length, ID, and so on.
getMyImages	Returns zero or more structures, each containing information on images owned by the current user. This method's arguments limit the information returned.
getMyMultimediaFiles	Returns zero or more structures, each containing information on multimedia files owned by the current users. This method's arguments limit the information returned.
getMyPages	Returns zero or more structures, each containing information on pages owned by the current user. This method's arguments limit the information returned.
getMyPageSets	Returns zero or more structures, each containing information on page sets owned by the current users. This method's arguments limit the information returned.
getMyPlaylists	Returns zero or more structures, each containing information on playlists owned by the current users. This method's arguments limit the information returned.
getMyRegisteredURLs	Returns a structure whose members contain information about the current user's registered URLs; for example, Description', 'FileName' and so on.
getMyTemplates	Returns zero or more structures, each containing information on templates owned by the current user. This method's arguments limit the information returned.
getMyUploadedDocuments	Returns zero or more structures, each containing information on uploaded documents owned by the current user. This method's arguments limit the information returned.
getNotes	Returns zero or more structures, each containing information on a note and the object to which it is attached.
getPageData	Returns a structure whose members contain information for the specified pages. If the current user cannot see a page and one of these page's is in the pageIDList argument, CommonSpot does not return information for it.
getPagesByLinkReference	Returns zero or more structures, each containing information on the pages, templates, uploaded documents, and registered URLs that meet the specified criteria and how many pages refer to them.
getPageSets	Returns zero or more structures, each containing information about the requested page sets; for example, its name, description, owner, the number of pages in it, and so on.
getPagesWaitingForApproval	Returns zero or more structures, each of which contains information on pages and templates containing information about a page that is waiting to be approved. Structure members contain information on a page and the user who owns it. This member's arguments can limit the amount of information returned.
getPagesWhereLangOutOfSync	Returns zero or more structures, each containing information about pages where the language specified for the page does not match the language specified for its subsite.
getPagesWithBrokenLinks	Returns zero or more structures, each containing information on a pages or template having broken links. This member's arguments limit the amount of returned information.
getPagesWithBrokenLinksCount	Returns the number of pages having broken links the meet the specified criteria. You can obtain a number indicating a subset of these pages by using this member's arguments.
getPagesWithErrors	Returns a list of pages that have errors on them.
getPendingMultimediaUploads	Returns zero or more structures, each containing information about inactive multimedia files or with pending uploads; for example, 'Description', 'FileName', 'MyApprovalNeeded', 'MyWIP', 'OthersApprovalNeeded' and so on. This method's arguments let you limit the amount of information CommonSpot returns.
getPendingMultimediaUploadsCount	Returns the number of pending multimedia file uploads . This method's arguments tell CommonSpot to return a number for a subset of these multimedia files.
getPlaylists	Returns zero or more structures, each containing information on the current user's playlists; for example, it's description, owner, the number of multimedia files within the playlist, and so on.
getReportData	Structure whose members contain information about a page; for example, a page's description, and file name. Other members indicate if the page needs the current user's approval, if it is a work in progress page for the current user, and so on.
getScheduledForExpiration	Returns information about pages that have expired.
getScheduledForExpirationCount	Returns the number of pages, templates, and uploaded documents that are scheduled to be expired. This member's arguments limit this value to subset of the pages scheduled for expiration.
getScheduledForPublication	Returns zero or more structures, each containing information on pages, templates, and uploaded documents that are scheduled to be published.
getScheduledForPublicationCount	Returns the number of pages, templates, and uploaded documents that are scheduled for publication. This member's arguments limit this value to subset of the pages scheduled for publication.
getSubsitePagesAndDirs	Returns zero or more structures, each containing information about a subsite's directories and pages.
getSubsites	Returns zero or more structures, each containing information about a search collection's full name and the subsite in which it resides. This method's argument create a subset of the information returned.
getSubsitesWithPermissionInfo	Returns information about subsites and their permissions based on the passed filter criteria.
getVisibleTemplates	Returns zero or more structures, each containing information on a site's template's.
getVisibleTemplatesCount	Returns zero or more structures, each containing information on a site's template's count.
getWhatsNew	Returns zero or more records describing content that has been recently created in the site.