Request Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
start_date | String | Start date in MM/DD/YYYY format | Yes |
end_date | String | End date in MM/DD/YYYY format | Yes |
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 |
Response Fields
| 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) |
Request Example
Response Example
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Start date in MM/DD/YYYY format
End date in MM/DD/YYYY format
Limit the number of results. Default is 4. Recommended is 20. Set to 10,000 to get all data.
Include GMV (Gross Merchandise Value) data for each post. Default is false.