The identity and technical contract details declared by the specification.
TweetEditComplianceObjectSchema
object
4 properties
4 required
FollowActivityResponsePayload
object
2 properties
ActivitySubscriptionFilter
object
An XAA subscription filter.
3 properties
Get2TweetsSearchStreamRulesCountsResponse
object
2 properties
RulesResponseMetadata
object
4 properties
1 required
WebhookLinksDeleteResponse
object
2 properties
WebhookLinksGetResponse
object
2 properties
TweetDeleteComplianceSchema
object
1 property
1 required
UserName
string
The X handle (screen name) of this user.
NextToken
string
The next token.
TweetWithheldComplianceSchema
object
1 property
1 required
CountryCode
string
A two-letter ISO 3166-1 alpha-2 country code.
EntityIndicesInclusiveExclusive
object
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). start must be smaller than end. The start index…
2 properties
2 required
AppRulesCount
object
A count of user-provided stream filtering rules at the client application level.
2 properties
TweetEditComplianceSchema
object
1 property
1 required
User
object
The X User object.
21 properties
3 required
TweetTakedownComplianceSchema
object
4 properties
3 required
HttpStatusCode
integer
HTTP Status Code.
PollOption
object
Describes a choice in a Poll object.
3 properties
3 required
TweetUnviewable
object
3 properties
3 required
UserUndeleteComplianceSchema
object
1 property
1 required
Keyword
string
A keyword to filter on.
CommunityId
string
The unique identifier of this Community.
LikeId
string
The unique identifier of this Like.
PlaceId
string
The identifier for this place.
TweetNotice
object
7 properties
4 required
Rule
object
A user-provided stream filtering rule.
3 properties
1 required
TweetComplianceStreamResponse
Tweet compliance stream events.
TweetUndropComplianceSchema
object
1 property
1 required
StreamingLikeResponseV2
object
3 properties
TweetComplianceData
Tweet compliance data.
NoteTweetText
string
The note content of the Tweet.
RuleValue
string
The filterlang value of the rule.
RuleTag
string
A tag meant for the labeling of user provided rules.
UserTakedownComplianceSchema
object
3 properties
3 required
ContextAnnotationDomainFields
object
Represents the data for the context annotation domain.
3 properties
1 required
FilteredStreamingTweetResponse
object
A Tweet or error that can be returned by the streaming Tweet API. The values returned with a successful streamed Tweet includes the user provided rules that th…
4 properties
DisplayTextRange
array
Represent a boundary range (start and end zero-based indices) for the portion of text that is displayed for a post. start must be smaller than end. The start i…
UserWithheldComplianceSchema
object
1 property
1 required
TweetDropComplianceSchema
object
1 property
1 required
ActivitySubscriptionId
string
The unique identifier of this subscription.
UserProfileModificationComplianceSchema
object
1 property
1 required
StreamingTweetResponse
object
3 properties
RuleId
string
Unique identifier of this rule.
EntityIndicesInclusiveInclusive
object
Represent a boundary range (start and end index) for a recognized entity (for example a hashtag or a mention). start must be smaller than end. The start index…
2 properties
2 required
Error
object
2 properties
2 required
DeleteRulesRequest
object
A response from deleting user-specified stream filtering rules.
1 property
1 required
UserUnsuspendComplianceSchema
object
1 property
1 required
LikeComplianceSchema
object
1 property
1 required
TweetWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
3 properties
2 required
NewsActivityResponsePayload
object
4 properties
ActivitySubscriptionCreateResponse
object
3 properties
MediaHeight
integer
The height of the media in pixels.
UserSuspendComplianceSchema
object
1 property
1 required
TweetNoticeSchema
object
1 property
1 required
FullTextEntities
object
5 properties
ReplySettingsWithVerifiedUsers
string
Shows who can reply a Tweet. Fields returned are everyone, mentionedusers, subscribers, verified and following.
ActivityEventId
string
The unique identifier of an Activity event.
AddRulesRequest
object
A request to add a user-specified stream filtering rule.
1 property
1 required
ProfileUpdateActivityResponsePayload
object
2 properties
MediaKey
string
The Media Key identifier for this attachment.
PollOptionLabel
string
The text of a poll choice.
LikeWithTweetAuthor
object
A Like event, with the tweet author user and the tweet being liked
5 properties
CashtagFields
object
Represent the portion of text recognized as a Cashtag, and its start and end position within the text.
1 property
1 required
MentionFields
object
Represent the portion of text recognized as a User mention, and its start and end position within the text.
2 properties
1 required
UnlikeComplianceSchema
object
2 properties
2 required
AddOrDeleteRulesResponse
object
A response from modifying user-specified stream filtering rules.
3 properties
1 required
HashtagFields
object
Represent the portion of text recognized as a Hashtag, and its start and end position within the text.
1 property
1 required
ContextAnnotationEntityFields
object
Represents the data for the context annotation entity.
3 properties
1 required
ActivitySubscriptionCreateRequest
object
4 properties
2 required
UserDeleteComplianceSchema
object
1 property
1 required
Position
array
A [GeoJson Position](https://tools.ietf.org/html/rfc7946section-3.1.1) in the format [longitude,latitude].
Expansions
object
6 properties
Get2TweetsSample10StreamResponse
object
3 properties
TopicId
string
Unique identifier of this Topic.
UserProfileModificationObjectSchema
object
4 properties
4 required
MediaWidth
integer
The width of the media in pixels.
Place
object
8 properties
2 required
UrlFields
object
Represent the portion of text recognized as a URL.
9 properties
1 required
ActivityStreamingResponsePayload
UserWithheld
object
Indicates withholding details for [withheld content](https://help.twitter.com/en/rules-and-policies/tweet-withheld-by-country).
2 properties
1 required
Topic
object
The topic of a Space, as selected by its creator.
3 properties
2 required
AllProjectClientApps
array
Client App Rule Counts for all applications in the project
UserId
string
Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
UserComplianceData
User compliance data.
UserUnprotectComplianceSchema
object
1 property
1 required
UserScrubGeoSchema
object
1 property
1 required
Media
object
4 properties
1 required
TweetLabelStreamResponse
Tweet label stream events.
ContextAnnotation
object
Annotation inferred from the Tweet text.
2 properties
2 required
UserComplianceStreamResponse
User compliance stream events.
TweetId
string
Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.
Url
string
A validly formatted URL.
UrlImage
object
Represent the information for the URL image.
3 properties
Point
object
A [GeoJson Point](https://tools.ietf.org/html/rfc7946section-3.1.2) geometry object.
2 properties
2 required
RulesLookupResponse
object
2 properties
1 required
UserScrubGeoObjectSchema
object
3 properties
3 required
Poll
object
Represent a Poll attached to a Tweet.
5 properties
2 required
Geo
object
4 properties
3 required
WebhookLinksCreateResponse
object
2 properties
TweetComplianceSchema
object
3 properties
2 required
Problem
object
An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).
4 properties
2 required
ActivitySubscription
object
An XActivity subscription.
7 properties
5 required
TweetText
string
The content of the Tweet.
TweetUnviewableSchema
object
1 property
1 required
UrlEntity
Represent the portion of text recognized as a URL, and its start and end position within the text.
PollId
string
Unique identifier of this poll.
WebhookConfigId
string
The unique identifier of this webhook config.
Tweet
object
29 properties
UserComplianceSchema
object
2 properties
2 required
ClientAppId
string
The ID of the client application
RulesCount
object
A count of user-provided stream filtering rules at the application and project levels.
5 properties
RuleNoId
object
A user-provided stream filtering rule.
2 properties
1 required
TweetLabelData
Tweet label data.
UserProtectComplianceSchema
object
1 property
1 required
ActivityStreamingResponse
object
An activity event or error that can be returned by the x activity streaming API.
2 properties
LikesComplianceStreamResponse
Likes compliance stream events.
The full machine-readable OpenAPI contract behind this narrative.
