Skip to content

historicalSearches

Historical Message Trace. Run async message-trace report jobs over extended history. The historicalSearches entity set lives under /exchange/v1.0/historicalSearches in the Reports & insights category.

Fact Value
Path /exchange/v1.0/historicalSearches
Category Reports & insights
Tier Tier 8, Reports
Read role Reports.Read.All (Community)
Write role none (read-only)
Backing cmdlets Get-HistoricalSearch, Start-HistoricalSearch, Stop-HistoricalSearch
Method Path Synopsis Role Plan
GET /exchange/v1.0/historicalSearches List historicalSearches entries. Reports.Read Community
GET /exchange/v1.0/historicalSearches/{jobId:guid} Get a single historicalSearches entry by Identity. Reports.Read Community

List historicalSearches entries.

Backing cmdlet: Get-HistoricalSearch. Role: Reports.Read (Community).

Stub auto-generated example for the historicalSearches collection. Backing cmdlet: Get-HistoricalSearch. Live-verify with ?$top=3&$select=Id,Name and replace the synthetic body before promoting to Tier 1.

GET /exchange/v1.0/historicalSearches?$top=3 HTTP/1.1
Authorization: Bearer {token}
HTTP/1.1 200 OK
{
"@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#historicalSearches",
"value": []
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

Related: GET /exchange/v1.0/historicalSearches/{key}

GET /exchange/v1.0/historicalSearches/{jobId:guid}

Section titled “GET /exchange/v1.0/historicalSearches/{jobId:guid}”

Get a single historicalSearches entry by Identity.

Backing cmdlet: Get-HistoricalSearch. Role: Reports.Read (Community).