{ "openapi": "3.0.1", "info": { "title": "TikTok Video Stats: Views, Likes, Comments, Shares by URL", "description": "Fresh views, likes, comments, shares and saves for a list of TikTok videos, read from the public video page. No login, no browser, no proxy. Deleted and private videos get their own status. Built for repeat measurements.", "version": "0.2", "x-build-id": "ADb3DUTlpEe2qK0aZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sergeyfaraday~tiktok-video-stats/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sergeyfaraday-tiktok-video-stats", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/sergeyfaraday~tiktok-video-stats/runs": { "post": { "operationId": "runs-sync-sergeyfaraday-tiktok-video-stats", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/sergeyfaraday~tiktok-video-stats/run-sync": { "post": { "operationId": "run-sync-sergeyfaraday-tiktok-video-stats", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "videoUrls" ], "properties": { "videoUrls": { "title": "Video URLs or ids", "type": "array", "description": "TikTok video URLs, short links (vm.tiktok.com) or numeric video ids. Each video is measured separately; a deleted, closed or missing video is reported as an object_state row with its own status. For a panel measured over time use numeric ids: a dead short link has no id to join with earlier rows.", "items": { "type": "string" } }, "delayMs": { "title": "Delay between videos (ms)", "minimum": 500, "maximum": 60000, "type": "integer", "description": "Pause between two page requests.", "default": 1500 }, "stopAfterBlocks": { "title": "Stop after N blocks in a row", "minimum": 1, "maximum": 50, "type": "integer", "description": "Stop the run when this many videos in a row are blocked. Remaining videos are reported as not_attempted.", "default": 5 }, "controlVideoUrl": { "title": "Control video (optional)", "type": "string", "description": "URL or id of a video you know is live. When a video answers not_found, this one is read too, without a row of its own. If it does not read as live, the run reports NOT_FOUND_UNCONFIRMED and status partial: this address may get that answer for live videos too." }, "snapshotId": { "title": "Snapshot ID", "type": "string", "description": "Your id for this snapshot, one per task of one actor. Rows get recordKey = platform:type:id:snapshotId, so a repeat with the same snapshotId gives the same keys, and a new id gives a new observation. A repeat reads the source again: compare provenance.contentChecksum to see whether the values moved. Default: .." }, "queryId": { "title": "Query profile ID", "type": "string", "description": "Your search profile id, copied into provenance.queryId." }, "queryVersion": { "title": "Query profile version", "type": "string", "description": "Search profile version, copied into provenance.queryVersion." }, "panelId": { "title": "Panel ID", "type": "string", "description": "Fixed panel id for refresh runs, copied into provenance.panelId." }, "panelVersion": { "title": "Panel version", "type": "string", "description": "Panel composition version; a new composition must get a new version." }, "maxItems": { "title": "Max records", "minimum": 1, "type": "integer", "description": "Hard cap on dataset rows for this run. Separate from the run money cap (maxTotalChargeUsd), which is set on the run itself." }, "maxRunSeconds": { "title": "Soft time budget (s)", "minimum": 30, "type": "integer", "description": "Stop starting new units this many seconds after the run started and finish with a partial manifest. The budget belongs to the run: a restart does not renew it, and the time between workers counts." }, "keepRaw": { "title": "Keep raw upstream item", "type": "boolean", "description": "Store the raw upstream item in `raw`. Off by default. provenance.rawChecksum is present on rows built from a raw item; it is null on a state row with no answer behind it and on derived rows.", "default": false }, "failOnPartial": { "title": "Fail run on partial", "type": "boolean", "description": "By default a partial result finishes as SUCCEEDED with status=partial in the MANIFEST record. Failed and blocked always finish as FAILED.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy for upstream requests. Not needed in tests: video pages are served to datacenter addresses.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }