SplatDev.Umbraco.Plugins.ExamineExtensions 1.2.4

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package SplatDev.Umbraco.Plugins.ExamineExtensions --version 1.2.4
                    


                    

                
NuGet\Install-Package SplatDev.Umbraco.Plugins.ExamineExtensions -Version 1.2.4
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="SplatDev.Umbraco.Plugins.ExamineExtensions" Version="1.2.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="SplatDev.Umbraco.Plugins.ExamineExtensions" Version="1.2.4" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SplatDev.Umbraco.Plugins.ExamineExtensions" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add SplatDev.Umbraco.Plugins.ExamineExtensions --version 1.2.4
                    


                    

                
#r "nuget: SplatDev.Umbraco.Plugins.ExamineExtensions, 1.2.4"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package SplatDev.Umbraco.Plugins.ExamineExtensions@1.2.4
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=SplatDev.Umbraco.Plugins.ExamineExtensions&version=1.2.4
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=SplatDev.Umbraco.Plugins.ExamineExtensions&version=1.2.4
                    


                            Install as a Cake Tool

ExamineExtensions

Examine search extensions for Umbraco — query helpers, index inspection, and rebuild management via a backoffice dashboard.

NuGet

Compatibility

Umbraco .NET Package Version
13.x 8.0 2.0.0
17.x 10.0 2.0.0

Installation

dotnet add package SplatDev.Umbraco.Plugins.ExamineExtensions

Quick Start

The plugin auto-registers via PluginComposer. Inject IExamineExtensionsService where needed:

public class SearchController : SurfaceController
{
    private readonly IExamineExtensionsService _examine;

    public SearchController(IExamineExtensionsService examine)
    {
        _examine = examine;
    }
}

API Endpoints

Method Route Description
GET /umbraco/api/examineextensions/GetIndexes List available Examine indexes
POST /umbraco/api/examineextensions/Search Search across indexes with query and pagination
POST /umbraco/api/examineextensions/RebuildIndex Trigger a full index rebuild

Usage

Search query body:

{
    "query": "search term",
    "page": 1,
    "pageSize": 20
}

The dashboard provides a UI for browsing indexes, running searches, and triggering rebuilds directly from the Umbraco backoffice.

Known Limitations

  • Search wraps Examine's ManagedQuery/GroupedOr with basic pagination only — no advanced query DSL, filters, or sorting
  • RebuildIndex performs a full index recreation (CreateIndex()) rather than an incremental rebuild
  • No caching of search results; every call queries the index directly
  • No authorization on API endpoints

Changelog

1.2.4 — 2026-08-24

Removes a dashboard screenshot that showed an error toast. It was captured against a site where this plugin's API was unreachable, so it advertised a broken dashboard. No screenshot is better than a misleading one; a replacement will be taken against a working install.

1.2.3 — 2026-08-24

Package metadata only: the listing now carries an icon and search tags, and the project and repository links point at the organisation that actually hosts this code. No code changes.

1.2.2 — 2026-08-21

  • Dashboard now sends the backoffice token with its API calls. On Umbraco 17 those calls were arriving unauthenticated and coming back 401, which the dashboard rendered as an empty state rather than an error.
  • A failed request now raises a notification instead of leaving the dashboard looking like there is simply no data.

License

MIT © SplatDev

Architecture

This is a headless library — no standalone backoffice dashboard or property editors. It extends Umbraco's built-in Examine backoffice UI with additional API endpoints and index features, operating as a DI-registered service.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.2.4 40 8/24/2026