Site objects
- Applies to:
- All versions
- Role required:
- Draft Contributor
The site object includes site-wide properties such as site page count and the homepage URL along with site configurations such as the site hostname and site API URIs.
site.api : str
Returns a string with the site's API URI.
| DekiScript | Output |
|---|---|
site.api; |
https://expert-help.nice.com/@api/deki |
site.homepage
Returns the page object of the site's home page.
| DekiScript | Output |
|---|---|
site.homepage.uri; |
https://expert-help.nice.com/ |
site.hostname : str
Returns the site's host name.
| DekiScript | Output |
|---|---|
site.hostname; |
expert-help.nice.com |
site.pagecount : num
Returns the total number of pages on your NiCE KM site.
| DekiScript | Output |
|---|---|
site.pagecount; |
3670 |
site.tags : map
Returns a map of all the tag objects for the entire site.
Only use this on pages that are accessible to administrators and are accessed rarely.
site.uri : str
Returns a string with the site's URI.
| DekiScript | Output |
|---|---|
site.uri; |
https://expert-help.nice.com/ |
site.usercount : num
Returns the total number of registered users on your NiCE KM site.
| DekiScript | Output |
|---|---|
site.usercount; |
495 |
site.users : map
Deprecated: This property has been deprecated and will only return an empty list
Returns a map of user objects for the entire site.
Only use this on pages that are accessible to administrators and are accessed rarely.