Search Terms

List search terms

GET
/api/v1/accounts/{projectId}/search-terms

Real App Store queries that triggered your ads. source=AUTO are Search Match discoveries — the harvest candidates. unadded=true narrows to AUTO terms in ENABLED campaigns that are neither a keyword nor a negative yet: the harvest work queue, and the reason this silo exists.

Known quirk: adGroupId is ignored when unadded=true (the underlying query has no ad-group filter). With unadded=true the minTaps floor is at least 1 — a term nobody tapped can't be judged.

Required scope: read.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from Workspace → Settings → API keys, sent as Authorization: Bearer tsk_….

Authorization has two independent axes.

The scope is ranked — a key satisfies any requirement at or below its own tier:

  • read — see state. Never changes anything.
  • write — propose changes (the actions/* endpoints), trigger audits and reports.
  • admin — connection, account import, sync, targets and brief.

There is no approve scope. It was a rung once; it is not one now, and a key requested with it is rejected.

The approval grant (can_approve) is a separate boolean, not a rung. Deciding a queued proposal — approve, reject, revert — needs write and the grant. Keeping them on separate axes is what makes the review gate a control rather than a convention: a key that may propose is not automatically a key that may approve its own proposal.

A key is either org-scoped (reaches every account, optionally limited to a subset) or bound to a single account.

In: header

Path Parameters

projectId*string

The account's project UUID — from GET /accounts, NOT the Apple asaOrgId. Pass the literal current with an account-scoped key to use its bound account.

Query Parameters

source?string

AUTO = Search Match discoveries; TARGETED = matched your keywords.

Default"all"

Value in

  • "AUTO"
  • "TARGETED"
  • "all"
unadded?boolean

Only unharvested AUTO terms. Overrides source.

Defaultfalse
campaignId?string

Restrict to one campaign.

adGroupId?string

Restrict to one ad group.

days?integer

Look-back window in days. Anchors at YESTERDAY, not today — Apple's current-day numbers are incomplete.

Range1 <= value <= 90
Default30
minTaps?integer

Floor on taps, to filter noise.

Range0 <= value
Default0
limit?integer

Maximum rows to return. Lists rank by spend and truncate; check total and truncated.

Range1 <= value <= 200
Default100

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/accounts/current/search-terms"
{  "currency": "string",  "searchTerms": [    {}  ],  "total": 0,  "truncated": true,  "dataFreshness": {    "lastSyncAt": "2019-08-24T14:15:22Z",    "ageHours": 0,    "coverage": "string",    "warning": "string"  }}