Query parameters are used to search inside or aggregate values inside resource collections, e. g. GET /api/v2/Payment/Transactions?....
The values must be URL encoded.
Nested properties are addressed by joining the component names with dots, e. g. merchant.id.
Name | Type | Description | Sample | Response |
|---|---|---|---|---|
|
| The maximum number of items to return |
| |
|
| The position within the whole result set to start returning items (zero-based). |
| |
|
| List of properties included in the result, all others will be filtered out. |
| |
|
| A query string to restrict the returned items to given conditions. The query string must consist of any combination of single expressions in the form
For date fields it's also possible to use intervals with specific dates and dynamic date calculation.
https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-functions-datetime.html https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#date-math | q=contact.surname:Mustermann
| |
|
| String with comma separated pairs of `field:order`. Options for order:
|
| |
|
| Check syntax of a query string |
| { "result": true} |
|
| Return field definitions |
| { "meta": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "cardprocessingtransactions", "type": "object", "properties": {... } }, "count": null, "data": []} |
|
| While a search request returns a single page of results, the scroll can be used to retrieve large numbers of results (or even all results) from a single search request, in much the same way as you would use a cursor on a traditional database. This parameter enables this feature and defines how long it should keep the “search context” alive. https://www.elastic.co/guide/en/elasticsearch/reference/current/scroll-api.html |
| { "scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==", "count": 1, "data": []} |
|
| Identifier of the previous search context |
| |
|
| Expand fields (all or a specific one) |
| |
|
| Query presets (only for specific endpoints) |
| |
|
| The name of the field on which to perform the date aggregation. | (see next line) | |
|
| The interval by which documents will be bucketed (calendar interval or fixed). |
| { "type": "date", "sum": false, "data": [ { "k": 1577836800000, "ks": "2020-01-01T00:00:00Z", "c": 132 }, { "k": 1609459200000, "ks": "2021-01-01T00:00:00Z", "c": 85 }, { "k": 1640995200000, "ks": "2022-01-01T00:00:00Z", "c": 17 } ]} |
|
| Enables extending the bounds of the histogram beyond the data itself. | ||
|
| Enables extending the bounds of the histogram beyond the data itself. | ||
|
| The name of the field on which to perform the group aggregation. |
| { "type": "term", "sum": false, "data": [ { "l": 0, "c": 6 }, { "l": 1, "c": 5 }, { "l": 2, "c": 5 }, { "l": 3, "c": 1 } ], "lookup": [ "Vorkasse Demo", "Kauf auf Rechnung", "Zahlungsgarantie Kreditkarte", "Kreditkarte Demo" ]} |
|
| The name of the field on which to perform the sum aggregation. |
| { "type": "term", "sum": true, "data": [ { "l": 0, "c": 6, "s": 70033 }, { "l": 1, "c": 5, "s": 17982 }, { "l": 2, "c": 5, "s": 1237 }, { "l": 3, "c": 1, "s": 309 } ], "lookup": [ "Vorkasse Demo", "Kauf auf Rechnung", "Zahlungsgarantie Kreditkarte", "Kreditkarte Demo" ]} |
If you specify dates, f.e.