ads_get_insights_for_store_api

Store traffic / sales / dwell / bounce insights for a brand's Store page.

readAmazon Adsads.stores

Amazon Ads API · getInsightsForStoreAPI · POST /stores/{brandEntityId}/insights Docs: https://advertising.amazon.com/API/docs/en-us/stores/open-api#tag/Stores-Analytics/operation/getInsightsForStoreAPI

Call it

In an AI client (MCP)

tools/call
{
  "name": "ads_get_insights_for_store_api",
  "arguments": {
    "store": "myStore-US",
    "countryCode": "<countryCode>",
    "brandEntityId": "<brandEntityId>",
    "body": {}
  }
}

From code (Tool API)

curl -X POST https://api.sellersheetai.com/api/v1/tools/ads_get_insights_for_store_api \
  -H "Authorization: Bearer $SELLERSHEET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"store":"myStore-US","countryCode":"<countryCode>","brandEntityId":"<brandEntityId>","body":{}}'
Early access — the Tool API is open on request, contact us.

Arguments

NameTypeDescription
storerequiredstringthe store ref `<store>-<CC>` (name-country, e.g. 'myStore-US') — one of get_user_context's store_refs, verbatim.
countryCoderequiredstringthe Ads profile's 2-letter country code (e.g. 'US').
brandEntityIdrequiredstringfrom ads_get_brands.
bodyrequiredobject{dimension: DATE|PAGE|SOURCE|TAG|STORE, startDate, endDate, metrics: [...]}; optional filter {pageIds, sources, tags}, maxResult (1-1500), paginationToken, language.

Result

Every tool answers {notification, data, human_action}; data carries:

  • Amazon's payload in data.result.
  • data.result.metricsDetails[] — one map per dimension value (max 1500).
  • data.result.paginationToken — pass back as body.paginationToken with the SAME request body, within 24 h.

Gotchas

  • The metric allowlist depends on dimension: DATE/PAGE/SOURCE/TAG take the traffic metrics (VIEWS, ORDERS, UNITS, SALES, VISITS, DWELL_TIME, BOUNCE_RATE, ...); STORE takes only DWELL_TIME, BOUNCE_RATE, NEW_TO_STORE. Non-SQS metrics: exactly ONE per call; SQS (Store-Quality) metrics may be combined freely.
  • filter accepts pageIds, sources, tags, but sources+tags together are not supported.
  • language is SQS-only (default 'en'), e.g. 'fr-FR', 'de-DE', 'ja-JP', 'zh-CN', 'ar-AE', 'en-GB'.

On this page

Actions

View as Markdown

Ask an assistant

Ask ChatGPTAsk Claude