{
  "openapi": "3.0.1",
  "info": {
    "title": "TikTok Product Research & Video Growth Radar",
    "description": "Research TikTok product videos with source links, creator breadth and saved history. First run builds a baseline; repeat after 6+ hours to measure growth. JSON and HTML reports for people and agents. $0.02 per report; optional Clockworks collection costs extra.",
    "version": "0.5",
    "x-build-id": "AgbPiLAfgjMxBfDAe"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/hirepulse~viral-product-radar/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-hirepulse-viral-product-radar",
        "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/hirepulse~viral-product-radar/runs": {
      "post": {
        "operationId": "runs-sync-hirepulse-viral-product-radar",
        "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/hirepulse~viral-product-radar/run-sync": {
      "post": {
        "operationId": "run-sync-hirepulse-viral-product-radar",
        "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",
        "properties": {
          "keywords": {
            "title": "Product niches / hashtags",
            "maxItems": 20,
            "type": "array",
            "description": "Start with one specific product. Each delivered product report costs $0.02; the collection cap is shared across all keywords.",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "default": [
              "mini projector"
            ]
          },
          "upstream_source": {
            "title": "Video collection source",
            "enum": [
              "public",
              "clockworks"
            ],
            "type": "string",
            "description": "Cloud quick start: select Clockworks and check the collection consent box. Select public only to import an existing video_snapshot; direct anonymous cloud collection is not supported.",
            "default": "clockworks"
          },
          "allow_paid_upstream": {
            "title": "I allow the separately capped Clockworks collection charge",
            "type": "boolean",
            "description": "Required for live collection, off by default. At most upstream_max_charge_usd for all products together, plus $0.02 per delivered report. Import an existing export to avoid collection fees.",
            "default": false
          },
          "upstream_max_charge_usd": {
            "title": "Total upstream charge cap for the run (USD)",
            "minimum": 0.01,
            "maximum": 0.1,
            "type": "number",
            "description": "Hard total PPE limit split across all product keywords. First observations use a hashtag source; subsequent runs refresh the same tracked video URLs. Parent Actor platform usage is separate.",
            "default": 0.04
          },
          "max_items": {
            "title": "Maximum records per source",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Maximum parsed records per source and keyword; rounded sales counters remain display-only.",
            "default": 10
          },
          "state_id": {
            "title": "Persistent watchlist ID",
            "pattern": "^[A-Za-z0-9_-]{1,64}$",
            "type": "string",
            "description": "Use the same ID for repeat observations of one watchlist. Different IDs isolate histories.",
            "default": "default"
          },
          "video_snapshot": {
            "title": "Existing video observation export",
            "type": "object",
            "description": "Optional existing public-data export. Supply its actual collection time, source label and up to 100 records. No upstream service is started. Native and Clockworks JSON field names are supported."
          },
          "video_urls": {
            "title": "Video Urls",
            "maxItems": 20,
            "type": "array",
            "description": "Optional public TikTok video URLs. Only videos matching a keyword contribute linked sound evidence.",
            "items": {
              "type": "string"
            }
          },
          "analysis_mode": {
            "title": "Analysis focus",
            "enum": [
              "product_videos",
              "multi_signal"
            ],
            "type": "string",
            "description": "Product-video mode scores repeated video measurements and creator breadth. Legacy mode retains the previous four-channel engine.",
            "default": "product_videos"
          },
          "discovery_terms": {
            "title": "Commerce topics for discovery",
            "maxItems": 30,
            "type": "array",
            "description": "Commerce topic terms used to filter discovered hashtags; unrelated entertainment trends are excluded.",
            "items": {
              "type": "string"
            },
            "default": [
              "product",
              "finds",
              "shop",
              "skin",
              "clean",
              "kitchen",
              "makeup",
              "beauty",
              "gadget",
              "home",
              "fashion",
              "fitness"
            ]
          },
          "country": {
            "title": "Country",
            "pattern": "^[A-Za-z]{2}$",
            "type": "string",
            "description": "ISO two-letter region for Creative Center and public Shop pages.",
            "default": "US"
          },
          "period_days": {
            "title": "Creative Center window (7 or 30 days)",
            "minimum": 7,
            "maximum": 30,
            "type": "integer",
            "description": "Creative Center trend window, in days. This is separate from observed run-to-run growth.",
            "default": 7
          },
          "proxyConfiguration": {
            "title": "Optional proxy",
            "type": "object",
            "description": "Optional customer proxy configuration. No proxy is used by default."
          },
          "allow_paid_proxy": {
            "title": "Explicitly allow billable proxy traffic",
            "type": "boolean",
            "description": "Explicitly permit billable Apify proxy traffic. Disabled by default.",
            "default": false
          },
          "product_urls": {
            "title": "Product Urls",
            "maxItems": 20,
            "type": "array",
            "description": "Optional public TikTok Shop product URLs. Only relevant listings are used for sales-counter comparisons.",
            "items": {
              "type": "string"
            }
          },
          "min_score": {
            "title": "Minimum alert score",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Minimum temporal score for a growth alert. Baselines are separately labeled and are not alerts.",
            "default": 30
          },
          "discovery_limit": {
            "title": "Maximum new tags",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Maximum additional matching hashtags to include from public trend discovery.",
            "default": 10
          },
          "max_requests": {
            "title": "Request cap",
            "minimum": 1,
            "maximum": 120,
            "type": "integer",
            "description": "Hard cap on outbound public requests for this run, including fallbacks.",
            "default": 60
          },
          "max_runtime_seconds": {
            "title": "Network runtime cap",
            "minimum": 15,
            "maximum": 300,
            "type": "integer",
            "description": "Network time budget in seconds. The Actor can finish earlier when the request cap is reached.",
            "default": 120
          },
          "discover": {
            "title": "Discover public Creative Center tags",
            "type": "boolean",
            "description": "Inspect public Creative Center trend records and add matching commerce topics.",
            "default": true
          },
          "include_baseline": {
            "title": "Return explicit first-observation baselines",
            "type": "boolean",
            "description": "Deliver explicit first-observation baseline rows, with is_alert=false.",
            "default": true
          },
          "only_changes": {
            "title": "Suppress unchanged signals",
            "type": "boolean",
            "description": "Suppress repeated delivery of the same signal fingerprint.",
            "default": true
          },
          "deliver_all_reports": {
            "title": "Deliver each new product research report",
            "type": "boolean",
            "description": "Deliver baselines, watch reports and candidates for every new observation. Each delivered report is billable. Reimporting the same acknowledged observation is suppressed. False selects the legacy alert/baseline feed.",
            "default": true
          },
          "collect_ads": {
            "title": "Inspect public ad records",
            "type": "boolean",
            "description": "Attempt public Creative Center ad collection. Permission failures are reported, not bypassed.",
            "default": true
          },
          "collect_shop": {
            "title": "Inspect public Shop listings",
            "type": "boolean",
            "description": "Attempt public product listing collection. Missing sales counters do not mean zero sales.",
            "default": true
          },
          "collect_videos": {
            "title": "Inspect public videos and linked sounds",
            "type": "boolean",
            "description": "Attempt public matching-video collection and linked sound statistics.",
            "default": true
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}