Browser

In the Data Collection / Export Endpoint Browser you can configure a payload to further change the response.

Limit

The limit parameter specifies the maximum number of items to retrieve in a single request. By setting a value for limit, you can control how many records are returned in the response. It expects a number between 1 and 500. For example, if you set "limit": 10, the response will only contain up to 10 records. This is useful for paging through large datasets or when you only need a subset of data rather than the entire available data.

Start

The start parameter determines the starting point for the data retrieval. It is typically used to implement pagination by specifying an offset in the data collection. For example, if you have 100 items and you want to start retrieving from the 11th item onward, you would set "start": 10 (keeping in mind that indexing usually starts at 0). This allows you to control which section of the data set you are working with, helping to retrieve the next “page” of data when working with large sets.

Filter

The filter expects the same shape like in the Filter.

Changes

The changes section allows you to filter results based on modifications that have occurred within a specified time range, in specific fields, or with multiple conditions.

Querying by Time Range

You can filter changes that happened within a given period using the $gte (greater than or equal) and $lte (less than or equal) operators.

Example:

{
  "changes": {
    "changed": {
      "$gte": "2024-01-01 22:20:00+02",
      "$lte": "2024-09-10 22:20:00+02"
    }
  }
}

Filtering by Specific Fields

To track changes only in specific attributes (e.g., price and stock), include the field parameter.

Example:

{
  "changes": {
    "field": ["Price", "Stock"],
    "changed": {
      "$gte": "2024-01-01 22:20:00+02",
      "$lte": "2024-09-10 22:20:00+02"
    }
  }
}

Using Multiple Time Intervals

If you need to track changes across multiple time intervals, use an array of objects.

Example:

{
  "changes": [
    {
      "changed": {
        "$gte": "2024-01-01 22:20:00+02",
        "$lte": "2024-04-30 22:20:00+02"
      }
    },
    {
      "changed": {
        "$gte": "2024-06-01 22:20:00+02",
        "$lte": "2024-09-10 22:20:00+02"
      }
    }
  ]
}

Combining with Logical Operators

Logical operators such as $and and $or can be used to refine queries further.

Example for POST:

{
  "changes": {
    "$and": [
      {
        "field": ["Price"],
        "changed": {"$gte": "2024-01-01 22:20:00+02"}
      },
      {
        "field": ["Stock"],
        "changed": {"$lte": "2024-09-10 22:20:00+02"}
      }
    ]
  }
}