Shortimize

它列出的 32 个工具

“只读”和“会改数据”是服务方自己标的。带下划线的参数是必填的。

1. add_accounts_to_collection

   Add Accounts To Collection

   Add one or more accounts (account_ids) to the collection identified by collection_id. Use get_collection_accounts to check membership; remove_accounts_from_collection reverses it.

   collection_id account_ids

2. add_videos_to_collection

   Add Videos To Collection

   Add one or more videos (video_ids) to the collection identified by collection_id. Use get_collection_videos to check membership; remove_videos_from_collection reverses it.

   collection_id video_ids

3. authenticate只读

   Check API Key

   Test your AUTH key against our service, if successful your organisation name will be returned.

4. bulk_stop_tracking_accounts会改数据

   Bulk Stop Tracking Accounts

   Stop tracking up to 500 accounts in one request. Each entry in ids can be an account id or the link you originally tracked. Historical data stays available; this only stops new data being collected. If a link cannot be matched the whole request fails with 404 before anything is removed; a request of ids can partly succeed.

   ids leave_videos

5. bulk_stop_tracking_videos会改数据

   Bulk Stop Tracking Videos

   Stop tracking up to 500 videos in one request. Each entry in ids can be a video id or the link you originally tracked. Historical data stays available; this only stops new data being collected. If a link cannot be matched the whole request fails with 404 before anything is removed; a request of ids can partly succeed.

   ids

6. bulk_track_accounts

   Bulk Track Accounts

   Start tracking up to 500 accounts in one request. Each link is handled on its own, so one bad link does not stop the rest - the response returns one entry per link with a status of tracked, already_tracked, or failed, and failed entries say whether retrying will help. Send 50 links or fewer if the data needs to start arriving immediately; larger batches are still tracked but are collected by the scheduled update.

   links label_ids tracking_type

7. bulk_track_videos

   Bulk Track Videos

   Start tracking up to 500 videos in one request. Each link is handled on its own, so one bad link does not stop the rest - the response returns one entry per link with a status of tracked, already_tracked, or failed, and failed entries say whether retrying will help. Send 50 links or fewer if the data needs to start arriving immediately; larger batches are still tracked but are collected by the scheduled update.

   links label_ids

8. create_collection

   Create Collection

   Create a new collection for organizing accounts and videos, with a name and optional parent_id and access. Fill it afterwards with add_videos_to_collection or add_accounts_to_collection.

   name parent_id access

9. delete_collection会改数据

   Delete Collection

   Delete the collection identified by collection_id. This also removes all of its associations with accounts and videos.

   collection_id

10. get_account只读

    Get Account

    Get one tracked account by account_id (an account UUID or its URL, URL-encoded), with platform, username, bio, follower and following counts, view/like/comment/share totals, median and mean views, percent_outperform_10x/25x and total_videos_tracked. Use it for the current stats of a single account; use get_account_history for its daily trend, get_videos_linked_to_account for its videos and get_all_accounts to find account ids. Returns one account object. Tier limits: Limited/Basic keys get 1 result with masked metrics; Premium gets full access.

    account_id

11. get_account_history只读

    Get Account History

    Get daily aggregated metrics (views, likes, comments, shares, bookmarks, engagements, ads_upload_count, total_ads) for one tracked account, identified by account_id. Defaults to the last 30 days; use start_date and end_date (YYYY-MM-DD) to change the range, within the last 90 days (2 years for Premium). Use it to see an account's trend over time; use get_account for its current stats, or get_organisation_history for the whole organisation. Returns an array with one entry per date. Tier limits: Limited/Basic keys get 1 result with masked metrics; Premium gets full access.

    account_id start_date end_date

12. get_all_accounts只读

    List Tracked Accounts

    List every account your organisation tracks (TikTok, Instagram or YouTube profiles), one row per account with username, platform, follower count, view/like/comment/share/bookmark totals, median and mean views, percent_outperform_10x/25x and total_videos_tracked. Use it to find account ids or compare accounts; use get_account for one account, get_account_history for its daily trend, get_collection_accounts for one collection's accounts. The collections filter matches collection names. Returns a plain array, or { data, pagination } when paginated=true. Tier limits: Limited/Basic keys get 1 result with masked metrics; Premium gets full access.

    collections paginated page limit order_by order_direction

13. get_all_collections只读

    List Collections

    List the collections your organisation uses to group accounts and videos, with id, name, parent_id, access (private, public or protected), created_at and hashtags. Optionally list only the children of a parent_id (include_children). Use it to find a collection_id for get_collection, get_collection_videos, get_collection_accounts or the add/remove tools. Returns { data, count }. Tier limits: Limited/Basic keys get 1 result with masked metrics; Premium gets full access.

    parent_id include_children paginated page limit order_by order_direction

14. get_all_videos只读

    List Tracked Videos

    List the videos your organisation tracks, one row per video with ad_id, platform, username, title, upload date, latest views/likes/comments/shares/bookmarks, outlier_multiplier and increase_1d/7d/14d/30d growth. Filter by username, linked_account_id, upload or last-update date range, has_metrics or collection names. Use it to search across all videos; use get_video for one video, get_videos_linked_to_account for one account's videos, get_collection_videos for one collection's videos. Returns { data, pagination, filters }. Tier limits: Limited/Basic keys get 1 result with masked metrics; Premium gets full access.

    page limit order_by order_direction username linked_account_id uploaded_at_start uploaded_at_end latest_updated_at_start latest_updated_at_end ad_info_shop ad_product_id_shop has_metrics collections

15. get_collection只读

    Get Collection

    Get one collection by collection_id, with name, parent_id, access, hashtags and display_settings. Set include_counts=true to include video_count and account_count. Use it to inspect a single collection; use get_collection_videos or get_collection_accounts to see what it contains and get_all_collections to find ids. Returns one collection object. Tier limits: Limited/Basic keys get 1 result with masked metrics; Premium gets full access.

    collection_id include_counts

16. get_collection_accounts只读

    List Collection Accounts

    List the accounts that belong to one collection, identified by collection_id, with sorting and pagination (page, limit, order_by, order_direction). Use it to review one collection's accounts; use get_all_accounts to search across all accounts, and add_accounts_to_collection or remove_accounts_from_collection to change membership. Returns { data, pagination }. Tier limits: Limited/Basic keys get 1 result with masked metrics; Premium gets full access.

    collection_id paginated page limit order_by order_direction

17. get_collection_videos只读

    List Collection Videos

    List the videos that belong to one collection, identified by collection_id, with sorting and pagination (page, limit, order_by, order_direction). Use it to review one collection's videos; use get_all_videos to search across all videos, and add_videos_to_collection or remove_videos_from_collection to change membership. Returns { data, pagination }. Tier limits: Limited/Basic keys get 1 result with masked metrics; Premium gets full access.

    collection_id paginated page limit order_by order_direction

18. get_organisation_history只读

    Get Organisation History

    Get daily aggregated metrics (views, likes, comments, shares, bookmarks, engagements, total_ads, ads_upload_count) across everything your organisation tracks. Defaults to the last 30 days; use start_date and end_date (YYYY-MM-DD) to change the range, within the last 90 days (2 years for Premium). Use it for an organisation-wide trend; use get_account_history or get_video_history for a single account or video. Returns an array with one entry per date. Tier limits: Limited/Basic keys get 1 result with masked metrics; Premium gets full access.

    start_date end_date

19. get_video只读

    Get Video

    Get one tracked video by ad_id (a video UUID or its URL, URL-encoded), with platform, username, title, upload date, latest views/likes/comments/shares/bookmarks, outlier_multiplier and increase_1d/7d/14d/30d growth. Use it for the current numbers of a single video; use get_video_history for its daily metrics over time and get_all_videos to find ad_ids. Returns one video object. Tier limits: Limited/Basic keys get 1 result with masked metrics; Premium gets full access.

    ad_id

20. get_video_history只读

    Get Video History

    Get daily metrics (views, likes, comments, shares, bookmarks, engagements) for one tracked video, identified by ad_id. Defaults to the last 30 days; use start_date and end_date (YYYY-MM-DD) to change the range, up to 90 days (730 for Premium, where data older than 90 days is interpolated from periodic snapshots). Use it to see how a video grew over time; use get_video for its current numbers. Returns an array with one entry per date. Tier limits: Limited/Basic keys get 1 result with masked metrics; Premium gets full access.

    ad_id start_date end_date

21. get_videos_linked_to_account只读

    List Videos For Account

    List the tracked videos that belong to one account, identified by account_id (an account UUID or its URL, URL-encoded), with the same per-video fields as get_all_videos (ad_id, title, latest views/likes/comments/shares, outlier_multiplier, increase_1d/7d). Optionally filter by upload date with start_date and end_date, and sort or paginate. Use it to review one creator's videos; use get_all_videos to search across every account. Returns a plain array, or { data, pagination } when paginated=true. Tier limits: Limited/Basic keys get 1 result with masked metrics; Premium gets full access.

    account_id start_date end_date paginated page limit order_by order_direction

22. refresh_account_data

    Refresh Account Data

    Refresh an account, if it wasn't updated in the last 4 hours.

    link

23. refresh_video_data

    Refresh Video Data

    Refresh a video, if it wasn't updated in the last 4 hours.

    link

24. remove_accounts_from_collection会改数据

    Remove Accounts From Collection

    Remove one or more accounts (account_ids) from the collection identified by collection_id, ending their membership in that collection. Use get_collection_accounts to check what remains.

    collection_id account_ids

25. remove_videos_from_collection会改数据

    Remove Videos From Collection

    Remove one or more videos (video_ids) from the collection identified by collection_id, ending their membership in that collection. Use get_collection_videos to check what remains.

    collection_id video_ids

26. stop_tracking_account会改数据

    Stop Tracking Account

    Stop tracking an account linked to your organisation, identified by its ID (UUID) or URL. Use it to pause monitoring an account that is no longer relevant or to free tracking quota; use bulk_stop_tracking_accounts for many at once.

    id

27. stop_tracking_video会改数据

    Stop Tracking Video

    Stop tracking a video in Shortimize, identified by its ID (UUID) or URL. Historical performance data stays available; this only stops new data being collected. Use bulk_stop_tracking_videos for many at once.

    id

28. total_accounts只读

    Count Tracked Accounts

    Retrieves the total number of accounts currently being tracked by your organization in Shortimize.

29. total_videos只读

    Count Tracked Videos

    Retrieves the total count of videos being tracked by your organization in Shortimize.

30. track_account

    Track Account

    Track an account and link it to your organisation in Shortimize.

    link collection_ids collection_names tracking_type

31. track_video

    Track Video

    Track a video and link it to your organisation in Shortimize. A direct URL to the video analysis on Shortimize will be returned.

    link collection_ids collection_names

32. update_collection会改数据

    Update Collection

    Update a collection's properties (name, parent_id, access, password, display_settings) by collection_id. Use get_collection first to see the current values.

    collection_id name parent_id access password display_settings