Skip to main content
All post, user, and comment tools support a fields parameter that lets you specify exactly which fields to include in the response. This dramatically improves response time and reduces token consumption.
Always specify only the fields you need. Requesting all fields when you only need a few wastes tokens and slows down responses.

​
Usage

Pass an array of field names to the fields parameter: 
{
  "tool": "getTwitterPostsByKeywords",
  "arguments": {
    "query": "artificial intelligence",
    "fields": ["id", "text", "authorUsername", "retweetCount", "createdAtDate"]
  }
}
When fields is omitted, tools return a set of default fields (not all fields).

​
Available Fields by Platform

Default fields: id, text, authorUsername, impressionCount, lang, createdAtDate
CategoryFields
IDs and Contentid, authorId, authorUsername, text
EngagementbookmarkCount, impressionCount, likeCount, quoteCount, replyCount, retweetCount
ReferencesconversationId, quotedTweetId, retweetedTweetId, replyToTweetId, replyToUserId, replyToUsername, originalTweetId, editedTweets
Content Tagshashtags, mentions, mediaUrls, urls
Statusstatus, deleted, suspended, possiblySensitive, isRetweet
Metadatalang, source, createdAt, createdAtDate
BirdwatchhasBirdwatchNotes, birdwatchNotesId, birdwatchNotesText, birdwatchNotesUrl
AIgrokGeneratedContent
Locationcountry, region, city

​
Examples by Use Case

Focus on metrics and timing:
{
  "fields": ["id", "text", "retweetCount", "likeCount", "quoteCount", "replyCount", "createdAtDate"]
}
Focus on text and author context:
{
  "fields": ["id", "text", "authorUsername", "hashtags", "mentions", "createdAtDate"]
}
Focus on identity and reach:
{
  "fields": ["id", "username", "name", "followersCount", "followingCount", "description", "isVerified"]
}
When you only need to count or reference results:
{
  "fields": ["id"]
}
If you are unsure which fields you need, start with the defaults (omit the fields parameter). Then narrow down to specific fields once you know what your analysis requires.