Shopware icon

Shopware

Shopware

Actions778

App Flow Event → Search App Flow Event

AI-generated

Overview

This node performs a search operation on the 'App Flow Event' resource within the Shopware platform. It allows users to query and retrieve app flow event data based on various search parameters such as pagination, filtering, sorting, and field selection. This is useful for scenarios where you need to analyze or process specific app flow events, for example, to monitor user interactions or automate workflows based on event data.

Use Case Examples

  1. Retrieve the first page of app flow events with a limit of 10 items per page.
  2. Search for app flow events filtered by specific criteria such as event type or date range.
  3. Sort app flow events by creation date in descending order.
  4. Select specific fields to be returned in the search results to optimize data handling.

Properties

Name Meaning
Page The page number of the search results to retrieve, used for pagination.
Limit The number of items to return per page in the search results.
Filter A JSON array of filters to restrict the search results based on specific conditions.
Sort A JSON array defining the sorting order of the search results.
Post Filter A JSON array of filters applied after aggregations, which do not affect aggregation results.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON array specifying aggregations to perform on the search results.
Grouping A JSON array defining groupings over certain fields in the search results.
Fields A JSON array specifying which fields should be returned in the search results.
Total Count Mode Option to determine how the total number of hits is calculated: none (disabled), exact (slow but accurate), or next-pages (fast for next page only).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to be returned for given entities, used to control the API-level response fields.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The array of app flow event objects returned by the search query.
  • total - The total number of hits matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results if aggregations were requested in the search.

Dependencies

  • Shopware API credentials

Troubleshooting

  • Invalid JSON in filter, sort, post-filter, associations, aggregations, grouping, fields, ids, or includes properties can cause request failures. Ensure JSON is well-formed.
  • Incorrect pagination parameters (page or limit) may result in empty or incomplete results.
  • Using 'exact' total count mode may slow down the response time significantly for large datasets.
  • SSL certificate validation errors can occur if 'Ignore SSL Issues' is not enabled when using self-signed certificates.

Links

Discussion