@empathyco/x-components
Version:
Empathy X Components
245 lines (105 loc) • 2.52 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [SearchResponse](./x-types.searchresponse.md)
## SearchResponse interface
Response for the search endpoint.
**Signature:**
```typescript
export interface SearchResponse
```
## Properties
<table><thead><tr><th>
Property
</th><th>
Modifiers
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[banners?](./x-types.searchresponse.banners.md)
</td><td>
</td><td>
[Banner](./x-types.banner.md)<!-- -->\[\]
</td><td>
_(Optional)_
</td></tr>
<tr><td>
[displayTagging?](./x-types.searchresponse.displaytagging.md)
</td><td>
</td><td>
[TaggingRequest](./x-types.taggingrequest.md)
</td><td>
_(Optional)_
</td></tr>
<tr><td>
[facets?](./x-types.searchresponse.facets.md)
</td><td>
</td><td>
[Facet](./x-types.facet.md)<!-- -->\[\]
</td><td>
_(Optional)_
</td></tr>
<tr><td>
[partialResults?](./x-types.searchresponse.partialresults.md)
</td><td>
</td><td>
[PartialResult](./x-types.partialresult.md)<!-- -->\[\]
</td><td>
_(Optional)_
</td></tr>
<tr><td>
[promoteds?](./x-types.searchresponse.promoteds.md)
</td><td>
</td><td>
[Promoted](./x-types.promoted.md)<!-- -->\[\]
</td><td>
_(Optional)_
</td></tr>
<tr><td>
[queryTagging?](./x-types.searchresponse.querytagging.md)
</td><td>
</td><td>
[TaggingRequest](./x-types.taggingrequest.md)
</td><td>
_(Optional)_
</td></tr>
<tr><td>
[redirections?](./x-types.searchresponse.redirections.md)
</td><td>
</td><td>
[Redirection](./x-types.redirection.md)<!-- -->\[\]
</td><td>
_(Optional)_
</td></tr>
<tr><td>
[results](./x-types.searchresponse.results.md)
</td><td>
</td><td>
[Result](./x-types.result.md)<!-- -->\[\]
</td><td>
</td></tr>
<tr><td>
[spellcheck?](./x-types.searchresponse.spellcheck.md)
</td><td>
</td><td>
string
</td><td>
_(Optional)_
</td></tr>
<tr><td>
[stats?](./x-types.searchresponse.stats.md)
</td><td>
</td><td>
[Stats](./x-types.stats.md)
</td><td>
_(Optional)_
</td></tr>
<tr><td>
[totalResults](./x-types.searchresponse.totalresults.md)
</td><td>
</td><td>
number
</td><td>
</td></tr>
</tbody></table>