Get report content¶
Endpoint: {{apiRoute}}/reports/:reportId/transcript/:type
What it does: This endpoint is used to retrieve the content of a report.
Parameters:
- reportId: the id of the report
- type: the type of the content to retrieve.
- tweets to return the ids of the tweets of the report
- users to return the ids of the users that posted the tweets
Filtering results: You can learn the basics about paginated results in the Results Navigation section.
Even if we cannot give you the raw info about the tweets you can sort and filter them using our API filters.
Tweets fields to filter¶
| Field | Type | Description |
|---|---|---|
| _id | string | Tweet Id |
| conversationId | string? | Id of the initial tweet of conversation (ie. 1st tweet of a thread) |
| counts | object | Tweet numeric stats |
| counts.textLength | number | Number of characters of the tweet |
| counts.retweets | number | Values 1 or 0: 1 if tweet is a retweet; 0 if not |
| counts.totalRetweets | number | Number of retweets of the tweet |
| counts.favorites | number | Number of likes of the tweet |
| counts.hashtags | number | Number of hashtags of the tweet |
| counts.images | number | Number of images of the tweet |
| counts.links | number | Number of links of the tweet |
| counts.linksAndImages | number | Number of links and images of the tweet |
| counts.mentions | number | Number of users mentioned in the tweet |
| counts.quotes | number | Number of quotes of the tweet |
| counts.impressions | number | Number of impressions of the tweet |
| counts.totalReplies | number | Number of replies of the tweet |
| counts.bookmarks | number | Number of bookmarks of the tweet |
| counts.originals | number | Values 1 or 0: 1 if tweet is original, 0 if is a retweet |
| counts.clears | number | Values 1 or 0: 1 if tweet doesn't have text or images |
| counts.replies | number | Values 1 or 0: 1 if tweet is a reply, 0 if not |
| counts.userValue | number | Economic value of the author of the tweet |
| counts.tweetValue | number | Economic value of the tweet |
| createdAt | number | Creation date of the tweet |
| hashtags | string[] | List of hashtags of the tweet |
| images | string[] | List of images of the tweet (image urls) |
| inReplyToId | string? | ID of the tweet the tweet replies to |
| lang | string? | Language of the tweet |
| links | string[] | List of the links in the tweet |
| mentions | string[] | List of the users mentioned in the tweet |
| retweeted | Tweet | Retwetted tweet: it contains the same fields than a tweet |
| user | object | Author of the tweet |
| user.id | string | Twitter ID of the author |
| user.name | string | Twitter name of the author |
| user.alias | string | Twitter username of the author (@username) |
| user.picture | string | Link to the profile picture of the author |
| user.followers | number | Number of followers of the author |
| user.following | number | Number of accounts the author follows |
| user.verified | boolean | Shows if the author is verified or not |
| user.age | number | Age on Twitter of the author |
| user.gender | number | Gender of the author |
| user.value | number | Economic value of the author |
| sentiment.vote | string | Sentiment of the tweet: positive, negative, neutral, undefined |