Objecten

De hierboven genoemde vormen, veld voor veld. Typen zijn informeel: string[] is een array van strings, A | null kan ontbreken.

Envelop

Aanwezig op elke gebeurtenis, op de stream, in GET /v1/events en in webhook-leveringen.

Veld	Type	Betekenis
`v`	int	Envelopversie. Vandaag `1`
`t`	string	Gebeurtenistype, uit de tabel hieronder
`op`	create \| update \| delete	`create`, `update` (verrijking van hetzelfde id) of `delete`
`id`	string	Stabiele identiteit. Ontdubbel hierop
`ts`	int (ms)	Wanneer het op X gebeurde, in ms sinds de epoch. X geeft geen tijdstip voor profielwijzigingen, volgen en ontvolgen, nieuwe geverifieerde volgers en verwijderde berichten: bij die gebeurtenissen is het het moment waarop wij het detecteerden
`sid`	string	Streampositie voor replay; aanwezig op de stream en in de historie
`target.id`	string	Numeriek X-id van het gevolgde account (voor `search.match`: van de auteur van het bericht)
`target.screen_name`	string	Handle van het gevolgde account
`target.name`	string	De weergavenaam van het account
`d`	object	Typespecifieke payload

Tweet-payload

De d van tweet.create, tweet.reply, tweet.retweet en tweet.quote, en de basis van search.match.

Veld	Type	Betekenis
`tweet_id`	string	Het id van het bericht, als string
`kind`	tweet \| reply \| retweet \| quote	Wat voor soort bericht het is
`text`	string	Volledige tekst (inclusief lange berichten)
`lang`	string \| null	Taal die X heeft gedetecteerd
`author`	User	Het account dat het plaatste, als volledige User — hetzelfde object als de auteur van een `search.match`: handle, naam, bio, avatar, banner, tellers, verificatie, locatie, link en aanmelddatum. Op een mager eerste frame is het het account zoals laatst gelezen; de `update` bevat het zoals gelezen met het bericht
`reply_to`	Brief+ \| null	Voor reacties: het bericht waarop wordt gereageerd — een Brief plus `screen_name`, `tweet_id` en `user_id` van de auteur ervan
`retweet_of`	Brief \| null	Voor reposts: het oorspronkelijke bericht
`quoted`	Brief \| null	Voor citaten: het geciteerde bericht
`media`	string[]	Kale afbeeldings-URL's, één per media-item
`media_items`	Media[]	Elk media-item met type, videovarianten en afmetingen
`urls`	string[]	Uitgevouwen links in het bericht
`article`	Article \| null	Bij posts die naar een X-artikel linken: het artikel
`counts`	{reply, rt, like, quote, bookmark}	Aantal reacties, reposts, likes, citaten en bladwijzers op het moment dat we het lazen
`views`	int \| null	Aantal weergaven, wanneer X dat vrijgeeft
`url`	string	Canonieke link naar het bericht
`full`	bool	`false` op een eerste, mager `create`-frame; `true` zodra de gebeurtenis het hele bericht bevat
`kind_final`	bool	`true` als `kind` vaststaat. `false` alleen op een mager eerste frame waarvan `kind` `tweet` is: het bericht kan nog een citaat blijken, en de `update` op hetzelfde `id` beslist
`kind_was`	tweet \| null (update only)	Alleen op de `update` die het soort bericht vastlegt, en alleen als het eerste frame iets anders zei: het soort dat dat frame had (`tweet` voor een bericht dat een citaat bleek)
`edit_of`	Brief \| null	Bij `tweet.edit`: de versie die deze vervangt (haar id, en tekst en auteur als we die hadden)

Brief

Een compact bericht ingebed in een andere gebeurtenis: het origineel van een repost, het geciteerde bericht, het bericht waarop wordt gereageerd, of een vastgezet bericht.

Veld	Type	Betekenis
`id`	string	Bericht-id
`user`	string	Handle van de auteur
`name`	string	Weergavenaam van de auteur
`user_id`	string	Numeriek id van de auteur
`text`	string	Volledige tekst
`media`	string[]	Kale afbeeldings-URL's
`media_items`	Media[]	Media-items met type en videovarianten
`created_ms`	int	Wanneer het is geplaatst, in ms sinds de epoch
`url`	string	Link naar het bericht

Media

Eén foto, video of GIF. Video's dragen de MP4 met de hoogste bitrate die we konden vinden; url is het posterframe.

Veld	Type	Betekenis
`type`	photo \| video \| animated_gif	Soort media
`url`	string	Afbeeldings-URL, of het posterframe van een video
`expanded_url`	string	De mediapagina van het bericht op X
`video_url`	string (video)	MP4-URL, hoogste beschikbare bitrate
`bitrate`	int (video)	Bitrate van die MP4
`duration_ms`	int (video)	Videolengte
`width`	int	Oorspronkelijke breedte in pixels
`height`	int	Oorspronkelijke hoogte in pixels

Artikel

Een X-artikel (lang bericht) waarnaar een post linkt. Het eerste frame bevat title en preview; text is null tot de update met dezelfde id het volledige artikel brengt.

Veld	Type	Betekenis
`id`	string	Artikel-id
`title`	string	Titel
`preview`	string	De eerste regels van het artikel
`text`	string \| null	Volledige tekst, alinea's gescheiden door lege regels; `null` in het eerste frame
`cover`	string \| null	URL van de omslagafbeelding
`images`	string[]	Afbeeldingen in het artikel
`url`	string	Link naar het artikel op X

Delete-payload

De d van tweet.delete. Wordt alleen verstuurd voor een bericht dat we hadden gezien en dat nu weg is. De ts is wanneer de verwijdering werd gedetecteerd; de tijd van het bericht zelf staat in het eerdere create-frame.

Veld	Type	Betekenis
`tweet_id`	string	Het id van het verwijderde bericht
`url`	string	Waar het vroeger stond

Profielwijziging-payload

De d van elke profile.*-gebeurtenis. op is hiervoor update.

Veld	Type	Betekenis
`field`	string	Welk profielveld is gewijzigd; hetzelfde woord als na `profile.` in het type
`old`	any	De vorige waarde
`new`	any	De nieuwe waarde
`tweet`	Brief (pinned only)	Voor `profile.pinned`: het nieuw vastgezette bericht
`old_tweet`	Brief (pinned only)	Voor `profile.pinned`: het eerder vastgezette bericht, als we het hadden

Follow-payload

De d van follow.add, follow.remove en followers.verified.add.

Veld	Type	Betekenis
`user`	User	Het andere account, als volledige User

Accountstatus-payload

De d van account.status. Een status is active, protected (berichten alleen zichtbaar voor goedgekeurde volgers), suspended (door X) of unavailable (gedeactiveerd, verwijderd of om een andere reden niet zichtbaar). ts is wanneer wij de wijziging detecteerden.

Veld	Type	Betekenis
`old`	active \| protected \| suspended \| unavailable	De status ervoor
`new`	active \| protected \| suspended \| unavailable	De status nu
`reason`	string \| null	De bewoording van X, als die er is (bijvoorbeeld `Suspended`)

User

Een volledig accountprofiel, zoals ingebed in volggebeurtenissen en in search.match.

Veld	Type	Betekenis
`id`	string	Numeriek id
`screen_name`	string	Handle
`name`	string	Weergavenaam
`bio`	string	Biotekst
`avatar`	string	URL van de avatarafbeelding
`banner`	string \| null	URL van de bannerafbeelding
`followers`	int	Aantal volgers
`following`	int	Aantal gevolgde accounts
`tweets`	int	Aantal berichten
`location`	string	Locatie als vrije tekst
`url`	string \| null	Uitgevouwen profiellink
`verified`	bool	Heeft een verificatiebadge
`verified_type`	string \| null	`blue`, `business`, `government` of `null`
`protected`	bool	Berichten zijn alleen zichtbaar voor goedgekeurde volgers
`created_at`	string (ISO-8601)	Wanneer het account is aangemaakt
`category`	string \| null	Professionele categorie, als het account er een heeft ingesteld

Zoektreffer-payload

De d van search.match: een Tweet-payload plus drie velden over de treffer. De target van de envelop is de auteur van het bericht, die niet een van uw targets hoeft te zijn.

Veld	Type	Betekenis
`keyword.id`	int	Id van het trefwoord dat overeenkwam
`keyword.query`	string	De query ervan
`keyword.label`	string \| null	Het label ervan, als u er een hebt ingesteld
`author`	User	Het volledige profiel van de auteur
`author_is_target`	bool	`true` als de auteur ook een account is dat op dit systeem wordt gevolgd
`…`	TweetPayload	Elk veld van de Tweet-payload

Target

Eén account dat u volgt, zoals deze sleutel het ziet.

Veld	Type	Betekenis
`id`	string	Numeriek X-id. Het verandert nooit: sleutel uw gegevens erop
`screen_name`	string	De huidige handle. Die kan veranderen; `profile.screen_name` meldt het
`name`	string	Weergavenaam
`previous_screen_names`	string[]	Handles die het account eerder had, de recentste eerst. Elk ervan wijst het nog aan in `/v1/monitor/targets/{target}`
`push_ready`	bool	Alle gebeurtenistypen waarop u voor dit account bent geabonneerd, worden realtime verzameld. `false` houdt niets tegen: het account wordt gemonitord vanaf het moment dat het is geabonneerd en de gebeurtenissen worden bezorgd zodra ze verzameld zijn, dus wacht niet op deze vlag voordat u ze verwerkt
`last_push_at`	datetime \| null	Laatste keer dat er een realtime gebeurtenis voor binnenkwam
`last_poll_at`	datetime \| null	Laatste keer dat zijn tijdlijn is gelezen
`state`	"subscribed"	Hier altijd `subscribed`; lopende resoluties hebben hun eigen vorm
`event_types`	string[]	De gebeurtenistypen die voor dit account worden bezorgd; leeg betekent alle die uw sleutel toestaat
`event_types_all`	bool	`true` als `event_types` leeg is

Target in behandeling

Wat GET /v1/monitor/targets/{target} teruggeeft zolang een account waar u om vroeg nog wordt opgezocht.

Veld	Type	Betekenis
`screen_name`	string \| null	De handle waar u om vroeg, als u op handle vroeg
`user_id`	string \| null	Het gebruikers-id waar u om vroeg, als u op id vroeg
`state`	"queued"	Altijd `queued`
`queued_at`	int (unix s)	Wanneer u erom vroeg
`event_types`	string[]	De ervoor gekozen gebeurtenistypen, toegepast zodra het is opgezocht
`event_types_all`	bool	`true` als `event_types` leeg is

Trefwoord

Eén query die u over X-zoeken volgt.

Veld	Type	Betekenis
`id`	int	Numeriek id; gebruik het om te verwijderen
`query`	string	De query, in X-zoeksyntaxis
`label`	string \| null	Uw label, herhaald in elke treffer
`active`	bool	`false` als de operator het heeft gepauzeerd
`hits`	int	Tot nu toe afgeleverde treffers
`last_hit_at`	datetime \| null	Laatste treffer
`last_run_at`	datetime \| null	Laatste zoekopdracht

Account

Wat GET /v1/account teruggeeft over de sleutel die u hebt gebruikt.

Veld	Type	Betekenis
`name`	string	De naam van de sleutel, zoals uitgegeven
`plan`	string	Plan-preset
`key_id`	string	Kort id van de sleutel, veilig om te citeren in supportverzoeken
`scopes`	string[]	Scopes die de sleutel heeft
`event_types`	string[]	Sleutelbrede toegestane lijst van gebeurtenistypen, door ons beheerd; leeg betekent alles
`event_types_all`	bool	`true` wanneer het filter leeg is
`limits.max_targets`	int	Limiet voor gevolgde accounts
`limits.max_conns`	int	Limiet voor gelijktijdige WebSockets
`limits.max_keywords`	int	Trefwoordlimiet
`limits.requests_per_minute`	int	Verzoekbudget per minuut
`usage.targets`	int	Momenteel gevolgde accounts
`usage.keywords`	int	Momenteel gevolgde trefwoorden

Webhook

Wat GET /v1/account/webhook teruggeeft.

Veld	Type	Betekenis
`url`	string \| null	Het geregistreerde endpoint
`stats`	{ok, http_`…}`	Leveringstellers: `ok`, en één `http_<code>` per waargenomen foutstatus

Veld	Type	Betekenis
`count`	int	Items op deze pagina
`has_more`	bool	Of er nog een pagina is
`next_cursor`	string \| null	Geef terug als `?cursor=`; `null` aan het einde

Batchresultaat

Eén item per element dat naar POST /v1/monitor/targets:batch is gestuurd, in dezelfde volgorde.

Veld	Type	Betekenis
`index`	int	Positie van het element in uw verzoek
`status`	int	De HTTP-status die het endpoint voor één item zou hebben teruggegeven
`data`	object (on success)	De antwoordbody voor één item, bij succes
`error`	{code, message, details?} (on failure)	Het gebruikelijke foutobject, bij mislukking

Profiel (lezen)

Wat GET /v1/users/{screen_name}, /v1/users/by-id/{user_id} en /v1/users/batch per account teruggeven.

Veld	Type	Betekenis
`id`	string	Numeriek id
`name`	string	Weergavenaam
`screen_name`	string	Handle
`bio`	string	Biotekst
`location`	string	Locatie als vrije tekst
`url`	string \| null	Profiellink
`avatar`	string	URL van de avatarafbeelding
`banner`	string \| null	URL van de bannerafbeelding
`pinned`	string \| null	Id van het vastgezette bericht
`verified`	bool	Heeft een verificatiebadge
`protected`	bool	Berichten alleen zichtbaar voor goedgekeurde volgers
`followers`	int	Aantal volgers
`following`	int	Aantal gevolgde accounts
`tweets`	int	Aantal berichten

Tweet (lezen)

Een bericht zoals de leesendpoints het teruggeven. Dezelfde informatie als de Tweet-payload, in de plattere vorm die onze parser produceert.

Veld	Type	Betekenis
`id`	int	Bericht-id, numeriek
`created_ms`	int	Wanneer het is geplaatst, in ms sinds de epoch
`user_id`	int	Numeriek id van de auteur
`user`	string	Handle van de auteur
`name`	string	Weergavenaam van de auteur
`text`	string	Volledige tekst
`lang`	string \| null	Taal die X heeft gedetecteerd
`reply_to`	string \| null	Handle waarop wordt gereageerd
`reply_to_status_id`	string \| null	Id van het bericht waarop wordt gereageerd
`reply_to_user_id`	string \| null	Id van het account waarop wordt gereageerd
`conversation_id`	string	Id van het beginbericht van de thread
`is_rt`	bool	Het is een repost
`rt_of`	Brief \| null	Het origineel, voor reposts
`is_quote`	bool	Het citeert een ander bericht
`quoted`	Brief \| null	Het geciteerde bericht
`media`	string[]	Kale afbeeldings-URL's
`media_items`	Media[]	Media-items met type en videovarianten
`urls`	string[]	Uitgevouwen links
`views`	int \| null	Aantal weergaven
`counts`	{reply, rt, like, quote, bookmark}	Aantal reacties, reposts, likes, citaten en bladwijzers
`article`	Article \| null	Het X-artikel waar het bericht naar linkt, als dat zo is (titel, voorbeeld, omslag, afbeeldingen; de volledige tekst staat op `GET /v1/tweets/{tweet_id}/article`)
`edit_of`	int \| null	Bij een bewerkte versie: het id van de eerste versie, anders `null`
`edit_ids`	int[]	De id's van alle versies, de oudste eerst; een nooit bewerkt bericht noemt alleen zichzelf
`source`	string \| null	De client waarmee is gepost, zoals X die geeft (een HTML-link, bijvoorbeeld `Twitter for iPhone`)

Gebruikersreferentie

De compacte vorm die in volglijst-leesbewerkingen wordt gebruikt.

Veld	Type	Betekenis
`id`	string	Numeriek id
`screen_name`	string	Handle
`name`	string	Weergavenaam