tiktok

Effect › Videos

Returns public TikTok videos created with a camera effect, each with engagement counts, caption, author, and a playable URL.

Use it with an effect id from effects, and send the cursor back unchanged. TikTok picks its own page size here and ignores the one you ask for.

10 credits per call.

Paginates by cursor: see Pagination.

get/v1/tiktok/effect/videos

Request

Base URL: https://api.insightsocial.app
URL: https://api.insightsocial.app/v1/tiktok/effect/videos
Auth: API key in header x-api-key

Query parameters

effect_idstring required

Example:1108584

TikTok effect id, as returned by /v1/tiktok/effects.

cursorstring

Cursor from the previous response to fetch the next page of videos.

regionstring

Two-letter country code that localises the results. Defaults to US.

sincestring

Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following next_cursor, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept.

untilstring

Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept.

dry_run'1'

Set to 1 to get the price of this call without making it: data.dry_run carries credits_min and credits_max. Nothing is charged.

Response

Success.

successtrue required

platformstring required

endpointstring required

schema_version'2' required

unavailablestring[] required

credits_usedinteger required

credits_remaininginteger required

request_idstring required

cachedboolean required

idempotent_replayboolean required

charge_reasonstring required

free_callboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.