League

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.

get/api/league/deals

Request

Query parameters

seasoninteger required
Example:2025

Season year to report on.

statusstring[]

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_idinteger

Platform ID to filter deals by.

subplatform_idinteger

Subplatform ID to filter deals by.

item_idinteger

Item ID to filter deals by.

leaguesinteger[]

League IDs to filter properties by (comma-separated).

scouting_groupsinteger[]

Scouting group IDs to filter properties by (comma-separated).

scouting_marketsinteger[]

Scouting market IDs to filter properties by (comma-separated).

propertiesinteger[]

Column filter: property (team) IDs to include (comma-separated). Applied across the full dataset. Only used when use_new_behavior is true.

scouting_market_ownersinteger[]

Column filter: owner IDs of the property's representative (earliest-created) scouting market (comma-separated). Only used when use_new_behavior is true.

divisionsinteger[]

Column filter: division IDs to include (comma-separated). Only used when use_new_behavior is true.

sort_by'name' | 'owner' | 'division' | 'companies_total' | 'sponsor_companies' | 'sponsor_in_venue' | 'tv_companies' | 'radio_companies' | 'social_companies' | 'digital_companies' | 'vendor_companies' | 'sponsor_subcategories_count'

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_order'asc' | 'desc'

Sort direction. Defaults to asc.

with_assets_count_by_audit_statusboolean

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.

use_new_behaviorboolean

When true, returns a paginated response envelope instead of the full result set with league statistics.

per_pageinteger

Items per page (max 20). Only used when use_new_behavior is true.

pageinteger

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.