Add to a collection
add_to_collectionUse when putting a Tracker into a Collection (id or name): by tracker_id, or by platform + target, which starts a Tracker if not tracked yet. Not for a focus or a refresh: track (its collection argument files it too). Price: Free for a Tracker you have; a new target runs its first cycle: creator 6, hashtag 3, keyword 3, sound 6, advertiser 30 credits; +20 credits per new video analysed. A new name creates the Collection with the Tracker's kind (pass kind with a target); another kind is collection_kind_mismatch. Collections mix Meta, Google and TikTok Advertisers.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"collection": "<collection>"
},
"name": "add_to_collection"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | Adding by target: the Tracker's kind. Required for a new Collection. | |
| target | No | Handle, hashtag, phrase (kind=keyword), sound id, Page id, or with platform tiktok or platform google an advertiser id, URL or name | |
| estimate | No | Quote the price in Credits: no Run, no charge | |
| platform | No | With target, instead of tracker_id | |
| collection | Yes | The Collection, by id or name. A new name creates it, with the Tracker's kind. | |
| tracker_id | No | A Tracker you already have | |
| max_credits | No | ||
| intelligence | No | Analyse new videos, when the target is not tracked yet |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| run | No | The new Tracker's first cycle; null when nothing was created. | |
| added | No | False when the Tracker was already a member (200), or, with `collection_error`, when the Collection was deleted before the new Tracker could join (201). | |
| cached | No | ||
| created | No | True when this call started tracking the target. | |
| tracker | No | The member, as it now is, state included. | |
| per_cycle | No | ||
| collection | No | Absent only with `collection_error`. | |
| tracker_id | No | ||
| already_tracking | No | ||
| collection_error | No | Only when the Collection was deleted while the new Tracker's first cycle ran. | |
| estimate_credits | No | ||
| intelligence_run | No | The Run analysing the first cycle's new Ads (an advertiser Tracker with `intelligence. |