Skip to content
Kumquat
Esc
↑↓navigate↵open⌘Jpreview

Creative Notes Cloud

The most-mentioned words across the notes of the creatives the current filters match, largest first — the word cloud on the creatives page.

The feed’s filters, and neither its sort nor its cursor: the cloud is over the whole matched set, not over a page of it. Clicking a word puts it in the search box, which matches name and notes together, so the cloud narrows the feed it was built from.

Cached per filter combination, because this is the one creatives read with no index behind it — a word inside a string is not indexable — and the unfiltered page is a state every reader shares. Flat parameters rather than a params model so the key can name them; the TTL is short enough that a notes edit shows up without an explicit invalidation.

GET/api/v1/creatives/notes-cloud
Authorization
AuthorizationBearer token · headerrequired
or
AuthorizationOAuth2 access token · headerrequired
Query parameters
querystring | any
react-querybuilder rule group as a JSON string
task_idstring | any
only count the notes of this task's creatives
limitinteger
min 1 · max 300 · default: 120
refreshboolean
recount rather than answer from the cached cloud
default: false
Responses
200Successful Response
successboolean
default: true
dataNotesCloud | any
Show properties
Any of:
NotesCloud
wordsNotesCloudWord[]required
Show properties
Array of NotesCloudWord
wordstringrequired
countintegerrequired
any
any
messagestring | any
Show properties
Any of:
string
string
any
any
errorsstring[] | any
Show properties
Any of:
string[]
Array of string
string
any
any
422Validation Error
detailValidationError[]
Show properties
Array of ValidationError
locstring | integer[]required
Show properties
Array of string | integer
Any of:
string
string
integer
integer
msgstringrequired
typestringrequired
inputany
ctxobject
Request
curl -X GET "/api/v1/creatives/notes-cloud" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "success": true,
  "data": {
    "words": [
      {
        "word": "string",
        "count": 0
      }
    ]
  },
  "message": "string",
  "errors": [
    "string"
  ]
}