TikTok Shop

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/weekly
ConnectorAnswers 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

NameInTypeNotes
week_startquerystring (date)
organization_idqueryinteger

Responses

200Success

FieldTypeNotes
currencystring, nullable
freshnessobject, nullable
freshness.contentSyncedAtstring, nullable
freshness.creatorActivityobject, nullable
freshness.creatorActivity.historyFromstring, nullable
freshness.creatorActivity.sourcestring, nullable
freshness.ordersCompleteForWeekboolean, nullable
freshness.ordersSweptThroughstring, nullable
freshness.productAnalyticsobject, nullable
freshness.productAnalytics.previousWeekLatestAvailableDatestring, nullable
freshness.productAnalytics.weekLatestAvailableDatestring, nullable
freshness.samplesSyncedAtstring, nullable
freshness.videoSalesobject, nullable
freshness.videoSales.firstFinalDaystring, nullable
freshness.videoSales.previousWeekFinalThroughstring, nullable
freshness.videoSales.weekFinalThroughstring, nullable
inProgressboolean, nullable
metricsobject, nullable
metrics.activeCreatorsobject, nullable
metrics.activeCreators.changenumber, nullable
metrics.activeCreators.changePctnumber, nullable
metrics.activeCreators.previousnumber, nullable
metrics.activeCreators.sourcestring, nullable
metrics.activeCreators.valuenumber, nullable
metrics.affiliateGmvobject, nullable
metrics.affiliateGmv.changestring, nullable
metrics.affiliateGmv.changePctnumber, nullable
metrics.affiliateGmv.previousstring, nullable
metrics.affiliateGmv.sourcestring, nullable
metrics.affiliateGmv.valuestring, nullable
metrics.commissionobject, nullable
metrics.commission.changestring, nullable
metrics.commission.changePctnumber, nullable
metrics.commission.previousstring, nullable
metrics.commission.sourcestring, nullable
metrics.commission.valuestring, nullable
metrics.contentPostedobject, nullable
metrics.contentPosted.changenumber, nullable
metrics.contentPosted.changePct, nullable
metrics.contentPosted.previousnumber, nullable
metrics.contentPosted.sourcestring, nullable
metrics.contentPosted.valuenumber, nullable
metrics.newCreatorsobject, nullable
metrics.newCreators.changenumber, nullable
metrics.newCreators.changePctnumber, nullable
metrics.newCreators.previousnumber, nullable
metrics.newCreators.sourcestring, nullable
metrics.newCreators.valuenumber, nullable
metrics.ordersobject, nullable
metrics.orders.changenumber, nullable
metrics.orders.changePctnumber, nullable
metrics.orders.previousnumber, nullable
metrics.orders.sourcestring, nullable
metrics.orders.valuenumber, nullable
metrics.samplesApprovedobject, nullable
metrics.samplesApproved.changenumber, nullable
metrics.samplesApproved.changePctnumber, nullable
metrics.samplesApproved.previousnumber, nullable
metrics.samplesApproved.sourcestring, nullable
metrics.samplesApproved.valuenumber, nullable
metrics.samplesRequestedobject, nullable
metrics.samplesRequested.changenumber, nullable
metrics.samplesRequested.changePctnumber, nullable
metrics.samplesRequested.previousnumber, nullable
metrics.samplesRequested.sourcestring, nullable
metrics.samplesRequested.valuenumber, nullable
metrics.samplesShippedobject, nullable
metrics.samplesShipped.changenumber, nullable
metrics.samplesShipped.changePct, nullable
metrics.samplesShipped.previousnumber, nullable
metrics.samplesShipped.sourcestring, nullable
metrics.samplesShipped.valuenumber, nullable
metrics.unitsSoldobject, nullable
metrics.unitsSold.changenumber, nullable
metrics.unitsSold.changePctnumber, nullable
metrics.unitsSold.previousnumber, nullable
metrics.unitsSold.sourcestring, nullable
metrics.unitsSold.valuenumber, nullable
notestring, nullable
previousWeekobject, nullable
previousWeek.endDatestring, nullable
previousWeek.startDatestring, nullable
timezonestring, nullable
topMoversobject, nullable
topMovers.creatorsobject, nullable
topMovers.creators.basisstring, nullable
topMovers.creators.dropsarray of object, nullable
topMovers.creators.drops[].[].changestring, nullable
topMovers.creators.drops[].[].changePctnumber, nullable
topMovers.creators.drops[].[].creatorKeystring, nullable
topMovers.creators.drops[].[].creatorUsernamestring, nullable
topMovers.creators.drops[].[].previousstring, nullable
topMovers.creators.drops[].[].valuestring, nullable
topMovers.creators.dropsExactboolean, nullable
topMovers.creators.metricstring, nullable
topMovers.creators.sourcestring, nullable
topMovers.creators.toparray of object, nullable
topMovers.creators.top[].[].changestring, nullable
topMovers.creators.top[].[].changePctnumber, nullable
topMovers.creators.top[].[].creatorKeystring, nullable
topMovers.creators.top[].[].creatorUsernamestring, nullable
topMovers.creators.top[].[].previousstring, nullable
topMovers.creators.top[].[].valuestring, nullable
topMovers.productsobject, nullable
topMovers.products.basisstring, nullable
topMovers.products.dropsarray of object, nullable
topMovers.products.drops[].[].changestring, nullable
topMovers.products.drops[].[].changePctnumber, nullable
topMovers.products.drops[].[].previousstring, nullable
topMovers.products.drops[].[].productIdstring, nullable
topMovers.products.drops[].[].productTitlestring, nullable
topMovers.products.drops[].[].valuestring, nullable
topMovers.products.dropsExactboolean, nullable
topMovers.products.metricstring, nullable
topMovers.products.sourcestring, nullable
topMovers.products.toparray of object, nullable
topMovers.products.top[].[].changestring, nullable
topMovers.products.top[].[].changePctnumber, nullable
topMovers.products.top[].[].previousstring, nullable
topMovers.products.top[].[].productIdstring, nullable
topMovers.products.top[].[].productTitlestring, nullable
topMovers.products.top[].[].valuestring, nullable
topMovers.productsBySamplesobject, nullable
topMovers.productsBySamples.basisstring, nullable
topMovers.productsBySamples.dropsarray of object, nullable
topMovers.productsBySamples.drops[].[].changenumber, nullable
topMovers.productsBySamples.drops[].[].changePctnumber, nullable
topMovers.productsBySamples.drops[].[].previousnumber, nullable
topMovers.productsBySamples.drops[].[].productIdstring, nullable
topMovers.productsBySamples.drops[].[].productTitlestring, nullable
topMovers.productsBySamples.drops[].[].valuenumber, nullable
topMovers.productsBySamples.dropsExactboolean, nullable
topMovers.productsBySamples.metricstring, nullable
topMovers.productsBySamples.sourcestring, nullable
topMovers.productsBySamples.toparray of object, nullable
topMovers.productsBySamples.top[].[].changenumber, nullable
topMovers.productsBySamples.top[].[].changePctnumber, nullable
topMovers.productsBySamples.top[].[].previousnumber, nullable
topMovers.productsBySamples.top[].[].productIdstring, nullable
topMovers.productsBySamples.top[].[].productTitlestring, nullable
topMovers.productsBySamples.top[].[].valuenumber, nullable
topMovers.videosobject, nullable
topMovers.videos.basisstring, nullable
topMovers.videos.dropsarray of object
topMovers.videos.dropsExactboolean, nullable
topMovers.videos.metricstring, nullable
topMovers.videos.sourcestring, nullable
topMovers.videos.toparray of object, nullable
topMovers.videos.top[].[].changestring, nullable
topMovers.videos.top[].[].changePctnumber, nullable
topMovers.videos.top[].[].contentIdstring, nullable
topMovers.videos.top[].[].previousstring, nullable
topMovers.videos.top[].[].valuestring, nullable
unavailablearray of object
weekobject, nullable
week.endDatestring, nullable
week.startDatestring, 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.