get sales velocity events table
A page of sales velocity events with their windows, statuses, adjustment types and item counts. Page with limit and offset, narrow with filter_args and search, order with sort_args.
Beside the page it serves the whole filtered book's breakdown, so a figure row above a calendar costs no second read. status_counts carries {active, upcoming, past, cancelled} and honours every filter and the search term EXCEPT a status filter, so the four sum to filtered_max_size whether or not a status is selected, and they are served even on a page with no rows. awaiting_input_count is how many of those events are custom events, not yet past, with no values entered anywhere in their window, which is the same fact as awaiting_input on each row, and it honours every filter except an awaiting_input filter.
Every row carries exclude_from_training, whether the baseline has been told not to learn from that window. A planner sets the mark when the event is created or edited in Tightly, and no operation in this reference sets it. It reads false on an organisation whose events table cannot record the mark, which is the truth there.
Scope: sales:read.
Request
- Base URL: https://api.app.tightly.io
- URL: https://api.app.tightly.io/api/v1/sales/velocity/events/table
- Auth: HTTP bearer
Query parameters
Number of rows to retrieve in the response.
Number of rows to skip in the response.
JSON array of filter conditions. Each filter includes: - key: one of status (eq, in), sales_channel_id (eq, in), start_date and end_date (gte, lte, gt, lt), awaiting_input (eq, a boolean). Any other key is refused with a 400 naming the ones that are allowed. - operation: the operation the key allows, from the list above. - value: Filter value (a string, a boolean, or an array for in). Example: json [ {"key": "status", "operation": "eq", "value": "active"}, {"key": "awaiting_input", "operation": "eq", "value": true} ]
Comma-separated list of sort arguments. Prefix with "+" for ascending or "-" for descending. Valid sort fields: name, status, created_at, adjustment_type, date_range, variants_count, items_count.
Search keyword to filter event names or descriptions.
Headers
The date train to answer on. One train exists today, 2026-11, the one this reference describes and the one every key is minted on, so the call answers on it with or without this header. Send it anyway, so a client built now names its train from the start.
Response
The sales velocity events table
Changes
No recorded changes to this operation across all 1 revision of this API.