获取 MMM 数据请求历史记录

你可以使用本接口获取媒体组合建模 (MMM) 数据请求历史记录的详细信息。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/mmm/api/history/

方法 GET

Header

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](1738373164380162.html)接口获取。|

参数

|字段{30%}|类型{15%}|描述{55%}|
|--- |--- |--- |
| from_date {必填} | string | 开始日期，格式为 `YYYY-MM-DD`（UTC+0 时间）。<br><br>开始日期不得早于 4 年前。 |
| end_date {必填} | string | 结束日期，格式为 `YYYY-MM-DD`（UTC+0 时间）。 |

示例

(code curl http)
curl --location  --request GET 'https://business-api.tiktok.com/open_api/v1.3/mmm/api/history/?from_date=2024-11-01&end_date=2024-12-03' \
--header 'Access-Token: {{Access-Token}}'
(/code)

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number|返回码。完整返回码列表及描述参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|message|string|返回信息。更多信息参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|request_id |string|请求的日志 ID，唯一标识一个请求。  |
|data |object|返回数据。|
#| historical_requests | string[] | JSON 格式的字符串数组，用于显示历史请求，并提供每个请求的详细信息。<br><br>对于字段 `media_type` 和 `Status`，你可能需要根据以下映射，将返回的整数值转换为字符串值，以便在其他 MMM 接口中使用：<br><br><ul><li>`media_type` 支持的值： <ul><li>`0`：对应 `All`。</li><li> `1`：对应 `Earned`。</li><li>`2`：对应 `Paid`。 </li></ul></li><li>`Status` 支持的值： <ul><li>`1`：对应 `request received`。</li><li> `3`：对应 `in progress`。</li><li>`5`：对应 `completed - ready for download`。</li><li>`2`：对应 `failed`。</li><li>`4`：对应 `failed`。</li></ul></li></ul>|

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "historical_requests": [
            "{\"RequestID\":\"{{RequestID}}\",\"CreateTime\":\"2024-11-07T22:03:39Z\",\"Message\":\"{\\\"targets\\\":[{\\\"advertiser_id\\\":\\\"{{advertiser_id}}\\\"}],\\\"from_date\\\":\\\"20240729\\\",\\\"to_date\\\":\\\"20240829\\\",\\\"media_type\\\":2}\",\"Status\":5}",
            "{\"RequestID\":\"{{RequestID}}\",\"CreateTime\":\"2024-11-19T19:54:58Z\",\"Message\":\"{\\\"targets\\\":[{\\\"advertiser_id\\\":\\\"{{advertiser_id}}\\\"}],\\\"from_date\\\":\\\"20241104\\\",\\\"to_date\\\":\\\"20241108\\\",\\\"country_code\\\":[\\\"JP\\\"],\\\"media_type\\\":2}\",\"Status\":1}"
        ]
    }
}
(/code)