VI | EN
Message us on Messenger
Developer resources

Check the status of an MMM data request — TikTok Business API

Check the status of an MMM data request · call it through Quantri360 with one API key for your own accounts / assets that you connected and authorized — 360 handles request signing and refreshing the authorization you granted.

Check the status of an MMM data request

GET/mmm/api/check/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/mmm/api/check/
Description

Use this endpoint to check the status of a Media Mix Modeling (MMM) data request.

Once the status of the data request is completed - ready for download, you can use /mmm/api/download/ to obtain a download URL for the data.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/mmm/api/check/

Authentication & shop

NameInTypeSampleDescription
AuthorizationheaderheaderBearer q360_live_ab12cd34_…Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand.
platform_shop_idquerystring7000000000000000001Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản.

Request parameters

NameInTypeRequiredSampleDescription
mmm_request_idquerystringYesUnique identifier for the MMM data request. - To create an MMM data request and obtain the data request ID, use /mmm/api/create/. - To retrieve historical MMM data requests, including data request IDs, use /mmm/api/history/.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/mmm/api/check/?mmm_request_id=" \
  -H "Authorization: Bearer $KEY"
Python
import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/tiktok_business/mmm/api/check/",
    params={
        "mmm_request_id": ""
    },
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())
Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/mmm/api/check/');
for (const [k, v] of Object.entries({"mmm_request_id":""})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
  method: 'GET',
  headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());
PHP
<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/mmm/api/check/' . '?' . http_build_query(['mmm_request_id' => '']);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]);
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;

Response

Response fields (as returned by TikTok Business)

NameTypeSampleDescription
codenumberResponse code. For the complete list of response codes and descriptions, see Appendix-Return Code.
messagestringResponse message. For details, see Appendix - Return Codes.
request_idstringThe log ID of a request, which uniquely identifies the request.
dataobjectReturned data.
statusstringStatus of the data request. Enum values: - `request received`: The request was received but data processing has not started. - `in progress`: Data processing is in progress. - `completed - ready for download`: Data processing has completed and the data is ready for download. - To obtain a download URL for the data, use /mmm/api/download/. - `failed`: The request failed.
messagestringReturned only when `status` is `failed`. The reason why the data request failed.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "status": "completed - ready for download"
    }
}

Get started

  1. Sign up for Partner
  2. Enable a data type of the Ads (Marketing API) group on the platform page
  3. Create an API key (tick the TikTok Business channel)
  4. Call it as in the examples above