Skip to main content
GET
Review status of every TikTok Smart+ ad of an advertiser

Request contract

  • Method and path: GET /apis/v1/ads/tiktok-smart-plus-reviews
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/ads/tiktok-smart-plus-reviews
  • connectionId: query; required
  • adAccountId: query; required
  • includeDeleted: query; optional
  • maxAgeSeconds: query; optional
  • page: query; optional
  • pageSize: query; optional
  • Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09
Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

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

includeDeleted
boolean
default:false

Also return Smart+ ads deleted on TikTok (listed with primary_status: STATUS_ALL).

maxAgeSeconds
integer
default:3600

Freshness window in seconds. Reviews, refusals and the listing read within it are served without calling TikTok; older ones are still returned but read again, oldest first.

Required range: 600 <= x <= 86400
page
integer
default:1
Required range: x >= 1
pageSize
integer
default:500
Required range: 1 <= x <= 1000

Response

The reviews of one page of the advertiser's Smart+ ads. Check incomplete: when true, some Smart+ ads of the page were never read. allFresh says whether every review is within maxAgeSeconds.

adAccountId
string
allFresh
boolean

True when every item and refusal of this page was read within maxAgeSeconds and nothing is pending.

counts
object

The Smart+ ads on this page split by state; the four counts add up to the Smart+ ads on this page (fewer than pageSize on the last page).

failedSmartPlusAds
object[]

Smart+ ads of this page whose review TikTok refused on its own (e.g. an ad deleted on TikTok since the listing was read). Empty when none.

includeDeleted
boolean
incomplete
boolean

True while some Smart+ ads of this page were never read (counts.pending > 0). Stale items alone keep it false.

items
object[]
listing
object

The Smart+ ad listing this page was cut from.

maxAgeSeconds
integer

The freshness window this page was read with.

oldestReadAt
string<date-time> | null

The oldest readAt in items. Null when items is empty.

page
integer
pageSize
integer
pendingSmartPlusAdIds
string[]

Smart+ ads of this page never read. Empty when every ad has a stored review or refusal.

refreshState
enum<string>

Whether this request could refresh the due (stale or pending) Smart+ ads of the page. Carries retryAfterSeconds.

Available options:
ok,
paused,
refused,
error
retryAfterSeconds
integer | null

Set exactly when refreshState is paused or refused, including stale items with nothing pending. Always equals the Retry-After header, which is sent exactly when this is not null. Client rule:

reviewError
object | null

Set when TikTok refused both halves of a review batch the same way (for example a permission error) and the page was served from stored reviews instead of being refreshed. Null otherwise.

totalPages
integer
totalSmartPlusAds
integer

Smart+ ads of the advertiser across all pages.