Per-creative performance inside TikTok Smart+ ads

curl --request GET \
  --url https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-materials \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-materials"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-materials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-materials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-materials"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-materials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "adAccountId": "<string>",
  "endDate": "<string>",
  "level": "ad",
  "missingRows": 123,
  "page": 123,
  "pageSize": 123,
  "rows": [
    {
      "adGroupId": "<string>",
      "materialId": "<string>",
      "materialType": "<string>",
      "metrics": {
        "addPaymentInfo": 123,
        "addToCart": 123,
        "clicks": 123,
        "cpc": 123,
        "impressions": 123,
        "initiateCheckout": 123,
        "purchaseValue": 123,
        "purchases": 123,
        "roas": 123,
        "spend": 123
      },
      "name": "<string>",
      "smartPlusAdId": "<string>",
      "tiktokItemId": "<string>"
    }
  ],
  "startDate": "<string>",
  "totalPages": 123,
  "totalRows": 123
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "retryHint": "<string>",
    "retryable": true,
    "type": "<string>"
  }
}

AIsa Ads

Per-creative performance inside TikTok Smart+ ads

Ad Insights. Read only. Breaks a Smart+ ad (or ad group) down by creative material, one row per Spark post, video or image, from TikTok's Smart+ material report. For a Spark post `tiktokItemId` is the TikTok post id. ### Metrics Conversion metrics are TikTok web (pixel) events.  A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.

GET

https://api.aisa.one

apis

ads

tiktok-smart-plus-materials

Per-creative performance inside TikTok Smart+ ads

curl --request GET \
  --url https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-materials \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-materials"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-materials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-materials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-materials"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-materials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "adAccountId": "<string>",
  "endDate": "<string>",
  "level": "ad",
  "missingRows": 123,
  "page": 123,
  "pageSize": 123,
  "rows": [
    {
      "adGroupId": "<string>",
      "materialId": "<string>",
      "materialType": "<string>",
      "metrics": {
        "addPaymentInfo": 123,
        "addToCart": 123,
        "clicks": 123,
        "cpc": 123,
        "impressions": 123,
        "initiateCheckout": 123,
        "purchaseValue": 123,
        "purchases": 123,
        "roas": 123,
        "spend": 123
      },
      "name": "<string>",
      "smartPlusAdId": "<string>",
      "tiktokItemId": "<string>"
    }
  ],
  "startDate": "<string>",
  "totalPages": 123,
  "totalRows": 123
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "retryHint": "<string>",
    "retryable": true,
    "type": "<string>"
  }
}

Request contract

Method and path: GET /apis/v1/ads/tiktok-smart-plus-materials
Availability: enabled
Request URL template: https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-materials
connectionId: query; required
adAccountId: query; required
startDate: query; required
endDate: query; required
level: query; optional
smartPlusAdIds: query; optional
adGroupIds: query; optional
page: query; optional
pageSize: query; optional
Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09

Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

{
  "operationId": "get_aisa_ads_apis_v1_ads_tiktok_smart_plus_materials",
  "method": "GET",
  "path": "/apis/v1/ads/tiktok-smart-plus-materials",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "description": "The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.",
      "in": "query",
      "name": "connectionId",
      "required": true,
      "schema": {
        "pattern": "^adc_[0-9A-Za-z]+$",
        "type": "string"
      }
    },
    {
      "description": "TikTok advertiser ID",
      "in": "query",
      "name": "adAccountId",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "YYYY-MM-DD, in the advertiser's time zone",
      "in": "query",
      "name": "startDate",
      "required": true,
      "schema": {
        "format": "date",
        "type": "string"
      }
    },
    {
      "description": "YYYY-MM-DD, on or after startDate",
      "in": "query",
      "name": "endDate",
      "required": true,
      "schema": {
        "format": "date",
        "type": "string"
      }
    },
    {
      "description": "Key each row by Smart+ ad or by ad group",
      "in": "query",
      "name": "level",
      "required": false,
      "schema": {
        "default": "ad",
        "enum": [
          "ad",
          "adGroup"
        ],
        "type": "string"
      }
    },
    {
      "description": "Comma-separated Smart+ ad ids to filter by (up to 100)",
      "in": "query",
      "name": "smartPlusAdIds",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Comma-separated ad group ids to filter by (up to 100) Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.",
      "in": "query",
      "name": "adGroupIds",
      "required": false,
      "schema": {
        "type": "string"
      }
    },
    {
      "in": "query",
      "name": "page",
      "required": false,
      "schema": {
        "default": 1,
        "minimum": 1,
        "type": "integer"
      }
    },
    {
      "in": "query",
      "name": "pageSize",
      "required": false,
      "schema": {
        "default": 100,
        "maximum": 1000,
        "minimum": 1,
        "type": "integer"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "description": "Ads operations are free. Ad spend is billed by the ad platform to the connected ad account, never by AIsa.",
    "kind": "no_customer_charge"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

Cost and request rules

A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

connectionId

string

required

The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.

Pattern: ^adc_[0-9A-Za-z]+$

adAccountId

string

required

TikTok advertiser ID

startDate

string<date>

required

YYYY-MM-DD, in the advertiser's time zone

endDate

string<date>

required

YYYY-MM-DD, on or after startDate

level

enum<string>

default:ad

Key each row by Smart+ ad or by ad group

Available options:

ad,

adGroup

smartPlusAdIds

string

Comma-separated Smart+ ad ids to filter by (up to 100)

adGroupIds

string

Comma-separated ad group ids to filter by (up to 100) Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.

page

integer

default:1

Required range: x >= 1

pageSize

integer

default:100

Required range: 1 <= x <= 1000

Response

Material rows

adAccountId

string

endDate

string

level

enum<string>

Available options:

ad,

adGroup

missingRows

integer

Rows TikTok declared that a read and its retry could not return. 0 when the result is complete.

page

integer

pageSize

integer

rows

object[]

Show child attributes

startDate

string

totalPages

integer

totalRows

integer

​Request contract

​Cost and request rules

Authorizations

Query Parameters

Response

Request contract

Cost and request rules