Jump to Content
HawkSearch Website
HawkSearch Dashboard
HawkSearch User Guide
Home
Guides
API Reference
v1.0
HawkSearch Website
HawkSearch Dashboard
HawkSearch User Guide
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Home
Guides
API Reference
Get synonyms
Search
JUMP TO
Overview
Introduction
Other Developer Tools
Authentication
Environment and Endpoints
Indexing Api
GroupHierarchy
Upsert
post
Rebuild
post
GroupIndexing
Create
post
Delete index
post
Set current
post
Unset current
post
Index items
post
Update items
post
Hierarchy
Upsert hierarchy
post
Rebuild index hierarchy
post
Delete all hierarchy items
post
Delete items from hierarchy
post
IndexV2
Get indexes
get
Get current index name
get
Create new index
post
Set Index Alias
post
Index items
post
Update items
post
Delete item
post
Delete items
post
Delete index
post
Delete index by indexName
delete
Set current index
post
Unset current index
post
Rebuild autocomplete
post
Rebuild percolator
post
Rebuild learning
post
Rebuild related
post
Rebuild all
post
Add attributes to items
post
Remove attributes from items
post
Bulk item operations
post
Mapping
Get mappings
post
Upsert mapping
post
Ping
Ping
get
search api
SearchV2
Search
post
AutocompleteV2
Autocomplete
post
CompareV2
Compare
post
Ping
Ping
get
RecommendATION API
Recommendation
Get recommendation widgets
post
Get multiple recommendation widgets
post
HawkSearch.Api
Banner
Get banners
get
Add banner
post
Get banner by id
get
Update banner by id
put
Delete banner by id
delete
Get banner by guid
get
Update banner by guid
put
Delete banner by guid
delete
Get campaigns by banner id
get
Get campaigns by banner guid
get
BannerZone
Get banner zones
get
BoostBury
Get boost bury rules
get
Add boost bury rule
post
Gets a single rule by its id
get
Update boost bury rule by id
put
Delete boost bury rule by id
delete
Get boost bury rule by guid
get
Update boost bury rule by guid
put
Delete boost bury rule by guid
delete
Campaign
Get campaigns
get
Add campaign
post
Get campaign by id
get
Update campaign by id
put
Delete campaign by id
delete
Get campaign by guid
get
Update campaign by guid
put
Delete campaign by guid
delete
Definition
Regenerate index definition
post
Facet
Get facets
get
Add facet
post
Get facet by id
get
Update facet by id
put
Delete facet by id
delete
Get facet by guid
get
Update facet by guid
put
Delete facet by guid
delete
Field
Get fields
get
Add field
post
Get field by id
get
Update field by id
put
Delete field by id
delete
Get field by guid
get
Update field by guid
put
Delete field by guid
delete
Adds multiple fields to HawkSearch in bulk.
post
FieldInfo
Get field info
get
Get field info by id
get
Index
Trigger re-index
post
LandingPage
Get landing page by id
get
Update landing page by id
put
Delete landing page by id
delete
Get landing page by guid
get
Update landing page by guid
put
Delete landing page by guid
delete
Get Landing Page urls
get
Get custom fields on landing pages
get
Update multiple landing pages
put
Add multiple landing pages
post
Delete multiple landing pages
delete
/api/LandingPage/{guid}
delete
Delete multiple landing pages by url
delete
Delete multiple landing pages by guid
delete
Get fields
get
Get landing page by url
get
Update landing page by url
put
Delete landing page by url
delete
Get landing page by custom field
get
Update landing page by custom field
put
Delete landing page by custom field
delete
Add landing page
post
LandingPageLayout
Get landing page layouts
get
/api/v11/landingPageLayout
post
Get landing page layout by id
get
Update landing page layout
put
Delete landing page layout
delete
Get landing page layout by name
get
PaginationSet
Get paginationset by id
get
Update paginationset by id
put
Delete paginationset by id
delete
Get all paginationsets
get
Add paginationset
post
Ping
Ping
get
RecommendationVisibility
Get recommendation visibility rules
get
Add recommendation visibility rule
post
Gets a single rule by its id
get
Update recommendation visibility rule by id
put
Delete recommendation visibility rule by id
delete
Add multiple recommendation visibility rules
post
Redirect
Get redirects
get
Add redirect
post
Get redirect by id
get
Update redirect by id
put
Delete redirect by id
delete
Report
Get activity funnel report data
post
Get autocomplete click summary report data
post
Get average number of results daily report data
post
Get number of clicks daily report data
post
/api/v11/reports/conversion
post
Get conversion tracking summary report data
post
Get devices usage report data
post
Get keyword list summary report data
post
Get pagination activity daily report data
post
Get searches with poor results report data
post
Get searches with poor results list report data
post
Get number of searches daily report data
post
Get spelling suggestion activity daily report data
post
Get top 250 keywords by clicks report data
post
Get top 250 facets report data
post
Get top 250 search keywords report data
post
Get number of unique users daily report data
post
Get content items tracking daily report data
post
Get recommendations report data
post
Get keyword list summary report data
post
Get live stream data
post
Get redirect tracking daily report data
post
Get spelling suggestion tracking daily report data
post
Get landing page facets report data
post
ReportV2
Get top keywords with clicks report data
post
Get top keywords with clicks report data
post
Get top keywords with clicks report data
post
Get searches with poor results summary data
post
Gets spelling suggestion tracking daily data
post
Gets conversion tracking summary data
post
Gets conversion tracking list data
post
Gets top keyword list data
post
Site
Get list of child sites
post
Get sites info by ApiKey
post
Sitemap
Get sitemap
get
SortingSet
Get sortingset by id
get
Update sortingset by id
put
Delete sortingset by id
delete
Get sortingsets
get
Add sortingset
post
Spellcheck
Get spellcheck override by id
get
Update spellcheck override by id
put
Delete spellcheck override by id
delete
Get spellcheck overrides
get
Add spellcheck override
post
Synonym
Get synonyms
get
Add synonym
post
Get synonym by id
get
Update synonym by id
put
Delete synonym by id
delete
Get synonym by guid
get
Update synonym by guid
put
Delete synonym by guid
delete
Visibility
Get visiblity rules
get
Add visiblity rules
post
Get visiblity rule by id
get
Update visiblity rule by id
put
Delete visiblity rule by id
delete
Get visiblity rule by guid
get
Update visiblity rule by guid
put
Delete visiblity rule by guid
delete
VisitorTarget
Get visitor targets
get
Add visitor target
post
Get visitor target by id
get
Update visitor target by id
put
Delete visitor target by id
delete
Get visitor target by guid
get
Update visitor target by guid
put
Delete visitor target by guid
delete
Add multiple visitor targets
post
TRACKING API
TrackEvent
Track Event
post
Powered by
Get synonyms
get
https://dev.hawksearch.net/api/v11/Synonym
Gets all Synonyms in the system
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!