
Linkfox Sif Asin Summary
- 232 installs
- 64 repo stars
- Updated August 3, 2026
- linkfox-ai/linkfox-skills
Helps with ai & agent building tasks.
About
linkfox-sif-asin-summary is a Claude Code skill for ai & agent building. It helps solo builders move faster with AI-assisted development.
- linkfox-sif-asin-summary
- AI & Agent Building
- AI-coding skill
Linkfox Sif Asin Summary by the numbers
- 232 all-time installs (skills.sh)
- +35 installs in the week ending Aug 2, 2026 (Skillselion tracking)
- Ranked #2,670 of 16,546 AI & Agent Building skills by installs in the Skillselion catalog
- Data as of Aug 4, 2026 (Skillselion catalog sync)
npx skills add https://github.com/linkfox-ai/linkfox-skills --skill linkfox-sif-asin-summaryAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 232 |
|---|---|
| repo stars | ★ 64 |
| Last updated | August 3, 2026 |
| Repository | linkfox-ai/linkfox-skills ↗ |
What it does
Helps with ai & agent building tasks.
Files
SIF ASIN Summary
This skill guides you on how to query and analyze ASIN-level traffic source data, helping Amazon sellers understand the exposure and traffic structure of any product across multiple channels.
Core Concepts
SIF (Search Intelligence Framework) ASIN Summary provides a comprehensive breakdown of an ASIN's traffic sources on Amazon. It reveals how a product's total exposure is distributed across organic search, Sponsored Products ads, brand ads, video ads, Amazon's Choice, Editorial Recommendations, and Top Rated recommendations. This is essential for competitive analysis and traffic strategy optimization.
Exposure score: A composite metric reflecting the overall visibility of a product across all keywords in a given channel. A higher score means greater exposure. The exposure ratio fields show what percentage of total exposure comes from each channel (values range 0~1 or 0~100 depending on the field).
Traffic keyword count: The total number of keywords through which a product is discovered, broken down by channel (organic search, SP ads, brand ads, video ads, etc.).
Data Fields
Field-name suffixes:*Prev= previous-period value;*In/*Out= keywords entering / exiting this period (for period-over-period comparison).
| Field | API Name | Description |
|---|---|---|
| ASIN | asin | Amazon Standard Identification Number |
| Product Title | productTitle | Full product title on Amazon |
| Product Category | productCategory | Product category on Amazon |
| Product Price | productPrice | Current listing price |
| Product Image URL | productImageUrl | Main product image link |
| Product Features | productFeatures | Bullet-point product features list |
| Customer Rating Count | customerRatingCount | Total number of customer ratings |
| Product Star Rating | productStarRating | Product star rating (0–5) |
| Product Rating Score | productRatingScore | Product rating score (0–5, as shown on Amazon) |
| Is Variant Product | isVariantProduct | Whether the ASIN is a variant (e.g., different color/size) |
| Recent Monthly Sales Bucket | recentMonthlySalesBucket | Bucketed last-month sales (e.g. "300+", "1,000+") — only populated for keywordSummary path |
| Is Monitored | isMonitored | Whether the ASIN is on the monitoring list |
| Monitoring Start Time | monitoringStartTime | When the ASIN was added to monitoring |
| Data Period Start Date | dataPeriodStartDate | Start date of the returned data period (yyyy-MM-dd) |
| Total Exposure Score | totalExposureScore | Composite exposure score across all channels |
| Total Exposure Score Prev | totalExposureScorePrev | Total exposure score in the previous period |
| Total Traffic Keyword Count | totalTrafficKeywordCount | Total keywords across all channels |
| Total Keywords In / Out / Prev | totalTrafficKeywordCountIn / Out / Prev | New / exited / previous-period counterparts |
| Natural Search Exposure Score | naturalSearchExposureScore | Exposure score from organic search |
| Natural Search Exposure Ratio | naturalSearchExposureRatio | Organic search share of total exposure |
| Natural Search Exposure Score Prev | naturalSearchExposureScorePrev | Previous-period organic exposure score |
| Natural Search Keyword Count | naturalSearchKeywordCount | Keywords found in organic search results |
| Natural Keywords In / Out / Prev | naturalSearchKeywordCountIn / Out / Prev | New / exited / previous-period counterparts |
| SP Ad Exposure Score | sponsoredProductsExposureScore | Exposure score from Sponsored Products ads |
| SP Ad Exposure Ratio | sponsoredProductsExposureRatio | SP ad share of total exposure |
| SP Ad Exposure Score Prev | sponsoredProductsExposureScorePrev | Previous-period SP exposure score |
| SP Ad Keyword Count | sponsoredProductsKeywordCount | Keywords with SP ad placements |
| Brand Ad Exposure Score | brandAdExposureScore | Exposure score from brand ads |
| Brand Ad Exposure Ratio | brandAdExposureRatio | Brand ad share of total exposure |
| Brand Ad Exposure Score Prev | brandAdExposureScorePrev | Previous-period brand ad exposure score |
| Brand Ad Keyword Count | brandAdKeywordCount | Total brand ad keywords |
| Top Brand Ad Keyword Count | topBrandAdKeywordCount | Keywords in top-of-page brand ads |
| Bottom Brand Ad Keyword Count | bottomBrandAdKeywordCount | Keywords in bottom-of-page brand ads |
| Video Ad Exposure Score | videoAdExposureScore | Exposure score from video ads |
| Video Ad Exposure Ratio | videoAdExposureRatio | Video ad share of total exposure |
| Video Ad Exposure Score Prev | videoAdExposureScorePrev | Previous-period video ad exposure score |
| Video Ad Keyword Count | videoAdKeywordCount | Keywords with video ad placements |
| Amazon's Choice Exposure Score | amazonsChoiceExposureScore | Exposure score from AC badge |
| Amazon's Choice Exposure Ratio | amazonsChoiceExposureRatio | AC share of total exposure |
| Amazon's Choice Exposure Score Prev | amazonsChoiceExposureScorePrev | Previous-period AC exposure score |
| Amazon's Choice Keyword Count | amazonsChoiceKeywordCount | Keywords with AC badge |
| AC Keywords In / Out | amazonsChoiceKeywordCountIn / Out | New / exited AC keywords this period |
| Editorial Recommendations Exposure Score | editorialRecommendationsExposureScore | Exposure from editorial recommendations |
| Editorial Recommendations Exposure Ratio | editorialRecommendationsExposureRatio | ER share of total exposure |
| Editorial Recommendations Keyword Count | editorialRecommendationsKeywordCount | Keywords with ER placements |
| Top Rated Exposure Score | topRatedExposureScore | Exposure from Top Rated recommendations |
| Top Rated Exposure Ratio | topRatedExposureRatio | TR share of total exposure |
| Top Rated Keyword Count | topRatedKeywordCount | Keywords with TR placements |
| Frequently Bought Keyword Count | frequentlyBoughtKeywordCount | Keywords in frequently-bought recommendations |
| Recommend Position Exposure Score | recommendPositionExposureScore | Total recommendation-position exposure score |
| Recommend Ad Exposure Score | recommendAdExposureScore | Ad portion of recommendation-position exposure |
| Recommend Non-ad Exposure Score | recommendNonadExposureScore | Non-ad portion of recommendation-position exposure |
| Non-AC Recommend Exposure Score | nonAcRecommendExposureScore | Recommendation-position exposure excluding AC slots |
| Recommend Keyword Count | recommendKeywordCount | Total recommendation-position keywords |
| Recommend Ad Keyword Count | recommendAdKeywordCount | Ad portion of recommendation keywords |
| Recommend Non-ad Keyword Count | recommendNonadKeywordCount | Non-ad portion of recommendation keywords |
| PPC Traffic Sources | ppcTrafficSources | List of paid ad types (SP, Top Brand Ad, Bottom Brand Ad, Video Ad) |
| Natural Search Traffic Sources | naturalSearchTrafficSources | Organic search type markers |
| Amazon Recommendation Sources | amazonRecommendationSources | Recommendation types (Best Seller, AC, ER, TR, TRFOB, etc.) |
| Promotional Deal Sources | promotionalDealSources | Active promotions (Coupon, Limited Time Deal, Lowest Price in 30 Days, etc.) |
Supported Marketplaces
13 marketplaces: US (United States), UK (United Kingdom), DE (Germany), CA (Canada), JP (Japan), FR (France), ES (Spain), IT (Italy), MX (Mexico), AU (Australia), AE (United Arab Emirates), BR (Brazil), SA (Saudi Arabia).
Default marketplace is US. Use US when the user does not specify a marketplace. Codes outside this list will be rejected by the API pattern.
API Usage
This tool calls the LinkFox tool gateway API. See references/api.md for calling conventions, request parameters, and response structure. You can also execute scripts/sif_asin_summary.py directly to run queries.
Parameter Guide
searchValue (required)
One or more ASIN codes separated by commas. Maximum 10 ASINs per request.
- Single ASIN:
B0XXXXXXXX - Multiple ASINs:
B0XXXXXXXX,B0YYYYYYYY,B0ZZZZZZZZ
country (optional)
Marketplace code. Defaults to US. See the Supported Marketplaces section for all valid codes.
Time window (optional)
last7d(boolean, defaulttrue): Use the latest 7 days. Whenfalse, the API usesstartDate/endDateto define the window.startDate(string,yyyy-MM-dd): Start date for a custom window. Takes effect whenlast7d=false; if omitted, the system's latest ABA week is used.endDate(string,yyyy-MM-dd): End date paired withstartDate.
conditions (optional)
Comma-separated traffic-channel filters. Only returns ASIN-summary rows that have traffic from at least one of the listed channels. Valid values:
nf— natural searchsp— SP adssb— SB regularsbv— video ads (SBV)ad— any ad trafficacAd— SP recommendationtotalPeriod.in— newly-entered traffic keywords this period
sortBy (optional)
Sort field. Leave empty for system default. Valid values:
totalKeywordNum (total keyword count), naturalKeywordNum (natural keyword count), brandKeywordNum (brand ad keyword count), vedioKeywordNum (video ad keyword count), acKeywordNum (AC keyword count), erKeywordNum (ER keyword count), trKeywordNum (TR keyword count), sumScore (all-keyword total exposure), totalNfScore (all natural exposure), totalSpSocre (all SP exposure; note the spelling), totalBrandScore (all brand ad exposure), totalVedioScore (all video ad exposure), totalAcScore (all AC exposure), totalTrScore (all TR exposure), totalErScore (all ER exposure).
Pagination
pageNum: Page number, defaults to 1pageSize: Results per page, minimum 10, maximum 10000, defaults to 10000
Sorting
desc: Sort in descending order whentrue(default), ascending whenfalse
Usage Examples
1. Single ASIN traffic breakdown
"Show me the traffic sources for B09V3KXJPB on the US marketplace"
Query with searchValue = "B09V3KXJPB", country = "US".
2. Multi-ASIN competitor comparison
"Compare traffic structures of B09V3KXJPB and B0BN1K7WJP on Amazon US"
Query with searchValue = "B09V3KXJPB,B0BN1K7WJP", country = "US".
3. Specific marketplace query
"Analyze traffic sources for B07XJ8C8F5 on Amazon Japan"
Query with searchValue = "B07XJ8C8F5", country = "JP".
4. Organic vs paid traffic analysis
"What percentage of B09V3KXJPB's exposure comes from organic search vs ads?"
Query the ASIN, then compare naturalSearchExposureRatio against sponsoredProductsExposureRatio, brandAdExposureRatio, and videoAdExposureRatio.
5. Ad channel deep-dive
"How many keywords does B0BN1K7WJP advertise on through SP, brand ads, and video ads?"
Query the ASIN and present sponsoredProductsKeywordCount, brandAdKeywordCount, topBrandAdKeywordCount, bottomBrandAdKeywordCount, and videoAdKeywordCount.
6. Period-over-period comparison
"How did this ASIN's total keywords change compared to last week?"
Query the ASIN and present totalTrafficKeywordCount (current), totalTrafficKeywordCountPrev (previous), totalTrafficKeywordCountIn (new this period), totalTrafficKeywordCountOut (exited this period). Do the same for the natural-search variant with the naturalSearchKeywordCount* family.
7. Custom date range
"Traffic structure for B0XXX between 2026-03-08 and 2026-03-14"
searchValue: "B0XXX", country: "US", last7d: false, startDate: "2026-03-08", endDate: "2026-03-14"8. Filter by traffic channel and sort by SP exposure
"Top SP-running ASINs among my 10 products, sorted by SP exposure"
searchValue: "B0A,B0B,...,B0J", conditions: "sp", sortBy: "totalSpSocre", desc: trueDisplay Rules
1. Present data clearly: Show query results in well-structured tables; separate product metadata, current-period scores, keyword counts, and period-over-period comparison columns into logical groups for readability 2. Percentage formatting: When displaying exposure ratios, format them as percentages (e.g., 0.45 as 45.0%) for easier comprehension 3. Traffic structure summary: When a user queries a single ASIN, proactively summarize the traffic structure (e.g., "65% organic, 25% SP ads, 10% brand ads") to give an at-a-glance overview 4. Period annotation: Whenever showing *In / *Out / *Prev fields, label the period explicitly (e.g., "vs. previous 7 days"; or the resolved startDate ~ endDate range). Do not present period-over-period deltas without naming the comparison window. 5. Competitor comparison layout: When multiple ASINs are queried, use a side-by-side comparison table so differences are immediately visible 6. Error handling: When a query fails, explain the reason based on the msg field and suggest checking the ASIN validity or marketplace selection 7. Variant awareness: If isVariantProduct is true, note that the ASIN is a variant and the user may want to also check the parent ASIN for a complete picture.
Important Limitations
- ASIN cap per request: Maximum 10 ASINs can be queried in a single call
- Page size cap: Maximum 10000 results per page
- Marketplace coverage: 13 marketplaces only — IN / NL / SE / PL / TR / SG are no longer available
- Snapshot vs window: Default window is the latest 7 days (
last7d=true). To query a different window, setlast7d=falseand passstartDate/endDate - Exposure scores are relative: Scores are useful for cross-channel and cross-ASIN comparison, but are not absolute traffic volumes
User Expression & Scenario Quick Reference
Applicable -- Traffic source and exposure analysis for Amazon ASINs:
| User Says | Scenario |
|---|---|
| "Where does this ASIN's traffic come from" | Traffic source breakdown |
| "How much organic traffic does this product have" | Natural search exposure analysis |
| "Is this competitor running a lot of ads" | SP/brand/video ad exposure check |
| "Compare traffic structures of these ASINs" | Multi-ASIN competitor comparison |
| "Does this product have Amazon's Choice" | AC/ER/TR recommendation check |
| "What ad channels is this ASIN using" | PPC traffic source identification |
| "How many keywords does this ASIN rank for" | Traffic keyword count analysis |
| "Is this product relying on paid or organic traffic" | Organic vs paid traffic split |
| "How did keywords change vs last week" | Period-over-period comparison (In/Out/Prev) |
| "How many new organic keywords did this ASIN get" | New-in keyword count (naturalSearchKeywordCountIn) |
| "Pull the numbers for a specific date range" | Custom time window via startDate/endDate |
| "Rank 10 ASINs by SP exposure" | sortBy=totalSpSocre across a batch |
Not applicable -- Needs beyond ASIN traffic source data:
- Arbitrary multi-week historical trend curves (this tool exposes current + previous period only; use ABA data for long trends)
- Keyword-level search volume or ranking data for the ASIN (use ABA data or the ASIN-keywords tool instead)
- Sales estimation or revenue analysis
- Listing optimization or copywriting
- Advertising bid or budget recommendations
Feedback:
Auto-detect and report feedback via the Feedback API when any of the following apply: 1. The functionality or purpose described in this skill does not match actual behavior 2. The skill's results do not match the user's intent 3. The user expresses dissatisfaction or praise about this skill 4. Anything you believe could be improved
Call the feedback API as specified in references/api.md. Do not interrupt the user's flow.
<!-- LF_LARGE_RESPONSE_BLOCK -->
Handling Large Responses
To avoid overflowing the agent context, persist the response to disk and extract only the fields you need:
python scripts/response_io.py run --script scripts/sif_asin_summary.py --out-dir <DIR> '<params>'
python scripts/response_io.py read <file> --fields "<paths>" # or --path "<JMESPath>"Pick--out-diroutside any git working tree (e.g./tmp/...on Unix,%TEMP%/...on Windows). Persisted responses may contain PII, pricing, or auth-sensitive data — do not commit them. Files are not auto-deleted; clean up when the task is done.
run writes the full response to a file and emits only a schema preview + file path. read projects specific fields, with --limit/--offset for slicing and --format json|jsonl|csv|table for output.
When to prefer this pattern — apply your judgment based on the response characteristics, e.g.:
- High field count per record, or fields you don't need
- Batch/paginated results (multiple items per call)
- Long-text fields (descriptions, reviews, HTML, time series)
- Output reused across later steps rather than consumed immediately
For small, single-use responses, calling the main script directly is fine.
⚠️ The preview is a truncated schema + sample, not the full data. Any field-level decision must read from the persisted file via read. <!-- /LF_LARGE_RESPONSE_BLOCK -->
--- For more high-quality, professional cross-border e-commerce skills, set [LinkFox Skills](https://skill.linkfox.com/).
SIF-ASIN流量来源 API 参考
调用规范
- 请求地址:
https://tool-gateway.linkfox.com/sif/asinSummary - 请求方式:POST,Content-Type: application/json
- 认证方式:Header
Authorization: <api_key>,api_key 从环境变量LINKFOXAGENT_API_KEY读取(如未配置,提示用户前往 https://skill.linkfox.com/linkfoxskills/guide.htm 申请)
请求参数
POST Body(JSON):
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| searchValue | string | 是 | 搜索值,ASIN码,多个用逗号分隔,最多10个ASIN,最大长度1000字符 |
| country | string | 否 | 国家站点,默认 US。可选值(共 13 个):US、UK、DE、CA、JP、FR、ES、IT、MX、AU、AE、BR、SA |
| last7d | boolean | 否 | 是否取最近 7 天数据,默认 true。传 false 时使用 startDate/endDate 区间 |
| startDate | string | 否 | 开始日期 yyyy-MM-dd(last7d=false 时生效;不填取系统最新周) |
| endDate | string | 否 | 结束日期 yyyy-MM-dd(与 startDate 配套) |
| conditions | string | 否 | 条件筛选,多个以英文逗号隔开。可选值:nf(自然流量)、sp(SP广告)、sb(SB常规)、sbv(视频广告)、ad(广告流量)、acAd(SP推荐)、totalPeriod.in(新进全部流量词) |
| sortBy | string | 否 | 排序字段,可选值:totalKeywordNum(全部流量词)、naturalKeywordNum(自然流量词)、brandKeywordNum(品牌广告词)、vedioKeywordNum(视频广告词)、acKeywordNum(AC推荐词)、erKeywordNum(ER推荐词)、trKeywordNum(TR推荐词)、sumScore(所有关键词曝光总得分)、totalNfScore(所有自然排名曝光总得分)、totalSpSocre(所有SP广告曝光总得分,注意拼写)、totalBrandScore(所有品牌广告曝光总得分)、totalVedioScore(所有视频广告曝光总得分)、totalAcScore(所有AC推荐曝光总得分)、totalTrScore(所有TR推荐曝光总得分)、totalErScore(所有ER推荐曝光总得分) |
| pageNum | integer | 否 | 页码,默认 1 |
| pageSize | integer | 否 | 每页数量,最小10,最大 10000,默认 10000 |
| desc | boolean | 否 | 是否降序,默认 true |
响应结构
| 字段 | 类型 | 说明 |
|---|---|---|
| code | string | 返回码 |
| msg | string | 消息 |
| total | integer | 本次实际返回的数据数量 |
| data | array | 返回数据,ASIN汇总对象数组(详见下方) |
| columns | array | 渲染的列 |
| type | string | 渲染的样式 |
| title | string | 标题 |
| isParentAsin | boolean | 搜索的是否是父ASIN |
| variantsNum | integer | 有关键词的变体商品数量 |
| noKeywordVariantsNum | integer | 无关键词的变体商品数量 |
| costTime | integer | 耗时(ms) |
| costToken | integer | 消耗token |
data 数组元素字段
字段后缀约定:*Prev为上一周期数值;*In/*Out为本周期相对上期新进 / 退出数量,用于跨周对比。
| 字段 | 类型 | 说明 |
|---|---|---|
| asin | string | ASIN 编码。亚马逊商品标准识别码 |
| productTitle | string | 商品标题 |
| productCategory | string | 商品类目 |
| productPrice | number | 商品售价 |
| productImageUrl | string | 商品主图 URL |
| productFeatures | array | 商品特征列表 |
| customerRatingCount | integer | 客户评分总数 |
| productStarRating | number | 商品星级(0–5 星) |
| productRatingScore | number | 商品评分数值(0–5,亚马逊页面显示数值) |
| isVariantProduct | boolean | 是否为变体 |
| recentMonthlySalesBucket | string | 近一月销量桶(仅 keywordSummary 路径有值,形如 "300+" 或 "1,000+") |
| isMonitored | boolean | 是否已监控 |
| monitoringStartTime | string | 商品关注时间 |
| dataPeriodStartDate | string | 数据周期起始日期(yyyy-MM-dd) |
| totalExposureScore | number | 总曝光分数。该商品在所有关键词下的曝光量综合评分 |
| totalExposureScorePrev | number | 上周期总曝光分数 |
| totalTrafficKeywordCount | integer | 流量关键词总数 |
| totalTrafficKeywordCountIn | integer | 本周期新进流量关键词数量 |
| totalTrafficKeywordCountOut | integer | 本周期退出流量关键词数量 |
| totalTrafficKeywordCountPrev | integer | 上周期流量关键词总数 |
| naturalSearchExposureScore | number | 自然搜索曝光总分 |
| naturalSearchExposureRatio | number | 自然搜索曝光占比 |
| naturalSearchExposureScorePrev | number | 上周期自然搜索曝光分数 |
| naturalSearchKeywordCount | integer | 自然搜索关键词数量 |
| naturalSearchKeywordCountIn | integer | 本周期新进自然搜索关键词数量 |
| naturalSearchKeywordCountOut | integer | 本周期退出自然搜索关键词数量 |
| naturalSearchKeywordCountPrev | integer | 上周期自然搜索关键词数量 |
| sponsoredProductsExposureScore | number | SP 广告曝光总分 |
| sponsoredProductsExposureRatio | number | SP 广告曝光占比 |
| sponsoredProductsExposureScorePrev | number | 上周期 SP 广告曝光分数 |
| sponsoredProductsKeywordCount | integer | SP 广告关键词数量 |
| brandAdExposureScore | number | 品牌广告曝光总分 |
| brandAdExposureRatio | number | 品牌广告曝光占比 |
| brandAdExposureScorePrev | number | 上周期品牌广告曝光分数 |
| brandAdKeywordCount | integer | 品牌广告关键词总数 |
| topBrandAdKeywordCount | integer | 页面顶部品牌广告关键词数量 |
| bottomBrandAdKeywordCount | integer | 页面底部品牌广告关键词数量 |
| videoAdExposureScore | number | 视频广告曝光总分 |
| videoAdExposureRatio | number | 视频广告曝光占比 |
| videoAdExposureScorePrev | number | 上周期视频广告曝光分数 |
| videoAdKeywordCount | integer | 视频广告关键词数量 |
| amazonsChoiceExposureScore | number | Amazon's Choice 曝光总分 |
| amazonsChoiceExposureRatio | number | Amazon's Choice 曝光占比 |
| amazonsChoiceExposureScorePrev | number | 上周期 AC 曝光分数 |
| amazonsChoiceKeywordCount | integer | Amazon's Choice 关键词数量 |
| amazonsChoiceKeywordCountIn | integer | 本周期新进 AC 关键词数量 |
| amazonsChoiceKeywordCountOut | integer | 本周期退出 AC 关键词数量 |
| editorialRecommendationsExposureScore | number | Editorial Recommendations 曝光总分 |
| editorialRecommendationsExposureRatio | number | Editorial Recommendations 曝光占比 |
| editorialRecommendationsKeywordCount | integer | Editorial Recommendations 关键词数量 |
| topRatedExposureScore | number | Top Rated 推荐曝光总分 |
| topRatedExposureRatio | number | Top Rated 推荐曝光占比 |
| topRatedKeywordCount | integer | Top Rated 推荐关键词数量 |
| frequentlyBoughtKeywordCount | integer | 高频购买推荐关键词数量(Top Rated Frequently Bought) |
| recommendPositionExposureScore | number | 推荐位曝光总分 |
| recommendAdExposureScore | number | 推荐位广告曝光分数 |
| recommendNonadExposureScore | number | 推荐位非广告曝光分数 |
| nonAcRecommendExposureScore | number | 非 AC 推荐位曝光分数 |
| recommendKeywordCount | integer | 推荐位关键词总数 |
| recommendAdKeywordCount | integer | 推荐位广告关键词数量 |
| recommendNonadKeywordCount | integer | 推荐位非广告关键词数量 |
| ppcTrafficSources | array | PPC 付费广告流量来源标记。包含:SP 广告、头部品牌广告、底部品牌广告、视频广告 |
| naturalSearchTrafficSources | array | 自然搜索流量来源标记 |
| amazonRecommendationSources | array | 亚马逊推荐流量来源标记。包含:Best Seller、AC、ER、TR、TRFOB 等 |
| promotionalDealSources | array | 促销活动流量来源标记。包含:Coupon、Limited Time Deal、Lowest Price in 30 Days 等 |
错误码
正常情况下,接口的 HTTP 状态码均为 200,业务的成功与否通过响应体中的 errorCode 字段区分(errorCode = 200 表示成功,其他值表示业务错误)。当遇到未授权等情况时,HTTP 状态码为 401,且对应的 errorCode 也是 401。
| errcode | 含义 | 处理建议 |
|---|---|---|
| 200 | 成功 | 正常解析业务字段 |
| 401 | 认证失败 | 检查请求头 Authorization 是否正确携带 API Key;API Key 申请方式请参考上述调用规范下的认证方式。 |
| 其他非200值 | 业务异常 | 参考 errmsg 字段获取具体错误原因 |
错误响应示例:
{
"errcode": 401,
"errmsg": "authorized error"
}curl 示例
curl -X POST https://tool-gateway.linkfox.com/sif/asinSummary \
-H "Authorization: $LINKFOXAGENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"searchValue": "B09V3KXJPB", "country": "US"}'多ASIN查询
curl -X POST https://tool-gateway.linkfox.com/sif/asinSummary \
-H "Authorization: $LINKFOXAGENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"searchValue": "B09V3KXJPB,B0BN1K7WJP", "country": "US", "pageSize": 10000, "pageNum": 1, "desc": true}'指定日期区间 + 仅查广告流量
curl -X POST https://tool-gateway.linkfox.com/sif/asinSummary \
-H "Authorization: $LINKFOXAGENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"searchValue": "B09V3KXJPB", "country": "US", "last7d": false, "startDate": "2026-03-08", "endDate": "2026-03-14", "conditions": "ad", "sortBy": "totalSpSocre"}'---
Feedback API
This endpoint is separate from the tool API above. Do not mix the two base URLs.
- POST
https://skill-api.linkfox.com/api/v1/public/feedback - Content-Type:
application/json
{
"skillName": "linkfox-xxx-xxx",
"sentiment": "POSITIVE",
"category": "OTHER",
"content": "Results were accurate, user was satisfied."
}Field rules:
skillName: Use this skill'snamefrom the YAML frontmattersentiment: Choose ONE —POSITIVE(praise),NEUTRAL(suggestion without emotion),NEGATIVE(complaint or error)category: Choose ONE —BUG(malfunction or wrong data),COMPLAINT(user dissatisfaction),SUGGESTION(improvement idea),OTHERcontent: Include what the user said or intended, what actually happened, and why it is a problem or praise
#!/usr/bin/env python3
"""
Skill response I/O helper — wraps any main script to persist large API
responses to disk, then offers a `read` subcommand to extract specific fields
from those persisted files. Generic, business-agnostic.
This script is bundled into each skill's scripts/ directory by tools/response_io/sync.py.
The agent must pass --script <path> to identify which main script to execute.
Usage:
python scripts/response_io.py run --script <PATH> --out-dir <DIR> '<json_params>' [--label NAME] [--timeout SEC]
python scripts/response_io.py read <file> (--path "<JMESPath>" | --fields "f1,f2,...") [--limit N] [--offset M] [--format json|jsonl|csv|table]
"""
from __future__ import annotations
import sys
if sys.version_info < (3, 10):
sys.exit(
"Error: Python 3.10+ required (current: "
f"{sys.version_info.major}.{sys.version_info.minor}). "
"Please upgrade Python."
)
import argparse
import csv
import io
import json
import os
import re
import secrets
import subprocess
from datetime import datetime
from pathlib import Path
from typing import Any
# Force UTF-8 stdout/stderr so non-ASCII chars in previews and API responses
# print correctly on Windows (default cp936 / gbk).
for stream in (sys.stdout, sys.stderr):
try:
stream.reconfigure(encoding="utf-8") # type: ignore[attr-defined]
except (AttributeError, OSError):
pass
try:
import jmespath # type: ignore
HAS_JMESPATH = True
except ImportError:
HAS_JMESPATH = False
MAX_STRING_LEN = 120
MAX_DEPTH = 3
SAMPLE_KEY_CAP = 15
RAW_TEXT_PEEK = 500
DEFAULT_TIMEOUT_SEC = 300
# ---------------------------------------------------------------------------
# Shared helpers
# ---------------------------------------------------------------------------
def _err(msg: str, code: int = 1) -> None:
print(msg, file=sys.stderr)
sys.exit(code)
def _resolve_script(script_arg: str) -> Path:
p = Path(script_arg).expanduser()
if not p.is_absolute():
# Resolve relative to the current working directory the agent invoked from.
p = (Path.cwd() / p).resolve()
else:
p = p.resolve()
if not p.is_file():
_err(f"--script path not found: {p}")
return p
def _resolve_skill_name(main_script: Path) -> str:
"""Best-effort skill name extraction for filename prefixing.
main_script lives at <skill_dir>/scripts/<name>.py — return <skill_dir>'s
folder name. Fall back to the script's stem if structure differs.
"""
try:
if main_script.parent.name == "scripts":
return main_script.parents[1].name
except IndexError:
pass
return main_script.stem
def _sanitize_label(label: str) -> str:
"""Allow only safe filename chars in --label to prevent path traversal."""
cleaned = re.sub(r"[^\w\-]", "_", label)
return cleaned[:64] # cap length
def _truncate_string(s: str) -> str:
if len(s) <= MAX_STRING_LEN:
return s
return s[:MAX_STRING_LEN] + f"...(truncated, total {len(s)} chars)"
def _truncate_value(value: Any, depth: int = 0) -> Any:
"""Recursively truncate strings, deep nesting, and large arrays for preview."""
if depth >= MAX_DEPTH:
if isinstance(value, dict):
return f"<truncated nested object, keys: {list(value.keys())[:10]}>"
if isinstance(value, list):
return f"<truncated nested array, length: {len(value)}>"
if isinstance(value, str):
return _truncate_string(value)
return value
if isinstance(value, str):
return _truncate_string(value)
if isinstance(value, dict):
out = {k: _truncate_value(v, depth + 1) for k, v in value.items()}
return out
if isinstance(value, list):
if not value:
return []
truncated = [_truncate_value(value[0], depth + 1)]
if len(value) > 1:
# Note total length on the parent — keep the array type-homogeneous
# so downstream consumers can iterate without special-casing strings.
truncated.append({"_omitted_items": len(value) - 1})
return truncated
return value
def _shape_of(value: Any, top: bool = False) -> Any:
"""Lightweight schema description for the preview block."""
if isinstance(value, dict):
keys = list(value.keys())
out: dict[str, Any] = {"type": "object", "top_keys" if top else "keys": keys}
if top:
for k in keys[:8]:
out[k] = _shape_of(value[k])
return out
if isinstance(value, list):
out = {"type": "array", "length": len(value)}
if value and isinstance(value[0], dict):
out["item_keys"] = list(value[0].keys())
elif value:
out["item_type"] = type(value[0]).__name__
return out
return {"type": type(value).__name__}
def _build_sample(value: Any) -> Any:
"""First-record sample with explicit truncation marker."""
if isinstance(value, list):
if not value:
return {"_truncated_record": True, "_note": "array is empty"}
first = value[0]
if isinstance(first, dict):
sample = {"_truncated_record": True, "_note": f"first of {len(value)} items"}
sample.update(_truncate_value(first, depth=1))
return sample
return {"_truncated_record": True, "_note": f"first of {len(value)} items", "value": _truncate_value(first, depth=1)}
if isinstance(value, dict):
sample = {"_truncated_record": True, "_note": "top-level object (truncated)"}
sample.update(_truncate_value(value, depth=1))
return sample
return {"_truncated_record": True, "value": _truncate_value(value, depth=1)}
def _shrink_preview(preview: dict) -> dict:
"""Cap the sample's value fields when it has many keys.
`shape.*.item_keys` is the single source of truth for the full key list
(always complete, no truncation). The sample only ever shows up to
SAMPLE_KEY_CAP fields with their concrete values, since the agent only
needs a feel for value shapes — for the full menu of available fields,
they read `shape`.
"""
sample = preview.get("sample")
if isinstance(sample, dict):
meta_keys = {"_truncated_record", "_note"}
data_keys = [k for k in sample.keys() if k not in meta_keys]
if len(data_keys) > SAMPLE_KEY_CAP:
kept = data_keys[:SAMPLE_KEY_CAP]
new_sample = {k: v for k, v in sample.items() if k in meta_keys or k in kept}
base_note = sample.get("_note", "")
extra = (
f"showing first {SAMPLE_KEY_CAP} of {len(data_keys)} fields "
f"(see `shape` for the complete key list)"
)
new_sample["_note"] = f"{base_note}; {extra}" if base_note else extra
preview["sample"] = new_sample
return preview
# ---------------------------------------------------------------------------
# `run` subcommand
# ---------------------------------------------------------------------------
def cmd_run(args: argparse.Namespace) -> int:
main_script = _resolve_script(args.script)
skill_name = _resolve_skill_name(main_script)
out_dir = Path(args.out_dir).expanduser().resolve()
try:
out_dir.mkdir(parents=True, exist_ok=True)
except OSError as e:
_err(f"Failed to create --out-dir {out_dir}: {e}")
if not os.access(out_dir, os.W_OK):
_err(f"--out-dir is not writable: {out_dir}")
timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
rand = secrets.token_hex(3)
safe_label = _sanitize_label(args.label) if args.label else ""
label_part = f"__{safe_label}" if safe_label else ""
out_file = out_dir / f"{skill_name}__{timestamp}_{rand}{label_part}.json"
# Force the child process to emit UTF-8 regardless of the host console
# encoding (Windows defaults to cp936 / gbk and would otherwise corrupt
# non-ASCII bytes when we read them back).
child_env = os.environ.copy()
child_env["PYTHONIOENCODING"] = "utf-8"
timed_out = False
try:
proc = subprocess.run(
[sys.executable, str(main_script), args.params],
capture_output=True,
text=True,
encoding="utf-8",
errors="replace",
env=child_env,
timeout=args.timeout,
)
stdout_text = proc.stdout or ""
stderr_text = proc.stderr or ""
returncode = proc.returncode
except subprocess.TimeoutExpired as e:
timed_out = True
stdout_text = (e.stdout.decode("utf-8", errors="replace") if isinstance(e.stdout, bytes) else (e.stdout or "")) or ""
stderr_text = (e.stderr.decode("utf-8", errors="replace") if isinstance(e.stderr, bytes) else (e.stderr or "")) or ""
returncode = 124 # convention for timeout
# Always write the captured stdout to disk, even if not JSON.
try:
out_file.write_text(stdout_text, encoding="utf-8")
except OSError as e:
_err(f"Failed to write output file {out_file}: {e}")
if stderr_text:
sys.stderr.write(stderr_text)
# Try to parse the captured stdout as JSON for the preview.
try:
parsed = json.loads(stdout_text) if stdout_text.strip() else None
format_kind = "json"
except json.JSONDecodeError:
parsed = None
format_kind = "raw_text"
preview: dict[str, Any] = {
"_preview": {
"is_preview": True,
"warning": (
"PREVIEW ONLY — NOT FULL DATA. The full response is saved to `file`. "
"Use `python scripts/response_io.py read <file> --fields '...'` to extract "
"specific fields, or `--path '<JMESPath>'` for complex projections."
),
},
}
# Surface failures prominently so agents don't mistake a stub preview for success.
if returncode != 0 or timed_out:
stderr_snippet = stderr_text[-500:] if stderr_text else ""
preview["_error"] = {
"exit_code": returncode,
"timed_out": timed_out,
"stderr_snippet": stderr_snippet,
"hint": "The wrapped script failed or timed out. The output file may be empty or partial.",
}
preview.update({
"file": str(out_file),
"size_bytes": out_file.stat().st_size,
"skill": skill_name,
"exit_code": returncode,
"format": format_kind,
"label": safe_label or None,
"next_steps_hint": (
"use: python scripts/response_io.py read <file> --fields '...' | --path '...'"
),
})
if format_kind == "json":
preview["shape"] = _shape_of(parsed, top=True)
preview["sample"] = _build_sample(parsed)
else:
peek = stdout_text[:RAW_TEXT_PEEK]
preview["raw_text_peek"] = peek
preview["raw_text_total_chars"] = len(stdout_text)
preview["sample"] = {
"_truncated_record": True,
"_note": f"stdout was not valid JSON; first {RAW_TEXT_PEEK} chars shown above in raw_text_peek",
}
preview = _shrink_preview(preview)
print(json.dumps(preview, ensure_ascii=False, indent=2))
return returncode
# ---------------------------------------------------------------------------
# `read` subcommand
# ---------------------------------------------------------------------------
def _load_json(path: Path) -> Any:
try:
text = path.read_text(encoding="utf-8")
except OSError as e:
_err(f"Failed to read file {path}: {e}")
try:
return json.loads(text)
except json.JSONDecodeError as e:
_err(f"File is not valid JSON: {path}\n{e}")
def _basic_dot_path(data: Any, path: str) -> Any:
"""Pure-stdlib dot-path resolver. No [*] support — callers fall back here only when jmespath is unavailable AND the path has no [*]."""
cur = data
for part in path.split("."):
if isinstance(cur, dict):
cur = cur.get(part)
else:
return None
return cur
def _resolve_field(data: Any, expr: str) -> Any:
if HAS_JMESPATH:
return jmespath.search(expr, data)
if "[" in expr or "*" in expr:
_err(
f"jmespath is required for expression '{expr}'. "
f"Install with: pip install jmespath"
)
return _basic_dot_path(data, expr)
def _project_fields(data: Any, fields: list[str]) -> Any:
"""Run each field expr; if any returns a list, zip them into list-of-dicts."""
resolved: dict[str, Any] = {f: _resolve_field(data, f) for f in fields}
list_lengths = [len(v) for v in resolved.values() if isinstance(v, list)]
if not list_lengths:
return resolved
# All list values must be same length to zip cleanly.
if len(set(list_lengths)) > 1:
# Fallback: return the dict as-is so caller can inspect mismatches.
return resolved
n = list_lengths[0]
rows = []
for i in range(n):
row = {}
for f, v in resolved.items():
row[f] = v[i] if isinstance(v, list) else v
rows.append(row)
return rows
def _apply_slice(value: Any, limit: int | None, offset: int | None) -> Any:
if not isinstance(value, list):
return value
start = offset or 0
end = (start + limit) if limit is not None else None
return value[start:end]
def _format_output(value: Any, fmt: str) -> str:
if fmt == "json":
return json.dumps(value, ensure_ascii=False, indent=2)
if fmt == "jsonl":
if isinstance(value, list):
return "\n".join(json.dumps(item, ensure_ascii=False) for item in value)
return json.dumps(value, ensure_ascii=False)
if fmt in ("csv", "table"):
if not isinstance(value, list) or not value:
_err(f"--format {fmt} requires a non-empty list result")
if not all(isinstance(item, dict) for item in value):
_err(f"--format {fmt} requires list-of-objects, got list of {type(value[0]).__name__}")
keys: list[str] = []
for item in value:
for k in item.keys():
if k not in keys:
keys.append(k)
if fmt == "csv":
buf = io.StringIO()
writer = csv.DictWriter(buf, fieldnames=keys, extrasaction="ignore")
writer.writeheader()
for item in value:
writer.writerow({k: _stringify(item.get(k)) for k in keys})
return buf.getvalue().rstrip("\n")
# table: simple aligned columns
rows = [[_stringify(item.get(k)) for k in keys] for item in value]
widths = [len(k) for k in keys]
for row in rows:
for i, cell in enumerate(row):
widths[i] = max(widths[i], len(cell))
lines = [
" ".join(k.ljust(widths[i]) for i, k in enumerate(keys)),
" ".join("-" * widths[i] for i in range(len(keys))),
]
for row in rows:
lines.append(" ".join(row[i].ljust(widths[i]) for i in range(len(keys))))
return "\n".join(lines)
_err(f"Unknown --format: {fmt}")
return "" # unreachable
def _stringify(v: Any) -> str:
if v is None:
return ""
if isinstance(v, (dict, list)):
return json.dumps(v, ensure_ascii=False)
return str(v)
def cmd_read(args: argparse.Namespace) -> int:
if not args.path and not args.fields:
_err("read: either --path or --fields is required")
if args.path and args.fields:
_err("read: --path and --fields are mutually exclusive")
file_path = Path(args.file).expanduser().resolve()
data = _load_json(file_path)
if args.path:
result = _resolve_field(data, args.path)
else:
fields = [f.strip() for f in args.fields.split(",") if f.strip()]
if not fields:
_err("--fields parsed to empty list")
result = _project_fields(data, fields)
result = _apply_slice(result, args.limit, args.offset)
print(_format_output(result, args.format))
return 0
# ---------------------------------------------------------------------------
# CLI
# ---------------------------------------------------------------------------
def main() -> int:
parser = argparse.ArgumentParser(
prog="response_io.py",
description="Persist large skill API responses to disk and read fields on demand.",
)
sub = parser.add_subparsers(dest="cmd", required=True)
p_run = sub.add_parser(
"run",
help="Execute a main script and persist its stdout to a file; "
"print only a lightweight preview to stdout.",
)
p_run.add_argument("params", help="JSON params string passed verbatim to the main script (argv[1]).")
p_run.add_argument("--script", required=True, help="Path to the main script to execute, e.g. scripts/my_api.py")
p_run.add_argument("--out-dir", required=True, help="Directory to write the response file into (created if missing).")
p_run.add_argument("--label", default=None, help="Optional filename suffix; sanitized to safe filename characters.")
p_run.add_argument("--timeout", type=int, default=DEFAULT_TIMEOUT_SEC, help=f"Subprocess timeout in seconds (default: {DEFAULT_TIMEOUT_SEC}).")
p_run.set_defaults(func=cmd_run)
p_read = sub.add_parser(
"read",
help="Extract specific fields from a previously persisted response file.",
)
p_read.add_argument("file", help="Path to the persisted JSON response file.")
g = p_read.add_mutually_exclusive_group()
g.add_argument("--path", default=None, help="JMESPath expression, e.g. 'data[*].{asin: asin, title: title}'.")
g.add_argument("--fields", default=None, help="Comma-separated field paths, e.g. 'data[*].asin,data[*].title'.")
p_read.add_argument("--limit", type=int, default=None, help="Take at most N items (when result is a list).")
p_read.add_argument("--offset", type=int, default=None, help="Skip the first M items (when result is a list).")
p_read.add_argument("--format", choices=["json", "jsonl", "csv", "table"], default="json", help="Output format (default: json).")
p_read.set_defaults(func=cmd_read)
args = parser.parse_args()
return args.func(args)
if __name__ == "__main__":
sys.exit(main())
#!/usr/bin/env python3
"""
SIF ASIN Summary - LinkFox Skill
Calls the sif/asinSummary API endpoint to retrieve ASIN traffic source data.
Usage:
python sif_asin_summary.py '{"searchValue": "B09V3KXJPB", "country": "US"}'
python sif_asin_summary.py '{"searchValue": "B09V3KXJPB,B0BN1K7WJP", "country": "US"}'
"""
import json
import os
import sys
from urllib.request import urlopen, Request
from urllib.error import HTTPError, URLError
API_URL = "https://tool-gateway.linkfox.com/sif/asinSummary"
def get_api_key():
"""Retrieve the API key from environment, with a friendly prompt if missing."""
key = os.environ.get("LINKFOXAGENT_API_KEY")
if not key:
print(
"API Key not configured. Please complete authorization first:\n"
"1. Visit https://skill.linkfox.com/linkfoxskills/guide.htm to obtain your Key\n"
"2. Set the environment variable: export LINKFOXAGENT_API_KEY=your-key-here",
file=sys.stderr,
)
sys.exit(1)
return key
def validate_params(params: dict):
"""Validate required parameters before making the API call."""
if "searchValue" not in params or not params["searchValue"].strip():
print("Error: 'searchValue' is required. Provide one or more ASINs separated by commas.", file=sys.stderr)
sys.exit(1)
# Check ASIN count limit
asins = [a.strip() for a in params["searchValue"].split(",") if a.strip()]
if len(asins) > 10:
print(f"Error: Maximum 10 ASINs per request, but {len(asins)} were provided.", file=sys.stderr)
sys.exit(1)
# Validate country code if provided
valid_countries = {"US", "CA", "MX", "UK", "DE", "FR", "IT", "ES", "JP", "IN", "AU", "BR", "NL", "SE", "PL", "TR", "AE", "SA", "SG"}
country = params.get("country", "US")
if country not in valid_countries:
print(f"Error: Invalid country code '{country}'. Valid codes: {', '.join(sorted(valid_countries))}", file=sys.stderr)
sys.exit(1)
# Validate pageSize if provided
page_size = params.get("pageSize", 100)
if not (10 <= page_size <= 100):
print(f"Error: 'pageSize' must be between 10 and 100, got {page_size}.", file=sys.stderr)
sys.exit(1)
def call_api(params: dict) -> dict:
"""Call the SIF ASIN Summary API endpoint."""
api_key = get_api_key()
data = json.dumps(params).encode("utf-8")
req = Request(
API_URL,
data=data,
headers={
"Authorization": api_key,
"Content-Type": "application/json",
"User-Agent": "LinkFox-Skill/1.0",
},
method="POST",
)
try:
with urlopen(req, timeout=60) as response:
return json.loads(response.read().decode("utf-8"))
except HTTPError as e:
body = e.read().decode("utf-8") if e.fp else ""
return {"error": f"HTTP {e.code}: {e.reason}", "details": body}
except URLError as e:
return {"error": f"Connection failed: {e.reason}"}
def main():
if len(sys.argv) < 2:
print("Usage: sif_asin_summary.py '<JSON parameters>'", file=sys.stderr)
print(
'Example: sif_asin_summary.py \'{"searchValue": "B09V3KXJPB", "country": "US"}\'',
file=sys.stderr,
)
sys.exit(1)
try:
params = json.loads(sys.argv[1])
except json.JSONDecodeError as e:
print(f"Invalid parameter format: {e}", file=sys.stderr)
sys.exit(1)
validate_params(params)
result = call_api(params)
print(json.dumps(result, indent=2, ensure_ascii=False))
if __name__ == "__main__":
main()