Create a view
Saves a named mention filter. It uses the same fields as GET /v1/mentions, where a list matches any value, a not list matches none, and all conditions are joined by AND. anyOf adds groups of such conditions, at least one of which must match. An empty filter shows all mentions. Nothing is stored ahead of time, so a view shows whatever matches when you read it.
Authorization
bearerAuth An API key from POST /v1/api-keys. Keys start with ref_.
In: header
Request Body
application/json
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/views" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "id": "string", "name": "string", "description": "string", "filter": { "q": "string", "keywordIds": [ "string" ], "notKeywordIds": [ "string" ], "keywordKinds": [ "brand" ], "groupIds": [ "string" ], "notGroupIds": [ "string" ], "platforms": [ "bluesky" ], "notPlatforms": [ "bluesky" ], "status": "open", "relevant": true, "minRelevance": 0, "minConfidence": 0, "sentiments": [ "positive" ], "notSentiments": [ "positive" ], "intents": [ "string" ], "notIntents": [ "string" ], "automated": true, "languages": [ "string" ], "notLanguages": [ "string" ], "tags": [ "string" ], "notTags": [ "string" ], "linkHosts": [ "string" ], "notLinkHosts": [ "string" ], "minFollowers": 0, "maxFollowers": 0, "isReply": true, "excludeAuthors": [ "string" ], "ratings": [ 1 ], "notRatings": [ 1 ], "minLikes": 0, "minReposts": 0, "minReplies": 0, "minQuotes": 0, "minViews": 0, "minBookmarks": 0, "anyOf": [ { "q": "string", "keywordIds": [ "string" ], "notKeywordIds": [ "string" ], "keywordKinds": [ "brand" ], "groupIds": [ "string" ], "notGroupIds": [ "string" ], "platforms": [ "bluesky" ], "notPlatforms": [ "bluesky" ], "status": "open", "relevant": true, "minRelevance": 0, "minConfidence": 0, "sentiments": [ "positive" ], "notSentiments": [ "positive" ], "intents": [ "string" ], "notIntents": [ "string" ], "automated": true, "languages": [ "string" ], "notLanguages": [ "string" ], "tags": [ "string" ], "notTags": [ "string" ], "linkHosts": [ "string" ], "notLinkHosts": [ "string" ], "minFollowers": 0, "maxFollowers": 0, "isReply": true, "excludeAuthors": [ "string" ], "ratings": [ 1 ], "notRatings": [ 1 ], "minLikes": 0, "minReposts": 0, "minReplies": 0, "minQuotes": 0, "minViews": 0, "minBookmarks": 0 } ] }, "createdAt": "string", "updatedAt": "string"}Get usage and balance
Shows whether tracking is stopped or the balance is low. Also returns the prepaid balance (ledger total, pending mention charges, and the effective balance that decides pausing), daily spend and days left, running and paused keywords, and matches today and over 30 days. Pricing is $0.008 per matched mention, relevant or not, and $5 a month per active keyword, charged daily.
Delete a view
Deletes the view. Its mentions are unchanged.