Objek

Bentuk-bentuk yang dirujuk di atas, bidang demi bidang. Tipe bersifat informal: string[] adalah larik string, A | null boleh tidak ada.

Amplop

Ada pada setiap peristiwa, di stream, di GET /v1/events dan dalam pengiriman webhook.

Bidang	Tipe	Arti
`v`	int	Versi amplop. `1` saat ini
`t`	string	Tipe peristiwa, dari tabel di bawah
`op`	create \| update \| delete	`create`, `update` (pengayaan id yang sama) atau `delete`
`id`	string	Identitas stabil. Lakukan deduplikasi berdasarkan ini
`ts`	int (ms)	Kapan terjadi di X, ms sejak epoch. X tidak memberi tahu kapan profil berubah, kapan terjadi mengikuti atau berhenti mengikuti, kapan pengikut terverifikasi datang, atau kapan unggahan dihapus: untuk peristiwa itu, ini adalah saat kami mendeteksinya
`sid`	string	Posisi stream untuk pemutaran ulang; ada di stream dan dalam riwayat
`target.id`	string	Id numerik X dari akun yang dipantau (untuk `search.match`, dari penulis unggahan)
`target.screen_name`	string	Handle akun yang dipantau
`target.name`	string	Nama tampilan akun
`d`	object	Muatan khusus tipe

Muatan Tweet

d dari tweet.create, tweet.reply, tweet.retweet dan tweet.quote, serta dasar dari search.match.

Bidang	Tipe	Arti
`tweet_id`	string	Id unggahan, sebagai string
`kind`	tweet \| reply \| retweet \| quote	Jenis unggahannya
`text`	string	Teks lengkap (termasuk unggahan panjang)
`lang`	string \| null	Bahasa yang dideteksi X
`author`	User	Akun yang mengunggahnya, sebagai User lengkap — objek yang sama dengan penulis `search.match`: handle, nama, bio, avatar, banner, hitungan, verifikasi, lokasi, tautan, dan tanggal bergabung. Pada frame pertama yang tipis, ini akun sebagaimana terakhir dibaca; `update` membawanya sebagaimana dibaca bersama unggahan
`reply_to`	Brief+ \| null	Untuk balasan: unggahan yang dibalas — sebuah Brief ditambah `screen_name`, `tweet_id` dan `user_id` penulisnya
`retweet_of`	Brief \| null	Untuk unggahan ulang: unggahan aslinya
`quoted`	Brief \| null	Untuk kutipan: unggahan yang dikutip
`media`	string[]	URL gambar polos, satu per item media
`media_items`	Media[]	Setiap item media dengan tipe, varian video dan dimensinya
`urls`	string[]	Tautan yang diperluas dalam unggahan
`article`	Article \| null	Untuk unggahan yang menautkan Artikel X: artikel tersebut
`counts`	{reply, rt, like, quote, bookmark}	Jumlah balasan, unggahan ulang, suka, kutipan dan markah saat kami membacanya
`views`	int \| null	Jumlah tayangan, saat X mengeksposnya
`url`	string	Tautan kanonis ke unggahan
`full`	bool	`false` pada frame `create` pertama yang tipis; `true` begitu peristiwa membawa unggahan utuh
`kind_final`	bool	`true` bila `kind` sudah pasti. `false` hanya pada frame pertama yang tipis dengan `kind` berupa `tweet`: unggahan itu masih bisa ternyata kutipan, dan `update` pada `id` yang sama memastikannya
`kind_was`	tweet \| null (update only)	Hanya pada `update` yang memastikan jenis unggahan, dan hanya bila frame pertama menyebut jenis lain: jenis yang dimiliki frame itu (`tweet` untuk unggahan yang ternyata kutipan)
`edit_of`	Brief \| null	Pada `tweet.edit`: versi yang digantikan versi ini (id-nya, serta teks dan penulisnya bila kami memilikinya)

Brief

Unggahan ringkas yang disematkan di dalam peristiwa lain: unggahan asli dari sebuah unggahan ulang, unggahan yang dikutip, unggahan yang dibalas, atau unggahan tersemat.

Bidang	Tipe	Arti
`id`	string	Id unggahan
`user`	string	Handle penulis
`name`	string	Nama tampilan penulis
`user_id`	string	Id numerik penulis
`text`	string	Teks lengkap
`media`	string[]	URL gambar polos
`media_items`	Media[]	Item media dengan tipe dan varian video
`created_ms`	int	Kapan diunggah, ms sejak epoch
`url`	string	Tautan ke unggahan

Media

Satu gambar, video atau GIF. Video membawa MP4 dengan bitrate tertinggi yang bisa kami temukan; url adalah frame poster.

Bidang	Tipe	Arti
`type`	photo \| video \| animated_gif	Jenis media
`url`	string	URL gambar, atau frame poster dari video
`expanded_url`	string	Halaman media unggahan di X
`video_url`	string (video)	URL MP4, bitrate tertinggi yang tersedia
`bitrate`	int (video)	Bitrate MP4 tersebut
`duration_ms`	int (video)	Durasi video
`width`	int	Lebar asli dalam piksel
`height`	int	Tinggi asli dalam piksel

Artikel

Artikel X (unggahan bentuk panjang) yang ditautkan sebuah unggahan. Frame pertama membawa title dan preview; text bernilai null sampai update dengan id yang sama membawa artikel lengkap.

Bidang	Tipe	Arti
`id`	string	Id artikel
`title`	string	Judul
`preview`	string	Beberapa baris pertama artikel
`text`	string \| null	Teks lengkap, paragraf dipisahkan baris kosong; `null` di frame pertama
`cover`	string \| null	URL gambar sampul
`images`	string[]	Gambar di dalam artikel
`url`	string	Tautan ke artikel di X

Muatan penghapusan

d dari tweet.delete. Hanya pernah dikirim untuk unggahan yang pernah kami lihat dan kini telah hilang. ts-nya adalah saat penghapusan terdeteksi; waktu unggahan itu sendiri ada di frame create sebelumnya.

Bidang	Tipe	Arti
`tweet_id`	string	Id unggahan yang dihapus
`url`	string	Tempatnya dulu berada

Muatan perubahan profil

d dari setiap peristiwa profile.*. op bernilai update untuk semuanya.

Bidang	Tipe	Arti
`field`	string	Bidang profil mana yang berubah; kata yang sama seperti setelah `profile.` pada tipenya
`old`	any	Nilai sebelumnya
`new`	any	Nilai baru
`tweet`	Brief (pinned only)	Untuk `profile.pinned`: unggahan yang baru disematkan
`old_tweet`	Brief (pinned only)	Untuk `profile.pinned`: unggahan yang sebelumnya tersemat, jika kami memilikinya

Muatan pengikutan

d dari follow.add, follow.remove dan followers.verified.add.

Bidang	Tipe	Arti
`user`	User	Akun yang satunya, sebagai User lengkap

Muatan status akun

d dari account.status. Status adalah active, protected (unggahan hanya terlihat oleh pengikut yang disetujui), suspended (oleh X) atau unavailable (dinonaktifkan, dihapus, atau tidak terlihat karena alasan lain). ts adalah saat kami mendeteksi perubahan.

Bidang	Tipe	Arti
`old`	active \| protected \| suspended \| unavailable	Status sebelumnya
`new`	active \| protected \| suspended \| unavailable	Status sekarang
`reason`	string \| null	Kata-kata dari X, bila ada (misalnya `Suspended`)

User

Profil akun lengkap, seperti yang disematkan dalam peristiwa pengikutan dan dalam search.match.

Bidang	Tipe	Arti
`id`	string	Id numerik
`screen_name`	string	Handle
`name`	string	Nama tampilan
`bio`	string	Teks bio
`avatar`	string	URL gambar avatar
`banner`	string \| null	URL gambar banner
`followers`	int	Jumlah pengikut
`following`	int	Jumlah mengikuti
`tweets`	int	Jumlah unggahan
`location`	string	Lokasi dalam teks bebas
`url`	string \| null	Tautan profil yang diperluas
`verified`	bool	Memiliki lencana verifikasi
`verified_type`	string \| null	`blue`, `business`, `government` atau `null`
`protected`	bool	Unggahan hanya terlihat oleh pengikut yang disetujui
`created_at`	string (ISO-8601)	Kapan akun dibuat
`category`	string \| null	Kategori profesional, jika akun menyetelnya

Muatan kecocokan pencarian

d dari search.match: muatan Tweet ditambah tiga bidang tentang kecocokannya. target pada amplop adalah penulis unggahan, yang tidak harus salah satu target Anda.

Bidang	Tipe	Arti
`keyword.id`	int	Id kata kunci yang cocok
`keyword.query`	string	Kuerinya
`keyword.label`	string \| null	Labelnya, jika Anda menyetelnya
`author`	User	Profil lengkap penulis
`author_is_target`	bool	`true` jika penulis juga merupakan akun yang dipantau pada sistem ini
`…`	TweetPayload	Setiap bidang dari muatan Tweet

Target

Satu akun yang Anda pantau, sebagaimana dilihat oleh kunci ini.

Bidang	Tipe	Arti
`id`	string	Id numerik X. Tidak pernah berubah: jadikan kunci data Anda
`screen_name`	string	Handle saat ini. Bisa berubah; `profile.screen_name` memberi tahu Anda
`name`	string	Nama tampilan
`previous_screen_names`	string[]	Handle yang pernah dipakai akun, yang terbaru dulu. Masing-masing tetap bisa dipakai di `/v1/monitor/targets/{target}`
`push_ready`	bool	Semua jenis peristiwa yang Anda langgani untuk akun ini sedang dikumpulkan secara real-time. `false` tidak menahan apa pun: akun dipantau sejak saat dilanggani dan peristiwanya dikirim begitu terkumpul, jadi jangan menunggu flag ini sebelum menanganinya
`last_push_at`	datetime \| null	Terakhir kali peristiwa waktu nyata tiba untuknya
`last_poll_at`	datetime \| null	Terakhir kali linimasanya dibaca
`state`	"subscribed"	Selalu `subscribed` di sini; resolusi yang tertunda memiliki bentuknya sendiri
`event_types`	string[]	Tipe peristiwa yang dikirim untuk akun ini; kosong berarti semua yang diizinkan kunci Anda
`event_types_all`	bool	`true` jika `event_types` kosong

Target tertunda

Yang dikembalikan GET /v1/monitor/targets/{target} selagi akun yang Anda minta masih dicocokkan.

Bidang	Tipe	Arti
`screen_name`	string \| null	Handle yang Anda minta, bila meminta lewat handle
`user_id`	string \| null	Id pengguna yang Anda minta, bila meminta lewat id
`state`	"queued"	Selalu `queued`
`queued_at`	int (unix s)	Kapan Anda memintanya
`event_types`	string[]	Tipe peristiwa yang dipilih untuknya, berlaku setelah diselesaikan
`event_types_all`	bool	`true` jika `event_types` kosong

Kata kunci

Satu kueri yang Anda awasi di pencarian X.

Bidang	Tipe	Arti
`id`	int	Id numerik; gunakan untuk menghapus
`query`	string	Kuerinya, dalam sintaks pencarian X
`label`	string \| null	Label Anda, digemakan di setiap kecocokan
`active`	bool	`false` jika operator menjedanya
`hits`	int	Kecocokan yang sudah dikirim sejauh ini
`last_hit_at`	datetime \| null	Kecocokan terakhir
`last_run_at`	datetime \| null	Pencarian terakhir

Akun

Yang dikembalikan GET /v1/account tentang kunci yang Anda pakai.

Bidang	Tipe	Arti
`name`	string	Nama kunci, sebagaimana diterbitkan
`plan`	string	Preset paket
`key_id`	string	Id pendek kunci, aman disebutkan dalam permintaan dukungan
`scopes`	string[]	Cakupan yang dimiliki kunci
`event_types`	string[]	Daftar tipe peristiwa yang diizinkan untuk seluruh kunci, dikelola oleh kami; kosong berarti semua
`event_types_all`	bool	`true` saat filter kosong
`limits.max_targets`	int	Batas akun yang dipantau
`limits.max_conns`	int	Batas WebSocket bersamaan
`limits.max_keywords`	int	Batas kata kunci
`limits.requests_per_minute`	int	Kuota permintaan per menit
`usage.targets`	int	Akun yang saat ini dipantau
`usage.keywords`	int	Kata kunci yang saat ini diawasi

Webhook

Yang dikembalikan GET /v1/account/webhook.

Bidang	Tipe	Arti
`url`	string \| null	Endpoint yang terdaftar
`stats`	{ok, http_`…}`	Penghitung pengiriman: `ok`, dan satu `http_<code>` per status kegagalan yang pernah terlihat

Bidang	Tipe	Arti
`count`	int	Item di halaman ini
`has_more`	bool	Apakah ada halaman lain
`next_cursor`	string \| null	Kirimkan kembali sebagai `?cursor=`; `null` di akhir

Hasil batch

Satu entri per item yang dikirim ke POST /v1/monitor/targets:batch, dalam urutan yang sama.

Bidang	Tipe	Arti
`index`	int	Posisi item dalam permintaan Anda
`status`	int	Status HTTP yang akan dikembalikan endpoint item tunggal
`data`	object (on success)	Body respons item tunggal, saat berhasil
`error`	{code, message, details?} (on failure)	Objek kesalahan seperti biasa, saat gagal

Profil (baca)

Yang dikembalikan GET /v1/users/{screen_name}, /v1/users/by-id/{user_id} dan /v1/users/batch per akun.

Bidang	Tipe	Arti
`id`	string	Id numerik
`name`	string	Nama tampilan
`screen_name`	string	Handle
`bio`	string	Teks bio
`location`	string	Lokasi dalam teks bebas
`url`	string \| null	Tautan profil
`avatar`	string	URL gambar avatar
`banner`	string \| null	URL gambar banner
`pinned`	string \| null	Id unggahan tersemat
`verified`	bool	Memiliki lencana verifikasi
`protected`	bool	Unggahan hanya terlihat oleh pengikut yang disetujui
`followers`	int	Jumlah pengikut
`following`	int	Jumlah mengikuti
`tweets`	int	Jumlah unggahan

Tweet (baca)

Unggahan sebagaimana dikembalikan oleh endpoint pembacaan. Informasi yang sama dengan muatan Tweet, dalam bentuk lebih datar yang dihasilkan parser kami.

Bidang	Tipe	Arti
`id`	int	Id unggahan, numerik
`created_ms`	int	Kapan diunggah, ms sejak epoch
`user_id`	int	Id numerik penulis
`user`	string	Handle penulis
`name`	string	Nama tampilan penulis
`text`	string	Teks lengkap
`lang`	string \| null	Bahasa yang dideteksi X
`reply_to`	string \| null	Handle yang dibalas
`reply_to_status_id`	string \| null	Id unggahan yang dibalas
`reply_to_user_id`	string \| null	Id akun yang dibalas
`conversation_id`	string	Id unggahan akar dari utasnya
`is_rt`	bool	Merupakan unggahan ulang
`rt_of`	Brief \| null	Unggahan aslinya, untuk unggahan ulang
`is_quote`	bool	Mengutip unggahan lain
`quoted`	Brief \| null	Unggahan yang dikutip
`media`	string[]	URL gambar polos
`media_items`	Media[]	Item media dengan tipe dan varian video
`urls`	string[]	Tautan yang diperluas
`views`	int \| null	Jumlah tayangan
`counts`	{reply, rt, like, quote, bookmark}	Jumlah balasan, unggahan ulang, suka, kutipan dan markah
`article`	Article \| null	Artikel X yang ditautkan unggahan, bila ada (judul, pratinjau, sampul, gambar; teks lengkapnya di `GET /v1/tweets/{tweet_id}/article`)
`edit_of`	int \| null	Untuk versi yang disunting: id versi pertama; selain itu `null`
`edit_ids`	int[]	Id semua versi, yang terlama dulu; unggahan yang tak pernah disunting hanya mencantumkan dirinya sendiri
`source`	string \| null	Klien yang dipakai untuk mengunggah, sebagaimana diberikan X (tautan HTML, misalnya `Twitter for iPhone`)

Referensi pengguna

Bentuk ringkas yang dipakai dalam pembacaan daftar pengikutan.

Bidang	Tipe	Arti
`id`	string	Id numerik
`screen_name`	string	Handle
`name`	string	Nama tampilan