List league deals per property with aggregated statistics.
Returns deal statistics for each property (team) matching the provided filters. When use_new_behavior is true the response is a paginated envelope; otherwise it returns all matching properties plus league-level statistics.
Request
- Base URLhttps://api.sponsorunited.com (the document declares no server; this is the origin it was published from)
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Season year to report on.
User-event statuses to filter deals by (comma-separated UserEventStatus values, e.g. 4,2,1,0). Only applied when use_new_behavior is true.
Platform ID to filter deals by.
Subplatform ID to filter deals by.
Item ID to filter deals by.
League IDs to filter properties by (comma-separated).
Scouting group IDs to filter properties by (comma-separated).
Scouting market IDs to filter properties by (comma-separated).
Column filter: property (team) IDs to include (comma-separated). Applied across the full dataset. Only used when use_new_behavior is true.
Column filter: owner IDs of the property's representative (earliest-created) scouting market (comma-separated). Only used when use_new_behavior is true.
Column filter: division IDs to include (comma-separated). Only used when use_new_behavior is true.
Column to sort the full dataset by. Only used when use_new_behavior is true. Non-listed columns (assigned counts, brand lists, out_of_home/other companies) are not sortable.
Sort direction. Defaults to asc.
Include, per asset type, the number of brands with at least one asset in an approved, in-review or in-progress audit for the season. Counted from the live audit tables (each asset under the status of the audit it was recorded in), so a brand with assets in two audits can appear under both statuses. Only counted for a concrete season year: for an abstract season (previous, current, next) the live audit tables are not queried and every breakdown key is returned as 0, meaning not counted rather than no brands.
When true, returns a paginated response envelope instead of the full result set with league statistics.
Items per page (max 20). Only used when use_new_behavior is true.
Page number. Only used when use_new_behavior is true.
Response
Successful response. Returns deal statistics per property; shape depends on use_new_behavior.
Changes
No recorded changes to this operation across all 2 revisions of this API.