get_walmart_keyword_performance

Walmart Connect Read

Per-keyword performance from the warehouse (bidded keyword + match type): spend, sales, ROAS, ACoS, CTR, CPC + grade

Endpoint

POST https://api.adspirer.ai/api/v1/tools/get_walmart_keyword_performance/execute

Headers

Description

Per-keyword performance from the warehouse (bidded keyword + match type): spend, sales, ROAS, ACoS, CTR, CPC + grade. The bid/negative decision surface.

Request body

All tool arguments are wrapped in an arguments object.

FieldTypeDescription
advertiser_idstring optionalWalmart Advertiser ID. Optional when only one advertiser is connected.
attribution_windowstring optionalAttribution window (default 14d). NEVER mixes windows in one number. one of: 3d, 14d, 30d
start_datestring optionalYYYY-MM-DD (default: 30 days before end_date).
end_datestring optionalYYYY-MM-DD (default: today).
min_spendnumber optionalOnly rows with ad spend >= this.
min_salesnumber optionalOnly rows with attributed sales >= this.
zero_salesboolean optionalOnly rows with zero attributed sales (waste hunt).
sort_bystring optionalField to sort by (default ad_spend): ad_spend|attributed_sales|roas|acos|num_ads_clicks.
sort_orderstring optionalDefault desc (top by spend). one of: asc, desc
offsetinteger optionalPage offset (snapped to a page boundary; capped — narrow with filters instead of deep paging).
limitinteger optionalRows per page (10-200, default 50).

Example request

{
  "arguments": {
    "attribution_window": "3d",
    "sort_order": "asc"
  }
}

Example responses

200 — Success

{
  "success": true,
  "data": {
    "text": "(tool-specific textual output for get_walmart_keyword_performance)",
    "quota": {
      "used": 42,
      "limit": 150,
      "tier": "plus",
      "period_end": "2026-05-01"
    }
  },
  "tool": "get_walmart_keyword_performance"
}

400 — Tool-level error (bad arguments / multi-account selection)

{
  "success": false,
  "error": "You have 25 meta_ads accounts connected. Please specify which account to use by passing the ad_account_id parameter:\n  - Acme Holdings (ad_account_id=\"act_123456789\")\n  - Acme EU (ad_account_id=\"act_987654321\")",
  "is_error": true,
  "tool": "get_walmart_keyword_performance"
}

402 — Quota exhausted

{
  "success": false,
  "error": "\ud83d\udea8 Monthly limit reached (150/150 tool calls on Plus tier).\nUpgrade to Pro at https://adspirer.ai to keep building.",
  "is_error": true,
  "tool": "get_walmart_keyword_performance",
  "quota": {
    "used": 150,
    "limit": 150,
    "tier": "plus",
    "period_end": "2026-05-01",
    "upgrade_url": "https://adspirer.ai"
  }
}

Try it live


Adspirer REST API — get an API key at adspirer.ai/keys · adspirer.ai