Retrieves your top-performing posts ranked by views within a specified date range
Retrieves your top-performing posts ranked by views within a specified date range.Documentation Index
Fetch the complete documentation index at: https://growi.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
| Parameter | Type | Description | Required |
|---|---|---|---|
start_date | String | Start date in MM/DD/YYYY format. Defines the metrics-delta window (the period over which view/like/comment/share gains are summed for ranking). | Yes |
end_date | String | End date in MM/DD/YYYY format. Defines the metrics-delta window (the period over which view/like/comment/share gains are summed for ranking). | Yes |
posted_at_start_date | String | Start date in MM/DD/YYYY format. Restricts the ranked post set to posts created on or after this date (based on posted_at). Must be supplied together with posted_at_end_date. | No |
posted_at_end_date | String | End date in MM/DD/YYYY format. Restricts the ranked post set to posts created on or before this date (based on posted_at). Must be supplied together with posted_at_start_date. | No |
limit | Integer | Limit the number of results. Default is 4. Recommended is 20. Set to 10,000 to get all data. | No |
page | Integer | Page number for pagination. Default is 1. | No |
per_page | Integer | Number of results per page. Default is 40. Maximum is 100. | No |
include_gmv | Boolean | Include GMV (Gross Merchandise Value) data for each post. Default is false. | No |
start_date / end_date define the window over which view/like/comment/share deltas are summed (the ranking metric). posted_at_start_date / posted_at_end_date restrict the candidate post set by post creation time before ranking. Both posted_at_* bounds must be supplied together; supplying only one returns an error. When neither is provided, behavior is unchanged.| Field | Description |
|---|---|
id | Unique identifier for the post |
title | Post title or caption |
share_url | Direct URL to the post |
platform | Social media platform (e.g., “tik_tok”, “instagram”, “youtube”) |
content_type | Type of content (e.g., “video”, “image”) |
external_id | External platform identifier for the post |
username | Username of the creator |
name | Display name of the creator |
profile_share_url | URL to the creator’s profile |
metrics | Object containing engagement metrics (views, likes, comments, shares) |
gmv | Gross Merchandise Value for the post (only included when include_gmv=true) |
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Start date in MM/DD/YYYY format. Defines the metrics-delta window (period over which view/like/comment/share gains are summed for ranking).
End date in MM/DD/YYYY format. Defines the metrics-delta window (period over which view/like/comment/share gains are summed for ranking).
Start date in MM/DD/YYYY format. Restricts the ranked post set to posts created on or after this date (based on posted_at). Must be supplied together with posted_at_end_date.
End date in MM/DD/YYYY format. Restricts the ranked post set to posts created on or before this date (based on posted_at). Must be supplied together with posted_at_start_date.
Limit the number of results. Default is 4. Recommended is 20. Set to 10,000 to get all data.
Page number for pagination. Default is 1.
Number of results per page. Default is 40. Maximum is 100.
x <= 100Include GMV (Gross Merchandise Value) data for each post. Default is false.