One week against the week before: GMV, orders, units, commission, creators, samples and content, with top movers
GET
/api/public/v1/tik_tok_shop/summary/weeklyConnectorAnswers empty results in the documented shape until the brand switches on this connection.
Operation id getTikTokShopWeeklySummary
Request
curl
curl "https://creator.growthdept.ai/api/public/v1/tik_tok_shop/summary/weekly" \
-H "Authorization: Bearer gdc_..."Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| week_start | query | string (date) | |
| organization_id | query | integer |
Responses
200Success
| Field | Type | Notes |
|---|---|---|
| currency | string, nullable | |
| freshness | object, nullable | |
| freshness.contentSyncedAt | string, nullable | |
| freshness.creatorActivity | object, nullable | |
| freshness.creatorActivity.historyFrom | string, nullable | |
| freshness.creatorActivity.source | string, nullable | |
| freshness.ordersCompleteForWeek | boolean, nullable | |
| freshness.ordersSweptThrough | string, nullable | |
| freshness.productAnalytics | object, nullable | |
| freshness.productAnalytics.previousWeekLatestAvailableDate | string, nullable | |
| freshness.productAnalytics.weekLatestAvailableDate | string, nullable | |
| freshness.samplesSyncedAt | string, nullable | |
| freshness.videoSales | object, nullable | |
| freshness.videoSales.firstFinalDay | string, nullable | |
| freshness.videoSales.previousWeekFinalThrough | string, nullable | |
| freshness.videoSales.weekFinalThrough | string, nullable | |
| inProgress | boolean, nullable | |
| metrics | object, nullable | |
| metrics.activeCreators | object, nullable | |
| metrics.activeCreators.change | number, nullable | |
| metrics.activeCreators.changePct | number, nullable | |
| metrics.activeCreators.previous | number, nullable | |
| metrics.activeCreators.source | string, nullable | |
| metrics.activeCreators.value | number, nullable | |
| metrics.affiliateGmv | object, nullable | |
| metrics.affiliateGmv.change | string, nullable | |
| metrics.affiliateGmv.changePct | number, nullable | |
| metrics.affiliateGmv.previous | string, nullable | |
| metrics.affiliateGmv.source | string, nullable | |
| metrics.affiliateGmv.value | string, nullable | |
| metrics.commission | object, nullable | |
| metrics.commission.change | string, nullable | |
| metrics.commission.changePct | number, nullable | |
| metrics.commission.previous | string, nullable | |
| metrics.commission.source | string, nullable | |
| metrics.commission.value | string, nullable | |
| metrics.contentPosted | object, nullable | |
| metrics.contentPosted.change | number, nullable | |
| metrics.contentPosted.changePct | , nullable | |
| metrics.contentPosted.previous | number, nullable | |
| metrics.contentPosted.source | string, nullable | |
| metrics.contentPosted.value | number, nullable | |
| metrics.newCreators | object, nullable | |
| metrics.newCreators.change | number, nullable | |
| metrics.newCreators.changePct | number, nullable | |
| metrics.newCreators.previous | number, nullable | |
| metrics.newCreators.source | string, nullable | |
| metrics.newCreators.value | number, nullable | |
| metrics.orders | object, nullable | |
| metrics.orders.change | number, nullable | |
| metrics.orders.changePct | number, nullable | |
| metrics.orders.previous | number, nullable | |
| metrics.orders.source | string, nullable | |
| metrics.orders.value | number, nullable | |
| metrics.samplesApproved | object, nullable | |
| metrics.samplesApproved.change | number, nullable | |
| metrics.samplesApproved.changePct | number, nullable | |
| metrics.samplesApproved.previous | number, nullable | |
| metrics.samplesApproved.source | string, nullable | |
| metrics.samplesApproved.value | number, nullable | |
| metrics.samplesRequested | object, nullable | |
| metrics.samplesRequested.change | number, nullable | |
| metrics.samplesRequested.changePct | number, nullable | |
| metrics.samplesRequested.previous | number, nullable | |
| metrics.samplesRequested.source | string, nullable | |
| metrics.samplesRequested.value | number, nullable | |
| metrics.samplesShipped | object, nullable | |
| metrics.samplesShipped.change | number, nullable | |
| metrics.samplesShipped.changePct | , nullable | |
| metrics.samplesShipped.previous | number, nullable | |
| metrics.samplesShipped.source | string, nullable | |
| metrics.samplesShipped.value | number, nullable | |
| metrics.unitsSold | object, nullable | |
| metrics.unitsSold.change | number, nullable | |
| metrics.unitsSold.changePct | number, nullable | |
| metrics.unitsSold.previous | number, nullable | |
| metrics.unitsSold.source | string, nullable | |
| metrics.unitsSold.value | number, nullable | |
| note | string, nullable | |
| previousWeek | object, nullable | |
| previousWeek.endDate | string, nullable | |
| previousWeek.startDate | string, nullable | |
| timezone | string, nullable | |
| topMovers | object, nullable | |
| topMovers.creators | object, nullable | |
| topMovers.creators.basis | string, nullable | |
| topMovers.creators.drops | array of object, nullable | |
| topMovers.creators.drops[].[].change | string, nullable | |
| topMovers.creators.drops[].[].changePct | number, nullable | |
| topMovers.creators.drops[].[].creatorKey | string, nullable | |
| topMovers.creators.drops[].[].creatorUsername | string, nullable | |
| topMovers.creators.drops[].[].previous | string, nullable | |
| topMovers.creators.drops[].[].value | string, nullable | |
| topMovers.creators.dropsExact | boolean, nullable | |
| topMovers.creators.metric | string, nullable | |
| topMovers.creators.source | string, nullable | |
| topMovers.creators.top | array of object, nullable | |
| topMovers.creators.top[].[].change | string, nullable | |
| topMovers.creators.top[].[].changePct | number, nullable | |
| topMovers.creators.top[].[].creatorKey | string, nullable | |
| topMovers.creators.top[].[].creatorUsername | string, nullable | |
| topMovers.creators.top[].[].previous | string, nullable | |
| topMovers.creators.top[].[].value | string, nullable | |
| topMovers.products | object, nullable | |
| topMovers.products.basis | string, nullable | |
| topMovers.products.drops | array of object, nullable | |
| topMovers.products.drops[].[].change | string, nullable | |
| topMovers.products.drops[].[].changePct | number, nullable | |
| topMovers.products.drops[].[].previous | string, nullable | |
| topMovers.products.drops[].[].productId | string, nullable | |
| topMovers.products.drops[].[].productTitle | string, nullable | |
| topMovers.products.drops[].[].value | string, nullable | |
| topMovers.products.dropsExact | boolean, nullable | |
| topMovers.products.metric | string, nullable | |
| topMovers.products.source | string, nullable | |
| topMovers.products.top | array of object, nullable | |
| topMovers.products.top[].[].change | string, nullable | |
| topMovers.products.top[].[].changePct | number, nullable | |
| topMovers.products.top[].[].previous | string, nullable | |
| topMovers.products.top[].[].productId | string, nullable | |
| topMovers.products.top[].[].productTitle | string, nullable | |
| topMovers.products.top[].[].value | string, nullable | |
| topMovers.productsBySamples | object, nullable | |
| topMovers.productsBySamples.basis | string, nullable | |
| topMovers.productsBySamples.drops | array of object, nullable | |
| topMovers.productsBySamples.drops[].[].change | number, nullable | |
| topMovers.productsBySamples.drops[].[].changePct | number, nullable | |
| topMovers.productsBySamples.drops[].[].previous | number, nullable | |
| topMovers.productsBySamples.drops[].[].productId | string, nullable | |
| topMovers.productsBySamples.drops[].[].productTitle | string, nullable | |
| topMovers.productsBySamples.drops[].[].value | number, nullable | |
| topMovers.productsBySamples.dropsExact | boolean, nullable | |
| topMovers.productsBySamples.metric | string, nullable | |
| topMovers.productsBySamples.source | string, nullable | |
| topMovers.productsBySamples.top | array of object, nullable | |
| topMovers.productsBySamples.top[].[].change | number, nullable | |
| topMovers.productsBySamples.top[].[].changePct | number, nullable | |
| topMovers.productsBySamples.top[].[].previous | number, nullable | |
| topMovers.productsBySamples.top[].[].productId | string, nullable | |
| topMovers.productsBySamples.top[].[].productTitle | string, nullable | |
| topMovers.productsBySamples.top[].[].value | number, nullable | |
| topMovers.videos | object, nullable | |
| topMovers.videos.basis | string, nullable | |
| topMovers.videos.drops | array of object | |
| topMovers.videos.dropsExact | boolean, nullable | |
| topMovers.videos.metric | string, nullable | |
| topMovers.videos.source | string, nullable | |
| topMovers.videos.top | array of object, nullable | |
| topMovers.videos.top[].[].change | string, nullable | |
| topMovers.videos.top[].[].changePct | number, nullable | |
| topMovers.videos.top[].[].contentId | string, nullable | |
| topMovers.videos.top[].[].previous | string, nullable | |
| topMovers.videos.top[].[].value | string, nullable | |
| unavailable | array of object | |
| week | object, nullable | |
| week.endDate | string, nullable | |
| week.startDate | string, nullable |
Example
{
"currency": "usd",
"freshness": {
"contentSyncedAt": "string",
"creatorActivity": {
"historyFrom": "string",
"source": "string"
},
"ordersCompleteForWeek": true,
"ordersSweptThrough": "string",
"productAnalytics": {
"previousWeekLatestAvailableDate": "string",
"weekLatestAvailableDate": "string"
},
"samplesSyncedAt": "string",
"videoSales": {
"firstFinalDay": "string",
"previousWeekFinalThrough": "string",
"weekFinalThrough": "string"
}
},
"inProgress": true,
"metrics": {
"activeCreators": {
"change": 125.5,
"changePct": 125.5,
"previous": 125.5,
"source": "string",
"value": 125.5
},
"affiliateGmv": {
"change": "string",
"changePct": 125.5,
"previous": "string",
"source": "string",
"value": "string"
},
"commission": {
"change": "string",
"changePct": 125.5,
"previous": "string",
"source": "string",
"value": "string"
},
"contentPosted": {
"change": 125.5,
"changePct": "string",
"previous": 125.5,
"source": "string",
"value": 125.5
},
"newCreators": {
"change": 125.5,
"changePct": 125.5,
"previous": 125.5,
"source": "string",
"value": 125.5
},
"orders": {
"change": 125.5,
"changePct": 125.5,
"previous": 125.5,
"source": "string",
"value": 125.5
},
"samplesApproved": {
"change": 125.5,
"changePct": 125.5,
"previous": 125.5,
"source": "string",
"value": 125.5
},
"samplesRequested": {
"change": 125.5,
"changePct": 125.5,
"previous": 125.5,
"source": "string",
"value": 125.5
},
"samplesShipped": {
"change": 125.5,
"changePct": "string",
"previous": 125.5,
"source": "string",
"value": 125.5
},
"unitsSold": {
"change": 125.5,
"changePct": 125.5,
"previous": 125.5,
"source": "string",
"value": 125.5
}
},
"note": "string",
"previousWeek": {
"endDate": "string",
"startDate": "string"
},
"timezone": "string",
"topMovers": {
"creators": {
"basis": "string",
"drops": [
{
"change": "string",
"changePct": 125.5,
"creatorKey": "string",
"creatorUsername": "Example name",
"previous": "string",
"value": "string"
}
],
"dropsExact": true,
"metric": "string",
"source": "string",
"top": [
{
"change": "string",
"changePct": 125.5,
"creatorKey": "string",
"creatorUsername": "Example name",
"previous": "string",
"value": "string"
}
]
},
"products": {
"basis": "string",
"drops": [
{
"change": "string",
"changePct": 125.5,
"previous": "string",
"productId": "string",
"productTitle": "string",
"value": "string"
}
],
"dropsExact": true,
"metric": "string",
"source": "string",
"top": [
{
"change": "string",
"changePct": 125.5,
"previous": "string",
"productId": "string",
"productTitle": "string",
"value": "string"
}
]
},
"productsBySamples": {
"basis": "string",
"drops": [
{
"change": 125.5,
"changePct": 125.5,
"previous": 125.5,
"productId": "string",
"productTitle": "string",
"value": 125.5
}
],
"dropsExact": true,
"metric": "string",
"source": "string",
"top": [
{
"change": 125.5,
"changePct": 125.5,
"previous": 125.5,
"productId": "string",
"productTitle": "string",
"value": 125.5
}
]
},
"videos": {
"basis": "string",
"drops": [
"string"
],
"dropsExact": true,
"metric": "string",
"source": "string",
"top": [
{
"change": "string",
"changePct": 125.5,
"contentId": "string",
"previous": "string",
"value": "string"
}
]
}
},
"unavailable": [
"string"
],
"week": {
"endDate": "string",
"startDate": "string"
}
}Errors: 400401404422429502with an error and usually a message. See errors.
Example values are made up from each field's type and name.