Common Search Request Parameters

Common API Endpoints

Search Request Parameters

Search Columns

GET /columns/[endpoint]

Returns a list of available search columns, and their search options. Search columns can be used with the Advanced API searching.

Skip

GET or POST parameter skip. Can be:

• skipped. Defaults to 0;
• nonnegative integer. Used as is;
• other value. Silently skipped.

Limit

GET or POST parameter limit. Can be:

• skipped. Defaults to 25;
• 0. Means that all records should apear in output,
• positive integer. Used as is;
• other value. Silently skipped.

Minimum number of extra keys

GET or POST parameter minExtraKeys. Nonnegative integer, specifying minimum number of extra keys to be provided in extraPKValuessection of Search Response.

Position type

GET or POST parameter positionType. Can be either ctime or mtime. Specifies if timeframe should be used when searching for records.

Maximal timestamp

GET or POST parameter maxTimestamp.

Used only with positionType, otherwise ignored. Can be:

• nonnegative integer, not more than 1 less than current UNIX timestamp (UTC). Specifies maximal timestamp to be included in search;
• skipped. Defaults to number 1 less than current UNIX timestamp (UTC).

Minimal timestamp

GET or POST parameter minTimestamp. Used only with positionType, otherwise ignored. Can be:

• nonnegative integer, not more than 1 less than current UNIX timestamp (UTC). Specifies minimal timestamp to be included in search;
• skipped. Defaults to the value of maxTimestamp.

Full Schema

GET or POST parameter fullSchema.

If this parameter is not set, the response will default to returning a reduced schema of each record, with some properties which would be present in the GET [endpoint]/single?id=[id] response missing. Setting this parameter overrides this behavior and makes each record return with the same full schema it would if it was requested individually using the GET [endpoint]/single?id=[id] method.

Can be:

• skipped. Will default to reduced schema,

  1. Means that all records should return with full schema.