---
title: "Performs a text search query"
method: GET
path: "/search/text"
tags: ["FULL TEXT SEARCH"]
---

# Performs a text search query

`GET /search/text`

It performs a text search query across metrics and instance domains - all forms of names and help texts.

The mandatory search string is further described in [pmsearch](https://man7.org/linux/man-pages/man1/pmsearch.1.html)(1) and is passed to the server via the *query* parameter (HTTP GET).
```bash
$ curl -s http://localhost:44322/search/text?query=halt | pmjson
```
The available search entity *types* are *metric*, *indom* and *instance*. Query parameters *highlight* and *field* take *name*, *oneline* and *helptext*.

Query parameter *return* takes *name*, *type*, *oneline*, *helptext*, *indom*. There is typically both a name and help text associated with metrics. Contents of these are then matched 
against *query*. An instance domain has help text and a numeric identifier, while instances have a name only (which can be searched).

**Reference:** [pmSearchTextQuery](https://man7.org/linux/man-pages/man3/pmSearchTextQuery.3.html)(3)

## Query parameters

- `query` string
- `highlight` unknown
- `offset` number
- `limit` number
- `field` unknown
- `return` unknown
- `type` unknown

## Response `200`

OK

---

[API](https://skmtc.dev/performancecopilot/apis/pmwebapi.md) · [All operations](https://skmtc.dev/performancecopilot/apis/pmwebapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/performancecopilot/pmwebapi/revisions/666212c8ed6b/schema)