Search

post

https://app.financekey.com/OData/v_Searches

The Search table in the Metadata package stores information about searches performed on the site. Each record contains the search terms used, user ID of the searcher, search timestamp, number of results returned and the type of search. This data allows the website to provide relevant search options and analyze user search patterns.

Body Params

rowNumber

int64

RowNumber is a field of data type bigint in the Search table. This field is used as a primary key to uniquely identify each row in the table and is automatically generated, starting from 1 and incrementing by one for each additional record.

entityId

string

required

length between 1 and 450

EntityId is a nvarchar field with a maximum length of 450 in the Search table. It stores unique identifiers used to specify an individual item within the system. It is used to track entities through the application and provide a reference of the item in any related records.

pkId

string | null

PkId is a varchar(450) field in the Search table, which is used as the primary key identifier for each row. It is a unique identifier that is used to quickly locate a specific row within the Search table.

prompt

string | null

The Prompt field of the Search table is an nvarchar field used to store a string containing a user-defined search phrase that can be used to perform a search in the application. Each record in the Search table will have a unique Prompt field value. This field is used to help facilitate users' queries when searching for content or specific records.

category

string

required

length between 1 and 16

The Category field in the Search table is a varchar type with a max length of 16 characters. It stores the category name of a particular search that is performed.

string

required

length ≥ 1

The Search field of data type nvarchar in the Search table is used to store text values containing search terms, such as a product or customer name, for the purpose of searching for the related records. This field can be used in combination with other search criteria fields for more accurate searching.

sequence

int32

The Sequence field of type int in the Search table is used to store the order in which items were added by the user when performing a search query. Items in the search query are stored in ascending order, with the first item being 1 and the last item being the total number of items queried.

packageId

string

required

length between 1 and 450

The PackageId field in the Search table is of data type nvarchar with a maximum length of 450 characters. This field is used to uniquely identify a specific package within the context of the search feature. It may contain a combination of letters, numbers, and special characters, and is designed to provide a standardized and efficient way of referencing packages for search purposes. Due to its generous character limit, the PackageId field allows for potential variations or modifications in package names to be accurately represented and searched for.

Response

200

Language

URL

Response

Click Try It! to start a request and see the response here!