diff --git a/api-reference/openapi/releases.json b/api-reference/openapi/releases.json index 9bfe4743..92283326 100644 --- a/api-reference/openapi/releases.json +++ b/api-reference/openapi/releases.json @@ -924,7 +924,7 @@ }, "/api/artist/socials/scrape": { "post": { - "description": "Trigger scrape jobs for all social profiles linked to an artist. Provide an artist_account_id, and the API will look up the artist's socials and invoke a scraping job for each social profile. Each scrape returns Apify run metadata so you can poll for status and retrieve results.", + "description": "Trigger scrape jobs for all social profiles linked to an artist. Returns a runId per social profile that you can poll for status and results via the [Scraper Results API](/api-reference/apify/scraper).", "requestBody": { "description": "Artist to scrape socials for", "required": true, @@ -2106,6 +2106,13 @@ "format": "uuid", "description": "UUID of the artist account to scrape socials for", "example": "1873859c-dd37-4e9a-9bac-80d35a1b2c3d" + }, + "posts": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "example": 10, + "description": "Maximum number of recent posts to include in each scrape dataset, with per-post engagement metrics. On X/Twitter this returns the account's latest `posts` timeline items — including retweets and replies — each with like, retweet, reply, quote, bookmark, and view counts. On YouTube the depth applies per content type, so each dataset contains up to `posts` videos plus `posts` Shorts, each with view, like, and comment counts. Other platforms ignore this field. When omitted, each scrape returns the legacy profile snapshot (a single latest item)." } } }, diff --git a/api-reference/openapi/social.json b/api-reference/openapi/social.json index 27dc115a..e6a6301e 100644 --- a/api-reference/openapi/social.json +++ b/api-reference/openapi/social.json @@ -538,7 +538,7 @@ }, "/api/socials/{id}/scrape": { "post": { - "description": "Trigger a social profile scraping job for a given social profile. Use the [Get Artist Socials](/api-reference/artists/socials) endpoint first to retrieve the social profile id values. The response returns Apify run metadata for polling status and retrieving results via the [Apify Scraper Results API](/api-reference/apify/scraper).", + "description": "Trigger a social profile scraping job for a given social profile. Use the [Get Artist Socials](/api-reference/artists/socials) endpoint first to retrieve the social profile id values. The response returns run metadata for polling status and retrieving results via the [Scraper Results API](/api-reference/apify/scraper).", "parameters": [ { "name": "id", @@ -549,6 +549,18 @@ "type": "string", "format": "uuid" } + }, + { + "name": "posts", + "in": "query", + "description": "Maximum number of recent posts to include in the scrape dataset, with per-post engagement metrics. On X/Twitter this returns the account's latest `posts` timeline items — including retweets and replies — each with like, retweet, reply, quote, bookmark, and view counts. On YouTube the depth applies per content type, so the dataset contains up to `posts` videos plus `posts` Shorts, each with view, like, and comment counts. Other platforms ignore this parameter. When omitted, the scrape returns the legacy profile snapshot (a single latest item).", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100 + }, + "example": 10 } ], "responses": { @@ -1020,7 +1032,7 @@ "type": "object", "additionalProperties": true }, - "description": "Array of dataset items returned by the scraper. The structure of each item varies depending on the scraper type (Instagram Profile, Instagram Comments, etc.)", + "description": "Array of dataset items returned by the scraper. The structure of each item varies depending on the scraper type.", "example": [ { "id": "123456789", @@ -1029,7 +1041,43 @@ "biography": "This is a sample biography", "followersCount": 1000, "followsCount": 500, - "profilePicUrl": "https://example.com/profile.jpg" + "profilePicUrl": "https://example.com/profile.jpg", + "latestPosts": [ + { + "shortCode": "AbCdEfGhIjK", + "type": "Video", + "caption": "Example reel caption", + "likesCount": 16, + "commentsCount": 4, + "videoViewCount": 56, + "timestamp": "2026-06-30T00:26:41.000Z" + } + ] + }, + { + "type": "tweet", + "id": "1234567890123456789", + "url": "https://x.com/example_user/status/1234567890123456789", + "text": "Example tweet text", + "createdAt": "Wed Jul 01 17:38:08 +0000 2026", + "likeCount": 7, + "retweetCount": 2, + "replyCount": 1, + "quoteCount": 0, + "bookmarkCount": 1, + "viewCount": 258 + }, + { + "type": "video", + "id": "aBcDeFgHiJk", + "title": "Example Short", + "url": "https://www.youtube.com/watch?v=aBcDeFgHiJk", + "date": "2026-07-01T17:55:00.000Z", + "viewCount": 26, + "likes": 1, + "commentsCount": 0, + "duration": "00:00:45", + "channelUsername": "examplechannel" } ] } diff --git a/docs.json b/docs.json index 14aa944d..a5de16b8 100644 --- a/docs.json +++ b/docs.json @@ -45,7 +45,6 @@ "api-reference/artists/unpin", "api-reference/artists/delete", "api-reference/artists/socials", - "api-reference/artist/socials-scrape", "api-reference/artist/profile" ] }, @@ -213,7 +212,8 @@ { "group": "Social", "pages": [ - "api-reference/social/scrape" + "api-reference/social/scrape", + "api-reference/artist/socials-scrape" ] }, {