Shopware icon

Shopware

Shopware

Actions778

Sales Channel Analytics → Search Sales Channel Analytics

AI-generated

Overview

This node performs a search operation on Sales Channel Analytics data within the Shopware platform. It allows users to query and retrieve analytics data related to sales channels by specifying various search parameters such as pagination, filtering, sorting, aggregations, and grouping. This node is useful for scenarios where detailed analytics insights are needed for sales channels, such as generating reports, monitoring sales performance, or analyzing customer behavior across different sales channels.

Use Case Examples

  1. A user wants to retrieve the first page of sales channel analytics with a limit of 20 items per page, filtered by a specific date range and sorted by sales volume.
  2. A user needs to perform aggregations on sales channel data to get total sales per channel and group results by region.

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 criteria.
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 the aggregation results.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON array specifying aggregation operations to perform on the search results.
Grouping A JSON array defining fields to group the search results by.
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 for the search query, with options for none, exact, or next-pages.
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to include for given entities, used to control the returned data structure.

Output

JSON

  • data - The search results containing sales channel analytics data.
  • total - The total number of hits matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results based on the specified aggregation parameters.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access sales channel analytics data.
  • Verify that JSON inputs for filters, sorting, aggregations, and other parameters are correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', be aware that the query might be slower due to the calculation of the exact total number of hits.
  • Check network connectivity and proxy settings if requests fail or time out.

Links

Discussion