TikTok Shop

Counts per stage, conversion rates and time in stage for a cohort of sample requests

GET/api/public/v1/tik_tok_shop/samples/funnel
ConnectorAnswers empty results in the documented shape until the brand switches on this connection.

Operation id getTikTokShopSampleFunnel

Request

curl

curl "https://creator.growthdept.ai/api/public/v1/tik_tok_shop/samples/funnel?start_date=2026-11-01&end_date=2026-11-01" \
  -H "Authorization: Bearer gdc_..."

Parameters

NameInTypeNotes
start_datequerystringrequired
end_datequerystringrequired
productIdquerystring
targetCollaborationIdquerystring
organization_idqueryinteger

Responses

200Success

FieldTypeNotes
byCollabTypeobject, nullable
byCollabType.openobject, nullable
byCollabType.open.approvednumber, nullable
byCollabType.open.contentFulfillednumber, nullable
byCollabType.open.requestednumber, nullable
byCollabType.open.shippednumber, nullable
byCollabType.targetobject, nullable
byCollabType.target.approvednumber, nullable
byCollabType.target.contentFulfillednumber, nullable
byCollabType.target.requestednumber, nullable
byCollabType.target.shippednumber, nullable
cohortnumber, nullable
currentStatesobject, nullable
currentStates.awaiting_shipmentnumber, nullable
currentStates.cancellednumber, nullable
currentStates.content_fulfillednumber, nullable
currentStates.content_pendingnumber, nullable
currentStates.content_unfulfillednumber, nullable
currentStates.sample_requestednumber, nullable
exitsarray of object, nullable
exits[].[].countnumber, nullable
exits[].[].keystring, nullable
exits[].[].rateFromRequestednumber, nullable
exits[].[].sourcestring, nullable
filtersobject, nullable
filters.productId, nullable
filters.targetCollaborationId, nullable
shopIdstring, nullable
stagesarray of object, nullable
stages[].[].countnumber, nullable
stages[].[].keystring, nullable
stages[].[].rateFromPreviousnumber, nullable
stages[].[].rateFromRequestednumber, nullable
stages[].[].sourcestring, nullable
stages[].[].timeInStageobject, nullable
stages[].[].timeInStage.medianHoursnumber, nullable
stages[].[].timeInStage.p90Hoursnumber, nullable
stages[].[].timeInStage.rowsnumber, nullable
windowobject, nullable
window.endDatestring, nullable
window.startDatestring, nullable

Example

{
  "byCollabType": {
    "open": {
      "approved": 125.5,
      "contentFulfilled": 125.5,
      "requested": 125.5,
      "shipped": 125.5
    },
    "target": {
      "approved": 125.5,
      "contentFulfilled": 125.5,
      "requested": 125.5,
      "shipped": 125.5
    }
  },
  "cohort": 125.5,
  "currentStates": {
    "awaiting_shipment": 125.5,
    "cancelled": 125.5,
    "content_fulfilled": 125.5,
    "content_pending": 125.5,
    "content_unfulfilled": 125.5,
    "sample_requested": 125.5
  },
  "exits": [
    {
      "count": 125.5,
      "key": "string",
      "rateFromRequested": 0.15,
      "source": "string"
    }
  ],
  "filters": {
    "productId": "string",
    "targetCollaborationId": "string"
  },
  "shopId": "string",
  "stages": [
    {
      "count": 125.5,
      "key": "string",
      "rateFromPrevious": 0.15,
      "rateFromRequested": 0.15,
      "source": "string",
      "timeInStage": {
        "medianHours": 125.5,
        "p90Hours": 125.5,
        "rows": 125.5
      }
    }
  ],
  "window": {
    "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.