tiktok

Effects

Returns TikTok camera effects by id, each with its name, its designer, the views of videos made with it, and how many such videos exist.

Use it to look several effects up in one call, and match results by the returned id. Repeated ids collapse and unknown ids drop, so the response can be shorter.

10 credits per call.

get/v1/tiktok/effects

Request

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

Query parameters

idsstring required

Example:1108584,1109028

Comma-separated TikTok effect ids, up to 50 per request.

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.