SPsponsorunited
Social Scraping Sessions

List league social scraping sessions

Paginated listing of league social scraping sessions for a season, with brand/item counts and review status. Supports grouped rows and CSV download.

get/api/social-scraping-sessions

Request

Query parameters

seasoninteger required
Example:2024

Season year.

review_status'pending' | 'reviewed' required

Review status filter.

groupedboolean

Group sessions by handle/type/user. When true, each row carries social_scraping_session_ids and the has_unmatched_handles / has_rejected_companies flags.

include_emptyboolean

Include sessions whose audits have no items.

downloadboolean

When true, returns a CSV stream (text/csv) instead of JSON.

league_idinteger[]

Comma-separated league IDs. Mutually exclusive with property_list_id.

property_list_idinteger

Property list ID. Filters sessions to the properties in the list. Mutually exclusive with league_id.

division_idinteger[]

Comma-separated division IDs.

team_idinteger[]

Comma-separated team IDs.

user_idinteger[]

Comma-separated scanner user IDs.

reviewerinteger[]

Comma-separated reviewer user IDs.

typestring[]

Comma-separated social platforms.

platform_handlestring[]

Comma-separated platform handles, each formatted as type@handle.

[
  "twitter@lakers"
]
status_valueinteger[]

Comma-separated user_event status values.

scouting_marketsinteger[]

Comma-separated scouting market IDs.

order_by'division_name' | 'followers_count' | 'team_name' | 'user_name' | 'reviewer_name' | 'start' | 'end' | 'brands_count' | 'items_count' | 'handle'

Sort column. followers_count is only sortable when league_id or property_list_id is provided; reviewer_name only when review_status=reviewed.

order_direction'asc' | 'desc'

Sort direction.

order'asc' | 'desc'

Deprecated alias of order_direction; still accepted and normalized to order_direction. Prefer order_direction.

pageinteger
Example:1

Page number (1-based).

per_pageinteger
Example:10

Page size (max 200).

infinite_scrollboolean

When true, returns simple pagination (next_page_url/prev_page_url, no total/last_page) for infinite scroll. Default false keeps length-aware pagination with total.

Response

Paginated sessions. With infinite_scroll=true the payload uses simple pagination (next_page_url/prev_page_url, no total/last_page). download=true returns a text/csv stream.

current_pageinteger
per_pageinteger
totalinteger nullable

Only present with length-aware pagination; omitted when infinite_scroll=true.

next_page_urlstring nullable

URL of the next page; present when infinite_scroll=true.

prev_page_urlstring nullable

URL of the previous page.

Example response

{
  "current_page": 1,
  "per_page": 10,
  "total": 128,
  "data": [
    {
      "id": 98765,
      "type": "instagram",
      "handle": "lakers",
      "team_id": 321,
      "user_id": 42,
      "brands_count": 14,
      "items_count": 37,
      "statuses": "1,2",
      "start_date": "2024-08-01 00:00:00",
      "end_date": "2024-08-31 23:59:59",
      "scan_group": "98765",
      "social_scraping_session_ids": "98765,98766",
      "has_unmatched_handles": true,
      "total_followers": 1500000,
      "platform_followers": 900000,
      "latest_reviewed_at": "2024-09-02 10:15:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.