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-cloudAuthorization
AuthorizationBearer token · headerrequiredor
AuthorizationOAuth2 access token · headerrequiredQuery parameters
querystring | anyreact-querybuilder rule group as a JSON string
task_idstring | anyonly count the notes of this task's creatives
limitintegermin 1 · max 300 · default: 120
refreshbooleanrecount rather than answer from the cached cloud
default: false
Responses
200Successful Response
successbooleandefault: true
dataNotesCloud | anyShow propertiesHide properties
Any of:
NotesCloud
wordsNotesCloudWord[]requiredShow propertiesHide properties
Array of
NotesCloudWordwordstringrequiredcountintegerrequiredany
anymessagestring | anyShow propertiesHide properties
Any of:
string
stringany
anyerrorsstring[] | anyShow propertiesHide properties
Any of:
string[]
Array of
stringstringany
any422Validation Error
detailValidationError[]Show propertiesHide properties
Array of
ValidationErrorlocstring | integer[]requiredShow propertiesHide properties
Array of
string | integerAny of:
string
stringinteger
integermsgstringrequiredtypestringrequiredinputanyctxobjectRequest
curl -X GET "/api/v1/creatives/notes-cloud" \
-H "Authorization: Bearer YOUR_TOKEN"const response = await fetch("/api/v1/creatives/notes-cloud", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_TOKEN"
}
});import requests
response = requests.get(
"/api/v1/creatives/notes-cloud",
headers={
"Authorization": "Bearer YOUR_TOKEN"
},
)Response
{
"success": true,
"data": {
"words": [
{
"word": "string",
"count": 0
}
]
},
"message": "string",
"errors": [
"string"
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}