Check pending sample requests against criteria (read only: nothing is approved)
POST
/api/public/v1/tik_tok_shop/samples/matchConnectorAnswers empty results in the documented shape until the brand switches on this connection.
Operation id matchTikTokShopSamples
Request
curl
curl -X POST "https://creator.growthdept.ai/api/public/v1/tik_tok_shop/samples/match" \
-H "Authorization: Bearer gdc_..." \
-H "Content-Type: application/json" \
-d '{"applicationIds":["string"],"criteria":{"categories":["string"],"cooldownDays":3,"excludeSampleStates":["sample_requested"],"maxFollowers":3,"maxProductsSampled":{"max":3,"withinDays":3},"minFollowers":3,"minFulfillmentRate":0.15,"minGmvGlobal30d":{"amount":"string","currency":"usd"},"minPastSampleGmv":{"amount":"string","currency":"usd"},"minPostedRate":0.15,"productIds":["string"]},"cursor":"string","include":"matched","includeFrontierUnresolved":true,"limit":3,"timezone":"string","unknownAs":"fail"}'Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| organization_id | query | integer |
Request body
| Field | Type | Notes |
|---|---|---|
| applicationIds | array of string | |
| criteria | object | required |
| criteria.categories | array of string | |
| criteria.cooldownDays | integer | |
| criteria.excludeSampleStates | array of string | |
| criteria.maxFollowers | integer | |
| criteria.maxProductsSampled | object | |
| criteria.maxProductsSampled.max | integer | required |
| criteria.maxProductsSampled.withinDays | integer | required |
| criteria.minFollowers | integer | |
| criteria.minFulfillmentRate | number | |
| criteria.minGmvGlobal30d | object | |
| criteria.minGmvGlobal30d.amount | string | required |
| criteria.minGmvGlobal30d.currency | string | |
| criteria.minPastSampleGmv | object | |
| criteria.minPastSampleGmv.amount | string | required |
| criteria.minPastSampleGmv.currency | string | |
| criteria.minPostedRate | number | |
| criteria.productIds | array of string | |
| cursor | string | |
| include | string | One of matchedall |
| includeFrontierUnresolved | boolean | |
| limit | integer | |
| timezone | string | |
| unknownAs | string | One of failpass |
Example
{
"applicationIds": [
"string"
],
"criteria": {
"categories": [
"string"
],
"cooldownDays": 3,
"excludeSampleStates": [
"sample_requested"
],
"maxFollowers": 3,
"maxProductsSampled": {
"max": 3,
"withinDays": 3
},
"minFollowers": 3,
"minFulfillmentRate": 0.15,
"minGmvGlobal30d": {
"amount": "string",
"currency": "usd"
},
"minPastSampleGmv": {
"amount": "string",
"currency": "usd"
},
"minPostedRate": 0.15,
"productIds": [
"string"
]
},
"cursor": "string",
"include": "matched",
"includeFrontierUnresolved": true,
"limit": 3,
"timezone": "string",
"unknownAs": "fail"
}Responses
200Success
| Field | Type | Notes |
|---|---|---|
| approvalsToday | object | required |
| approvalsToday.local | object, nullable | required |
| approvalsToday.local.applications | integer | required |
| approvalsToday.local.day | string (date) | required |
| approvalsToday.local.from | string (date-time) | required |
| approvalsToday.local.timezone | string | required |
| approvalsToday.local.viaGateway | integer | required |
| approvalsToday.utc | object | required |
| approvalsToday.utc.applications | integer | required |
| approvalsToday.utc.day | string (date) | required |
| approvalsToday.utc.from | string (date-time) | required |
| approvalsToday.utc.timezone | string | required |
| approvalsToday.utc.viaGateway | integer | required |
| counts | object | required |
| counts.evaluated | integer | required |
| counts.matched | integer | required |
| counts.scanned | integer | required |
| items | array of object | required |
| items[].[].applicationId | string | required |
| items[].[].creatorId | string | required |
| items[].[].creatorPendingApplicationIds | array of string | required |
| items[].[].creatorUsername | string, nullable | required |
| items[].[].criteria | object | required |
| items[].[].criteria.categories | object | |
| items[].[].criteria.categories.result | string | requiredOne of passfailunknown |
| items[].[].criteria.categories.value | required | |
| items[].[].criteria.cooldownDays | object | |
| items[].[].criteria.cooldownDays.result | string | requiredOne of passfailunknown |
| items[].[].criteria.cooldownDays.value | required | |
| items[].[].criteria.excludeSampleStates | object | |
| items[].[].criteria.excludeSampleStates.result | string | requiredOne of passfailunknown |
| items[].[].criteria.excludeSampleStates.value | required | |
| items[].[].criteria.maxFollowers | object | |
| items[].[].criteria.maxFollowers.result | string | requiredOne of passfailunknown |
| items[].[].criteria.maxFollowers.value | number, nullable | required |
| items[].[].criteria.maxProductsSampled | object | |
| items[].[].criteria.maxProductsSampled.result | string | requiredOne of passfailunknown |
| items[].[].criteria.maxProductsSampled.value | required | |
| items[].[].criteria.minFollowers | object | |
| items[].[].criteria.minFollowers.result | string | requiredOne of passfailunknown |
| items[].[].criteria.minFollowers.value | number, nullable | required |
| items[].[].criteria.minFulfillmentRate | object | |
| items[].[].criteria.minFulfillmentRate.result | string | requiredOne of passfailunknown |
| items[].[].criteria.minFulfillmentRate.value | number, nullable | required |
| items[].[].criteria.minGmvGlobal30d | object | |
| items[].[].criteria.minGmvGlobal30d.result | string | requiredOne of passfailunknown |
| items[].[].criteria.minGmvGlobal30d.value | required | |
| items[].[].criteria.minPastSampleGmv | object | |
| items[].[].criteria.minPastSampleGmv.result | string | requiredOne of passfailunknown |
| items[].[].criteria.minPastSampleGmv.value | required | |
| items[].[].criteria.minPostedRate | object | |
| items[].[].criteria.minPostedRate.result | string | requiredOne of passfailunknown |
| items[].[].criteria.minPostedRate.value | required | |
| items[].[].criteria.productIds | object | |
| items[].[].criteria.productIds.result | string | requiredOne of passfailunknown |
| items[].[].criteria.productIds.value | required | |
| items[].[].firstSeenAt | string (date-time) | required |
| items[].[].frontierUnresolved | boolean | required |
| items[].[].lastSeenAt | string (date-time) | required |
| items[].[].matched | boolean | required |
| items[].[].products | array of object | required |
| items[].[].products[].[].productId | string, nullable | |
| items[].[].products[].[].productTitle | string, nullable | |
| nextCursor | string | |
| note | string | required |
Example
{
"approvalsToday": {
"local": {
"applications": 3,
"day": "2026-11-01",
"from": "2026-11-01T15:04:05Z",
"timezone": "string",
"viaGateway": 3
},
"utc": {
"applications": 3,
"day": "2026-11-01",
"from": "2026-11-01T15:04:05Z",
"timezone": "string",
"viaGateway": 3
}
},
"counts": {
"evaluated": 3,
"matched": 3,
"scanned": 3
},
"items": [
{
"applicationId": "string",
"creatorId": "string",
"creatorPendingApplicationIds": [
"string"
],
"creatorUsername": "Example name",
"criteria": {
"categories": {
"result": "pass",
"value": "string"
},
"cooldownDays": {
"result": "pass",
"value": "string"
},
"excludeSampleStates": {
"result": "pass",
"value": "string"
},
"maxFollowers": {
"result": "pass",
"value": 125.5
},
"maxProductsSampled": {
"result": "pass",
"value": "string"
},
"minFollowers": {
"result": "pass",
"value": 125.5
},
"minFulfillmentRate": {
"result": "pass",
"value": 125.5
},
"minGmvGlobal30d": {
"result": "pass",
"value": "string"
},
"minPastSampleGmv": {
"result": "pass",
"value": "string"
},
"minPostedRate": {
"result": "pass",
"value": "string"
},
"productIds": {
"result": "pass",
"value": "string"
}
},
"firstSeenAt": "2026-11-01T15:04:05Z",
"frontierUnresolved": true,
"lastSeenAt": "2026-11-01T15:04:05Z",
"matched": true,
"products": [
{
"productId": "string",
"productTitle": "string"
}
]
}
],
"nextCursor": "string",
"note": "string"
}Errors: 400401403404422429502with an error and usually a message. See errors.
Example values are made up from each field's type and name.