Generate Brand Metrics Report. Each response record will include the following dimensional fields (in addition to the requested metrics) brand Namecategory, TreeNamecategory, HierarchylookbackPeriod, metricsComputationDate

POST

/insights/brandMetrics/report

最后修改时间：2026-08-27 23:21:02

责任人：未设置

以 CSV 或 JSON 格式生成品牌指标报告。通过传递特定的 categoryTreeName、categoryPath、brandName、reportStartDate、reportEndDate、lookbackPeriod、format 或 metrics 字段中的可用指标列表来自定义报告。如果传递空请求正文，将生成最新可用报告日期的 JSON 格式报告，包含广告商的所有可用品牌和指标。报告可能包含也可能不包含一个或多个品牌的品牌指标数据，具体取决于数据可用性。

需要以下权限之一：
["advertiser_campaign_edit","nemo_report_edit"]

请求参数

Header 参数

Body 参数

application/vnd.insightsbrandmetrics.v1+json

示例

{
    "brandName": "Mattress Mogul",
    "categoryPath": [
        [
            "Categories",
            "Granola & Snack Bars",
            "Snack Food"
        ]
    ],
    "categoryTreeName": "us-home",
    "format": "JSON",
    "lookBackPeriod": "1W",
    "metrics": [
        "customerConversionRate",
        "engagedShopperRateLowerBound",
        "newToBrandCustomerRate"
    ],
    "reportEndDate": "2021-01-30",
    "reportStartDate": "2021-01-01"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://www.amazon.com/ap/oa/insights/brandMetrics/report' \
--header 'Amazon-Advertising-API-Scope: 195213312458027' \
--header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.8baa9caa3eac48eab89780e73ce03b19.' \
--header 'Content-Type: application/vnd.insightsbrandmetrics.v1+json' \
--data '{
    "brandName": "Mattress Mogul",
    "categoryPath": [
        [
            "Categories",
            "Granola & Snack Bars",
            "Snack Food"
        ]
    ],
    "categoryTreeName": "us-home",
    "format": "JSON",
    "lookBackPeriod": "1W",
    "metrics": [
        "customerConversionRate",
        "engagedShopperRateLowerBound",
        "newToBrandCustomerRate"
    ],
    "reportEndDate": "2021-01-30",
    "reportStartDate": "2021-01-01"
}'

返回响应

🟢200成功

application/vnd.insightsbrandmetrics.v1+json

操作成功。

Bodyapplication/vnd.insightsbrandmetrics.v1+json

示例

{}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠422参数错误

🟠424

🟠429

🔴500服务器错误

修改于 2026-08-27 23:21:02

Cancel TrainedModel for a given trainedModelId.

Retrieve the status and the URL of the Brand Metrics Report being generated