> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# analyticsCatalogSearch

> Search the analytics catalog by name, synonym or value, one result per term. Use it to check whether something can be reported on before asking for a report.

**Required scopes:** [`analytics_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-analytics_read)

## Arguments

**terms** `[String!]!` *required*

Words or phrases to look for, such as `refund` or `carrier`, at most 10.

## Returns

**analyticsCatalogSearch** *required*

The best catalog matches for one search term.

**fields**

**matches** *required*

The best matches, best first.

**fields**

**entity** `String!` *required*

The entity it is, or belongs to.

**kind** *required*

What matched.

**label** `String!` *required*

Its label.

**member** `String`

The field or definition's name. Null for an entity.

**role** `String`

For a definition, what it is, such as `metric` or `filter`.

**term** `String!` *required*

The term searched for.

**totalCount** `Int!` *required*

How many matches there were in all.

## Example

```graphql theme={null}
query {
  analyticsCatalogSearch(terms: "...") {
    term
    totalCount
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.