--- title: "Generate a Hit Report" slug: "generate-a-hit-report" tags: ["Generate a Hit Report", "Hit Report"] updated: 2026-03-10T13:21:09Z published: 2026-03-10T13:21:09Z --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.revealdata.com/llms.txt > Use this file to discover all available pages before exploring further. # Generate a Hit Report Hit Reports shares a Project Admin screen with [***Wordlists***](/reveal/docs/create-manage-wordlists). Hit Reports allow administrators to create and folder results of a list of search terms. Terms are added, one per line. Boolean operators (AND, OR, NOT) and [***RQL search syntax***](/reveal/docs/reveal-query-language) may be used in generating this report. The reports that are generated provide insight into the search terms, for example, how many documents hits in a document on a specific term, how many unique documents hit one term and none of the other terms in the search, and the total number of hits on a particular term. ![Overview of Hit Reports in Project Admin with job details and processing status.](https://cdn.us.document360.io/3e21d801-ca9f-4c51-93db-9cbd32741f3d/Images/Documentation/HitReportScreen_2025.5.png) 1. Hit Reports are accessed by going to the **Project Admin** screen, selecting **Wordlists** and choosing the **Hit Reports** tab on the left side of the screen. 2. You may create a Hit Report by clicking **+Add** at the upper left of the table.![](https://cdn.us.document360.io/3e21d801-ca9f-4c51-93db-9cbd32741f3d/Images/Documentation/add-hit-report-new-search-profile.png) 3. Enter a unique **Job Name**. 4. Select a **Source Work Folder** if you wish to only apply the search to a certain set of documents, otherwise the Hit Report will run on the entire contents of the database. 5. Enter the **Search Terms**, one term per line, in the Search Terms box, with phrases set out between quotation marks (*e.g.*, *"quotation marks"*). 6. Choose a profile from **Search Profiles**drop down menu. 7. Select **Optional Output** either when adding or editing later and choose your options: 1. Create [**work folder**](/reveal/docs/create-work-folders) for each term. ![Settings for adding a hit report with options for output and folder management.](https://cdn.us.document360.io/3e21d801-ca9f-4c51-93db-9cbd32741f3d/Images/Documentation/AddHitReport-OptionalOutput_2025.5.png) 2. Create [**saved search**](/reveal/docs/saved-searches) for each term, clicking the ellipses **[…]** button to select a saved search folder in which to put it. 3. Populate a field with search results, which lets you… 1. Creating a **New** field within a specified Field Profile (and optionally making it initially visible), OR 2. Specifying an **Existing** custom multi-value field that you specify to store the results. 3. To create a New field: 1. Click on the ellipses next to the **Populate field with search results** field. The Select Field window appears. ![Dialog box for selecting a new or existing field in a software application.](https://cdn.us.document360.io/3e21d801-ca9f-4c51-93db-9cbd32741f3d/Images/Documentation/AddHitReportModal-OutpionalOutput-SelectFieldModal_2025.5.png) 2. In the **New** field, enter a name for the field, and use the dropdown to add it to the selected Field Profile. 3. Select the **Initially Visible** checkbox. 4. Choose **OK** to finish the field creation. 4. If you’re using an existing field profile, choose whether to… 1. **Append new results**, which will add all new hit results to the existing field. 2. **Overwrite with new results**, which will scrap and replace your old hit report. 4. Populate root folder, which will populate a root work folder with unique results from ALL hit report search terms; you may populate the same root folder selected for “Create work folder for each term” or a different root folder. 8. Choose **ADD** to complete the Hit Report (or **EDIT** if modifying the Hit Report). 1. If you’ve chosen to overwrite a field profile with new results, a confirmation pop-up will appear with the message, “Are you sure you want to overwrite existing results? Any previous values will be cleared.” Click **SAVE** to confirm and proceed with the override. 9. Once returned to the main Hit Reports table, click the down-arrow next to the Status icon to select **Start** to run the report job. You will be prompted “*This will start processing hit report job ''. Are you sure?*” Click **YES** to confirm. ![Dropdown menu showing options to start, edit, or delete job reports.](https://cdn.us.document360.io/3e21d801-ca9f-4c51-93db-9cbd32741f3d/Images/Documentation/StartHitReportDropdown_2025.5.png) 10. Choose the **Refresh** button until the Job shows a green check mark under Status indicating it is complete. - The Hit Report Results modal has an option to **Export** the results into an XLS format file, next to the Refresh button. 11. Select the same dropdown next to the status icon and choose **View Results** to see the details of the report. 12. The results screen provides the following columns: 1. **Doc Hit Count:** The number of documents that contain each search term. 2. **Family Count:** The number of documents when family members are included in the Search Results. 3. **No Hits**: The number of documents that do not contain the search terms for each query. 4. **Uniqueness:** The number of unique documents that contain hits for the search term. 5. **Inclusiveness:** The percentage of documents that contain the search term as compared to the entire document count of the database. 13. In this modal, there are additional metadata results included found by all of the Search Terms, such as **Source**,**Search Profiles**, **Total Unique Documents**, **Documents Without Hits**, **Documents Searched**,**Term Folders**, **Saved Searches**, **Field With Results**, and **Work Folders.** ![](https://cdn.us.document360.io/3e21d801-ca9f-4c51-93db-9cbd32741f3d/Images/Documentation/hit-report-results-modal%20.png) ## Related - [Search Concepts](/search-concepts.md) - [Metadata Filtering](/metadata-filtering.md) - [Create a Term List](/create-a-term-list.md) - [Basic Search Augmentations In Reveal](/basic-search-augmentations-in-reveal.md) - [Saved Searches](/saved-searches.md)