VitePOS Bridge icon

VitePOS Bridge

Use VitePOS automation bridge and analytics APIs

Actions32

Analytics → Get Summary

AI-generated

Summary

Fetches aggregate sales analytics (orders count, revenue, cost, profit, margin) from the VitePOS analytics API (GET /wp-json/vtpl/v1/analytics/summary) for a chosen date range, with optional filters.

Inputs

  • Range — Preset time window: today, yesterday, last_7_days, last_30_days, this_month (default), last_month, this_year, last_year, or custom. Use custom together with Date From/Date To.
  • Period — Grouping granularity: day (default), week, month, or year. Sent as the period query parameter.
  • Analytics Filters — Optional collection of query filters: Category ID, Customer ID, Date From, Date To (sent as YYYY-MM-DD), Group By (product/parent), Include Orders, Include Returns (booleans sent as 1/0), Limit, Month (e.g. 2026-06), Order (asc/desc), Order Statuses (comma-separated, e.g. wc-processing,wc-completed), Product ID, Sort (profit/revenue/quantity_sold/average_price). Only filled values are sent; some filters (e.g. sort, limit, group_by) may matter more to other analytics operations, and the source doesn't say whether the summary endpoint uses them.

Output shape

One JSON object per input item: the API response fields spread into the item, plus a leading response string with a human-readable summary (e.g. 'Analytics summary for 2026-06-01 to 2026-06-30: 12 orders, revenue 1200, cost 800, profit 400, margin 33.33%'). If no orders match, the text says no matching orders were found.

The exact fields of the API response (such as report.summary, filters) come from the VitePOS plugin and aren't defined in this node. If the API returns status/success false, response holds its message. If the API response already has a response key, the original is placed under raw. With Continue On Fail, errors return as {error: message}. Requires viteposBridgeApi credentials (site URL).

Examples

Example 1: Daily revenue and profit report for the current month

Range: This Month, Period: Day, no filters.

Example 2: Summary for a specific date window, completed orders only

Range: Custom Dates; Analytics Filters: Date From 2026-06-01, Date To 2026-06-15, Order Statuses 'wc-completed,wc-vt_served'.

Example 3: Weekly summary for one customer excluding returns

Range: Last 30 Days, Period: Week; Analytics Filters: Customer ID 42, Include Returns false.

Links

Discussion