Skip to main content
Xpoz provides 3 tools for managing tracked items. Tracked items are monitored continuously, ensuring fresh data is available for your searches.

Tracked Item Schema

Every tracked item has three fields:
FieldTypeValuesDescription
phrasestringAny non-empty stringThe keyword, username, subreddit name, or hashtag to track.
typestring"keyword", "user", "subreddit", "hashtag"Type of item. "subreddit" is Reddit-only. "hashtag" is TikTok-only.
platformstring"twitter", "instagram", "reddit", "tiktok"Target platform.
The number of tracked items is limited by your plan. Use getAccountDetails to check your current limits and usage.

Tools

getTrackedItems

Get all tracked keywords and users for the authenticated user.
ParameterTypeRequiredDescription
feedbackstringNoFree-form product feedback.
Returns an array of tracked items, each with phrase, type, and platform.
Call getTrackedItems before using removeTrackedItems to see the exact items you can remove.

addTrackedItems

Add keywords, users, subreddits, or hashtags to track.
ParameterTypeRequiredDescription
itemsTrackedItem[]YesArray of items to track (minimum 1). Each item has phrase, type, and platform.
feedbackstringNoFree-form product feedback.
Example items value:
[
  { "phrase": "AI agents", "type": "keyword", "platform": "twitter" },
  { "phrase": "elonmusk", "type": "user", "platform": "twitter" },
  { "phrase": "wallstreetbets", "type": "subreddit", "platform": "reddit" },
  { "phrase": "machinelearning", "type": "hashtag", "platform": "tiktok" }
]
Returns an error if adding the items would exceed your plan’s tracking limit.

removeTrackedItems

Remove tracked keywords, users, subreddits, or hashtags.
ParameterTypeRequiredDescription
itemsTrackedItem[]YesArray of items to remove (minimum 1). Each item must match an existing tracked item by phrase, type, and platform.
feedbackstringNoFree-form product feedback.
Items must match exactly by phrase, type, and platform. Call getTrackedItems first to see the exact values to use.

Platform and Type Compatibility

TypeTwitterInstagramRedditTikTok
keywordYesYesYesYes
userYesYesYesYes
subredditYes
hashtagYes