Get product ranking
get_product_rankingRank the open task's lines in one named category or supplier by revenue or units, highest first. Use it to compare rate of sale within that group. It refuses an unfiltered ranking, because the top of the open lines is not the top of the business; use twelfth_list_products sorted by units_l4w for that.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| metric | No | Figure to rank by; defaults to revenue. | |
| category | No | Category name to narrow the visible lines to, as shown in the workspace. | |
| entity_name | No | Entity name exactly as the user wrote it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | Yes | One row per product line: sku, product, category, supplier, then the line's own measures. | |
| scope | Yes | What population the rows were read from. | |
| truncated | Yes | True when more rows matched than were returned. | |
| population | No | Present on an unfiltered read: a reminder the rows are a slice, not the whole business. | |
| evidence_id | Yes | Handle for these rows within this call's results. Not a citation. | |
| completeness | No | Present when nothing matched: what the empty result does and does not mean. | |
| returned_rows | Yes | Rows in this response. | |
| inputs_not_applied | No | Inputs the snapshot could not apply. | |
| source_evidence_ids | Yes | Workspace evidence IDs backing these rows. Empty when the source carries no evidence records. | |
| total_matching_rows | Yes | Rows that matched before any limit. | |
| excluded_rows_without_metric | No | Rows left out of a ranking because they carry no figure for the metric. |