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. Maximum is 20. | No |
include_discord | Boolean | Include Discord account ID and username for creators. Default is false. | No |
organization_id | Integer | Filter results by specific organization ID | No |
Request Example
Response Example
Response Fields
Field | Type | Description |
---|---|---|
success | Boolean | Indicates whether the request was successful |
data | Object | Container for the response data |
data.top_creators_by_gmv | Array | Array of creator objects ranked by GMV |
data.top_creators_by_gmv[].brand_name | String | Name of the brand the creator is associated with |
data.top_creators_by_gmv[].id | Integer | Unique identifier for the creator |
data.top_creators_by_gmv[].name | String | Display name of the creator |
data.top_creators_by_gmv[].email | String | Email address of the creator |
data.top_creators_by_gmv[].total_gmv | Number | Total GMV generated by the creator |
data.top_creators_by_gmv[].social_accounts | Array | Array of connected social media accounts |
data.top_creators_by_gmv[].social_accounts[].connected_account_username | String | Username on the social media platform |
data.top_creators_by_gmv[].social_accounts[].platform_name | String | Name of the social media platform |
data.top_creators_by_gmv[].social_accounts[].profile_share_url | String | Direct URL to the creator’s profile |
data.top_creators_by_gmv[].social_accounts[].total_gmv | Number | GMV generated through this specific social account |
data.top_creators_by_gmv[].campaigns | Array | Array of campaigns the creator is associated with |
data.top_creators_by_gmv[].campaigns[].campaign_id | Integer | Unique identifier for the campaign |
data.top_creators_by_gmv[].campaigns[].campaign_name | String | Name of the campaign |
data.top_creators_by_gmv[].campaigns[].total_gmv | Number | Total GMV generated by the creator for this campaign |
data.top_creators_by_gmv[].brands | Array | Array of brand names the creator is associated with |
data.top_creators_by_gmv[].discord_id | String | Discord user ID (included when include_discord=true ) |
data.top_creators_by_gmv[].discord_username | String | Discord username (included when include_discord=true ) |
meta | Object | Pagination metadata |
meta.current_page | Integer | Current page number |
meta.per_page | Integer | Number of results per page |
meta.row_count | Integer | Total number of rows/records |
meta.page_count | Integer | Total number of pages |
meta.has_more | Boolean | Whether there are more pages available |
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. Maximum is 20.
Include Discord account ID and username for creators. Default is false.
Filter results by specific organization ID