Versions Compared

Old Version 6

changes.mady.by.user Shree Harsha Sridharamurthy

Saved on

compared with

New Version Current

changes.mady.by.user Lana Starchuk

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This API allows you to create a facet in Hawksearch dashboard and manage the facet configurations.

Example use case: Create a Brand facet that can be used as a facet filter.

...

Code Block
languagejson
POST /api/v9/facet HTTP/1.1
Host: managedashboard-na.hawksearch.com
X-HawkSearch-ApiKey: USE_YOUR_API_KEY
Cache-Control: no-cache
Postman-Token: cd457184-4c00-a650-62f2-530f22a9a384
    
    {
        "SyncGuid": "00000000-0000-0000-0000-000000000000",
        "FacetId": 0,
        "Name": "Brand",
        "FacetType": "checkbox",
        "FieldType": "string",
        "MaxCount": 0,
        "MinHitCount": 0,
        "Field": "brand",
        "Param": null,
        "DisplayType": "default",
        "ScrollHeight": 0,
        "ScrollThreshold": 0,
        "TruncateThreshold": 0,
        "SearchThreshold": 0,
        "SortOrder": 0,
        "ExpandSelection": false,
        "IsCurrency": false,
        "IsNumeric": false,
        "IsSearch": false,
        "IsVisible": true,
        "UBound": null,
        "LBound": null,
        "Increment": "0",
        "NofVisible": 0,
        "Height": 0,
        "DisplayRuleXML": null,
        "SortBy": "ScoreAndAlphaAndAlpha",
        "ParentId": 0,
        "IsCollapsible": true,
        "IsCollapsedDefault": false,
        "SwatchData": null,
        "FacetRangeDisplayType": 0,
        "PreloadChildren": false,
        "Tooltip": null,
        "ShowSliderInputs": false,
        "ShowFacetImageCount": false,
        "FacetRanges": [],
        "Tags": null,
        "CreateDate": "02-04-2020",
        "ModifyDate": "02-04-2020",
        "BoostBury": {
            "BoostValues": [],
            "BuryValues": []
        },
        "ListName": "Brand Facet",
        "NumericPrecision": 0,
        "CurrencySymbol": null
    }

...