ads_get_brand_metrics_report
Poll a Brand Metrics report; when the server sees it finished, the same call also downloads the file, so there is no separate download step.
readAmazon Adsads.brand-metrics
Poll every ~30 s. Amazon Ads API · getBrandMetricsReport · GET /insights/brandMetrics/report/{reportId} Docs: https://advertising.amazon.com/API/docs/en-us/brand-metrics-openapi#tag/Report/operation/getBrandMetricsReport
Call it
In an AI client (MCP)
{
"name": "ads_get_brand_metrics_report",
"arguments": {
"store": "myStore-US",
"countryCode": "<countryCode>",
"reportId": "<reportId>"
}
}From code (Tool API)
curl -X POST https://api.sellersheetai.com/api/v1/tools/ads_get_brand_metrics_report \
-H "Authorization: Bearer $SELLERSHEET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"store":"myStore-US","countryCode":"<countryCode>","reportId":"<reportId>"}'Early access — the Tool API is open on request, contact us.
Arguments
| Name | Type | Description |
|---|---|---|
storerequired | string | the store ref `<store>-<CC>` (name-country, e.g. 'myStore-US') — one of get_user_context's store_refs, verbatim. |
countryCoderequired | string | the Ads profile's 2-letter country code (e.g. 'US'). |
reportIdrequired | string | data.result.reportId from ads_generate_brand_metrics_report. |
Result
Every tool answers {notification, data, human_action}; data carries:
- Amazon's payload in data.result.
data.result.status— IN_PROGRESS, SUCCESSFUL or FAILED (statusDetails says why; a FAILED report answers with a warning).data.result.reportData— the parsed rows once SUCCESSFUL, capped at 20,000 (reportDataTruncated / reportDataTotalRecords when larger).
Gotchas
- The file is parsed server-side when it is JSON (the default format); a CSV file comes back base64 with reportDataParsed false. data.result.location is the file's presigned URL (valid for data.result.expiration ms).