docs(social): optional `posts` depth param on both social scrape endpoints
Merged
SW
4mo ago+61+61+01234567890123456789-6-6-0123456789
Summary
Contract PR for recoupable/chat#1836 โ merge before the api implementation PR (docs โ api).
POST /api/socials/{id}/scrape: new optionalpostsquery param (integer, 1โ100, default 1).POST /api/artist/socials/scrape: new optionalpostsbody field (same shape) onArtistSocialsScrapeRequest.- Scraper Results (
GET /api/apify/runs/{runId}):dataexample now shows an X tweet item (withlikeCount/retweetCount/replyCount/quoteCount/bookmarkCount/viewCount) and a YouTube video item (viewCount/likes/commentsCount) alongside the Instagram profile item, and the description explains the per-platform item shapes.
Semantics documented: posts applies to X/Twitter and YouTube; other platforms ignore it; omitted โ legacy single-item profile snapshot (existing behavior unchanged).
Verification
- Both OpenAPI files re-parse (
json.load) after the edit; diff is additive (59 insertions / 4 deletions across the two files). - Field semantics match the planned api implementation exactly (Twitter
maxItems, YouTubemaxResults/maxResultsShorts).
๐ค Generated with Claude Code
Summary by cubic
Adds an optional posts depth to both social scrape endpoints to include recent posts with engagement metrics. X/Twitter returns the latest N timeline items (incl. retweets/replies) and YouTube returns up to N videos + N Shorts; omit to get the legacy single-item profile snapshot; other platforms ignore it.
-
New Features
POST /api/socials/{id}/scrape:postsquery param (integer 1โ100).POST /api/artist/socials/scrape:postsbody field onArtistSocialsScrapeRequest(same shape).
-
Refactors
- Removed schema default for
posts(use example: 10) and tightened endpoint copy; responses now point to the Scraper Results API and the artist scrape notes a runId per social profile. - Expanded examples to include Instagram
latestPostsplus X and YouTube items; movedapi-reference/artist/socials-scrapeinto the Social group.
- Removed schema default for
Summary by CodeRabbit
- New Features
- Added an optional
postssetting to social scraping APIs (min: 1,max: 100) to return recent post/video data with engagement metrics on supported platforms.
- Added an optional
- Documentation
- Updated artist socials scrape documentation to clarify scrape-job triggering and per-social
runIdresults behavior. - Expanded per-platform
postsbehavior (X/Twitter, YouTube, Instagram) and documented legacy snapshot behavior whenpostsis omitted. - Refreshed scrape completion response examples and guidance for scraper-type-specific dataset shapes.
- Moved the artist socials scrape API reference entry in the docs navigation.
- Updated artist socials scrape documentation to clarify scrape-job triggering and per-social