Query string parameters define which data is retrieved and how it is processed in a Site Report.
The Site Report automatically generates the appropriate query string.
The parameters below are provided for reference only.
📑 Parameters
| Parameter | Purpose | Example |
|---|---|---|
| DataSource | Sets the source content query. Currently only All is supported. |
DataSource=All |
| ProcessComplianceData | Processes data to determine who has and has not read mandatory content. ⚠️ Do not use with History=True (only the most recent entry is needed for compliance) or with date ranges (log entries will be missing). |
ProcessComplianceData=True |
| Report | Sets the report to load into the pivot table. Can be a standard or custom report. | Report=standard-All Reads |
| IncludeOptional | Includes content with optional terms. | IncludeOptional=True |
| History | Includes log version history. ⚠️ May cause long processing times. Use with StartDate and EndDate to limit content. |
History=False |
| StartDate | Defines the start date for log queries. Use explicit YYYY-MM-DD format or relative values (Day, Month, Year - number). Example: Day-1 = yesterday. |
StartDate=Day-365 |
| EndDate | Defines the end date for log queries. Use explicit YYYY-MM-DD format or relative values. Day = today. Month and Year calculate to the last day of the period. |
EndDate=Day |
| HideTotal | Hides totals in the pivot report. | HideTotal=True |
| ReportOnly | Displays only the report, hiding pivot table fields. | ReportOnly=True |
| Views | Extracts the most recent views per page/person. Range: 1–100. |
Views=100 |
| ContentSearch | Filters content using a search query. | ContentSearch=Title:Policy |
| LogSearch | Refines log entries using search terms. | SearchTerms='reviewedBy:Pending' |
📌 Example Report Link
A Site Report will generate a query string similar to:
{Site}/SitePages/CTFiles/Site-Report.aspx?DataSource=All&ProcessComplianceData=False&Report=standard-Feedback%20pending%20review&ReportOnly=True&HideTotal=True&StartDate=Day-365&EndDate=Day&History=False&IncludeOptional=True&SearchTerms=%27reviewedBy%3APending%27&Views=100