# Interface IQueryResult

The `IQueryResult` interface describes a single result returned by the Coveo REST Search API.

## Index

### Properties

- absentTerms
- childResults
- clickUri
- excerpt
- flags
- hasHtmlVersion
- index
- isRecommendation
- isTopResult
- isUserActionView
- parentResult
- printableUri
- queryUid
- rankingInfo
- rating
- raw
- searchInterface
- state
- title
- uniqueId
- uri

## Properties

### absentTerms

absentTerms: string[]

- Defined in rest/QueryResult.ts :167

The query terms that are not matched by the result.

### childResults

childResults: IQueryResult[]

- Defined in rest/QueryResult.ts :98

Contains the child results of the item, if parent-child loading was performed.

See the `Folding` component.

### clickUri

clickUri: string

- Defined in rest/QueryResult.ts :30

Contains the clickable URI of the item, which you can set on an `href` in your search interface.

See the `ResultLink` component.

### excerpt

excerpt: string

- Defined in rest/QueryResult.ts :44

Contains an excerpt of the item. Can be empty for certain types of items (e.g., images, videos, etc.).

See the `Excerpt` component.

### flags

flags: string

- Defined in rest/QueryResult.ts :60

Contains the list of flags for the item. Values are separated by a semicolon characters (`;`).

### hasHtmlVersion

hasHtmlVersion: boolean

- Defined in rest/QueryResult.ts :54

Contains a value specifying whether the item has an HTML version.

See the `Quickview` component.

### Optional index

index: number

- Defined in rest/QueryResult.ts :126

Contains the 0-based index value of the result, as returned by the Coveo REST Search API.

### isRecommendation

isRecommendation: boolean

- Defined in rest/QueryResult.ts :107

Contains a value that specifies whether the result was recommended by the Coveo Machine Learning service.

See the `Recommendation` component.

See also Coveo Machine Learning.

### isTopResult

isTopResult: boolean

- Defined in rest/QueryResult.ts :117

Specifies whether the result is a Featured Result in the Coveo Query Pipeline (see Adding and Managing Query Pipeline Featured Results).

### Optional isUserActionView

isUserActionView: boolean

- Defined in rest/QueryResult.ts :112

Whether the result item was previously viewed by the user specified in the userActions request of the query.

### Optional parentResult

parentResult: IQueryResult

- Defined in rest/QueryResult.ts :91

Contains the parent result of the item, if parent-child loading was performed.

See the `Folding` component.

### printableUri

printableUri: string

- Defined in rest/QueryResult.ts :22

Contains a printable URI (or path) to the item.

### Optional queryUid

queryUid: string

- Defined in rest/QueryResult.ts :135

Contains the query UID, as returned by the Coveo REST Search API.

This value is used mainly for usage analytics.

The Coveo JavaScript Search Framework adds this property client-side to each result.

### rankingInfo

rankingInfo: string

- Defined in rest/QueryResult.ts :68

Contains ranking information, which the Coveo REST Search API returns along with the item when the query `debug` property is `true`.

### Optional rating

rating: number

- Defined in rest/QueryResult.ts :79

Note:

> The Coveo Cloud V2 platform does not support collaborative rating. Therefore, this property is obsolete in Coveo Cloud V2.

Contains the collaborative rating value for the item.

See the `ResultRating` component.

### raw

raw: any

- Defined in rest/QueryResult.ts :84

Contains the raw field values of the item, expressed as key-value pairs.

### searchInterface

searchInterface: SearchInterface

- Defined in rest/QueryResult.ts :159

The `SearchInterface` inside which this result is rendered.

This value is used mainly to allow for conditional rendering of results templates.

The Coveo JavaScript Search Framework adds this property client-side to each result.

### state

state: object

- Defined in rest/QueryResult.ts :150

Contains the query state of the `SearchInterface` inside which this result is rendered.

This value is used mainly to allow for conditional rendering of results templates.

The Coveo JavaScript Search Framework adds this property client-side to each result.

#### Type declaration

- ##### [attribute: string]: any

### title

title: string

- Defined in rest/QueryResult.ts :11

Contains the title of the item.

### uniqueId

uniqueId: string

- Defined in rest/QueryResult.ts :37

Contains the unique ID of the item.

This parameter is useful when making certain calls to a `SearchEndpoint`.

### uri

uri: string

- Defined in rest/QueryResult.ts :17

Contains the URI of the item.

### Hierarchy

- IQueryResult