Video
commerce.videoUnifiedSoonA shoppable short video, with the products it tags and the sales it drove.
key platform + video IDSame as Post4 planned calls3 Direct endpoints today
4 calls plannedSoon
Calls from commerce API design 0.1.0-draft, written as REST paths. Each call returns this entity in one shape on the platforms it lists, and none is deployed yet.
- GET
/One video's views, engagement, sales and GMVTikTok ShopDesignedv1/ e-commerce/ tiktok-shop/ videos/ {videoId} - GET
/Filter videos by creator, product, category, views and publish dateTikTok ShopDesignedv1/ e-commerce/ tiktok-shop/ videos/ search - GET
/Video rankings by views or sales, by day, week or monthTikTok ShopDesignedv1/ e-commerce/ tiktok-shop/ videos/ rankings - GET
/Daily snapshots of one video for up to 180 daysTikTok ShopSource pendingv1/ e-commerce/ tiktok-shop/ videos/ trends
58 fields in the field contractDesign 0.1.0-draft · listing-contract-v3.2
Field keys and how each value is written, as the design defines them. Only fields a source actually returned come back.
Identity5
AIsa's ID, the platform, the site and the platform's own IDentity.iduuidentity.kindstringentity.platformstringentity.scopestringvideo.native_idstring
Profile19
Details the platform publishes about itvideo.descriptionstringvideo.dynamic_cover_urlurlvideo.play_urlurlvideo.download_urlurlvideo.download_url_no_watermarkstringvideo.duration_secondsdecimalvideo.width_pixelsdecimalvideo.height_pixelsdecimalvideo.ad_period_daysdecimal
Show 10 more fieldsShow fewer
video.resolutionstringvideo.file_size_rawstringvideo.published_at_rawjsonvideo.is_commercial_rawjsonvideo.is_ad_rawjsonvideo.is_ai_generated_rawjsonvideo.ad_source_rawjsonvideo.has_comments_rawjsonvideo.hashtags_rawjsonvideo.commentsobject[]
Page2
Title, link, images and what the page showsurlurlimage.cover_urlurl
Metrics27
Sales, GMV and engagement, each over its source's periodmetrics.sales_countdecimalmetrics.gmvdecimalmetrics.video_view_countdecimalmetrics.video_gpm_reporteddecimalmetrics.sales_count_30ddecimalmetrics.gmv_30ddecimalmetrics.product_count_reporteddecimalmetrics.gmv_growth_rate_reporteddecimalmetrics.video_like_to_follower_ratio_reporteddecimal
Show 18 more fieldsShow fewer
metrics.video_gpm_30ddecimalmetrics.video_view_count_1ddecimalmetrics.video_view_count_7ddecimalmetrics.video_view_count_30ddecimalmetrics.video_like_count_1ddecimalmetrics.video_like_count_7ddecimalmetrics.video_like_count_30ddecimalmetrics.video_engagement_rate_reporteddecimalmetrics.video_like_to_view_ratio_reporteddecimalmetrics.ad_view_count_reporteddecimalmetrics.ad_view_share_reporteddecimalmetrics.ad_gmv_share_reporteddecimalmetrics.ad_roas_reporteddecimalmetrics.ad_cpa_reporteddecimalmetrics.video_like_countdecimalmetrics.video_comment_countdecimalmetrics.video_share_countdecimalmetrics.video_favorite_countdecimal
Links4
AIsa IDs of the entities it points atrelated.listing_performanceobject[]related.listingsuuid[]related.shopsuuid[]relation.creator_iduuid
Context1
The currency every money field usescontext.currencystring
decimal and integer values arrive as strings to keep precision. A key ending in _reported is the source's own figure, method unconfirmed; _raw keeps the source's raw code. uuid fields point at other AIsa entities.
Call it today through DirectLive
Vendor endpoints that already return this kind of object, in the vendor's own format. Your code names the vendor, so switching vendors means changing it.
3 endpoints from 1 API · from $0.001
| API | Method | Path | Endpoint | Price |
|---|---|---|---|---|
| TikHub | POST | tikhub/tiktok/creator/get_product_related_videos | tiktok get_product_related_videos | from $0.001 |
| TikHub | POST | tikhub/tiktok/creator/get_video_associated_product_list | tiktok get_video_associated_product_list | from $0.001 |
| TikHub | POST | tikhub/tiktok/creator/get_video_to_product_stats | tiktok get_video_to_product_stats | from $0.001 |
Next to Video
Each link is a field you can ask for in the same call.
Post
platform + post IDA post on one platform, with its link and metrics.
Creator
platform + creator IDA creator who sells through affiliate links.
Listing
marketplace + listing IDOne product page on one marketplace: price, rank, reviews and sales.
Shop
marketplace + seller IDA seller account on one marketplace.