Actions25
- Store Actions
- Product Actions
- Category Actions
- Variation Actions
- Brand Actions
- Coupon Actions
- Report Actions
- Engage Profile Actions
- Engage Unsubscribe Actions
- Search Actions
Brand → List
AI-generatedSummary
List brands with sales metrics from the Metorik API within a specified date range, supporting pagination, sorting, and keyword filtering.
Inputs
- Start Date (required) — Start date in YYYY-MM-DD format (store timezone) to define the beginning of the data range.
- End Date (required) — End date in YYYY-MM-DD format (store timezone) to define the end of the data range.
- Additional Options — Optional parameters including page number (pagination), number of results per page (max 100), field to order by, order direction (ascending or descending), and a search keyword to filter results by name or keyword.
Output shape
a list of brand records with associated sales metrics
The output paginates based on 'Page' and 'Per Page' options and can be filtered and ordered by specified fields. Each brand is returned as an individual JSON object in the output array.
Examples
Example 1: Retrieve the first 25 brands with sales data between 2026-04-01 and 2026-04-04, ordered descending by creation date.
Set Start Date to '2026-04-01', End Date to '2026-04-04', Additional Options: Page=1, Per Page=25, Order By='creation_date', Order Direction='desc'.