Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Keywords | form | string | No | |
Page | form | int | No | |
PerPage | form | int | No | |
FacetBy | form | string | No | |
FilterBy | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
facet_counts | form | List<FacetCount> | No | |
found | form | int | No | |
hits | form | List<TypeSenseHit<'T>> | No | |
out_of | form | int | No | |
page | form | int | No | |
request_params | form | TypeSenseRequestParams | No | |
search_cutoff | form | bool | No | |
search_time_ms | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Total | form | int | No | |
OpCode | form | int | No | |
ErrorText | form | string | No | |
RequestTime | form | string | No | |
ResponseTime | form | string | No | |
TotalExecutionTime | form | string | No | |
CachedResponse | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
counts | form | List<TypeSenseCount> | No | |
field_name | form | string | No | |
stats | form | TypeSenseStat | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
count | form | int | No | |
highlighted | form | string | No | |
value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
total_values | form | int | No | |
avg | form | double? | No | |
max | form | double? | No | |
min | form | double? | No | |
sum | form | double? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
collection_name | form | string | No | |
per_page | form | int | No | |
q | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/TypeSenseNewsSearchRequest HTTP/1.1
Host: cdnapidev.greysheet.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Keywords":"String","Page":0,"PerPage":0,"FacetBy":"String","FilterBy":"String"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"facet_counts":[{"counts":[{"count":0,"highlighted":"String","value":"String"}],"field_name":"String","stats":{"total_values":0,"avg":0,"max":0,"min":0,"sum":0}}],"found":0,"hits":[{"document":{"Id":0,"PostSummary":"String","PostTitle":"String","Categories":["String"],"Author":"String","SortOrder":0,"ImageCaption":"String","ImageUrl":"String","Permalink":"String","PostContent":"String","PostDate":"\/Date(-62135596800000-0000)\/"}}],"out_of":0,"page":0,"request_params":{"collection_name":"String","per_page":0,"q":"String"},"search_cutoff":false,"search_time_ms":0,"Total":0,"OpCode":0,"ErrorText":"String","RequestTime":"String","ResponseTime":"String","TotalExecutionTime":"String","CachedResponse":false}