GET/api/v4/social/limits

Dapatkan batas dan penggunaan paket Social

Mengembalikan batas koneksi Social akun beserta penggunaan koneksi yang ditagihkan, aktif, dan dilepas untuk periode penagihan saat ini.

Memerlukan kunci API. Lihat Autentikasi untuk format header dan rotasi kunci.

Parameter

Endpoint ini tidak menerima parameter.

Respons

200The account's Social caps and current usage. `brands` is null because brands are unlimited on API plans. Here 118 connections are billable: 112 still connected, plus 6 disconnected during this period whose slots are held until renewal.
Response
{  "data": {    "fetchAccountLimits": {      "brands": null,      "connections": 135,      "maxConnections": 135,      "users": 10,      "aiCredits": 500,      "usage": {        "brands": 31,        "connections": 118,        "connectionsActive": 112,        "connectionsReleased": 6      }    }  }}
401Unauthenticated, missing or invalid API key.

Melaporkan kapasitas yang diizinkan oleh paket Social Anda dan seberapa banyak yang telah Anda gunakan. Periksa informasi ini sebelum menerbitkan tautan koneksi, agar Anda dapat memberi tahu pelanggan bahwa kapasitas mereka telah habis alih-alih menampilkan SY95042 akibat operasi tulis yang gagal.

FieldArti
brandsKuota merek. null pada setiap paket API, yang berarti tidak terbatas. Perlakukan setiap nilai null di sini sebagai "tanpa batas", bukan sebagai nol.
connectionsJumlah koneksi yang disertakan dalam langganan, yaitu kuota tingkat paket ditambah paket koneksi tambahan yang dibeli.
maxConnectionsBatas yang benar-benar diterapkan saat Anda menautkan koneksi. Pada paket API, nilainya sama dengan connections.
usersKuota pengguna yang disertakan dalam paket.
aiCreditsKredit pembuatan konten yang disertakan dalam periode saat ini.
usage.brandsMerek yang ada saat ini. Hanya sebagai informasi — tidak ada batas yang perlu dibandingkan dengan jumlah ini.
usage.connectionsJumlah yang ditagihkan, dan satu-satunya jumlah yang dikenai batas. Koneksi berbeda yang digunakan kapan pun selama periode penagihan saat ini: koneksi yang masih terhubung ditambah koneksi yang dilepas pada periode ini. Bandingkan jumlah ini dengan maxConnections.
usage.connectionsActiveKoneksi yang sedang terhubung saat ini. Selalu kurang dari atau sama dengan usage.connections. Berguna untuk menunjukkan kepada pelanggan koneksi yang aktif; bukan jumlah yang ditagihkan kepada mereka.
usage.connectionsReleasedKoneksi yang diputus selama periode penagihan saat ini dan slotnya masih ditahan. Kapasitas inilah yang kembali tersedia saat perpanjangan.

usage.connections sama persis dengan usage.connectionsActive + usage.connectionsReleased.

Slot yang dilepas tetap ditahan hingga periode berakhir

Memutus koneksi saluran langsung menonaktifkannya, tetapi tidak mengembalikan slotnya. Dalam satu periode penagihan, batas dihitung berdasarkan koneksi berbeda yang telah Anda gunakan, baik yang masih terhubung maupun tidak, sehingga slot tetap terpakai hingga langganan diperpanjang. Tiga konsekuensi yang perlu diperhitungkan dalam kode:

  • Sisa kapasitas adalah maxConnections - usage.connections, tidak pernah maxConnections - usage.connectionsActive. Menggunakan jumlah koneksi aktif akan membuat pelanggan diberi tahu bahwa masih ada kapasitas padahal tidak ada, dan tautan koneksi berikutnya akan mengembalikan SY95042.
  • Menautkan ulang akun yang sama ke merek yang sama tidak dikenai biaya. Jika pelanggan menghubungkan kembali Page yang sebelumnya mereka putus dari merek tersebut pada periode yang sama, koneksi itu menggunakan kembali slot yang masih ditahannya: connectionsActive bertambah, connectionsReleased berkurang, dan connections tidak berubah. Menautkan Page yang sama ke merek yang berbeda menggunakan slot terpisah, dan slot semula tetap ditahan hingga perpanjangan.
  • connectionsReleased adalah perkiraan Anda untuk perpanjangan. Nilai ini menunjukkan secara tepat berapa banyak slot yang kembali ke kumpulan kapasitas saat siklus berganti, dan itulah yang perlu ditampilkan kepada pelanggan yang sedang memutuskan antara menunggu perpanjangan dan membeli paket tambahan hari ini.

Pola ini sama dengan bagian lain dalam model penagihan: kapasitas yang Anda beli langsung tersedia, dan kapasitas yang Anda lepaskan baru dihapus pada akhir siklus. Lihat Paket dan tambahan.

Kasus penggunaan: pemeriksaan awal dalam alur orientasi pelanggan Anda. Sebelum menawarkan tombol "hubungkan akun" kepada pelanggan, bandingkan usage.connections — jumlah yang ditagihkan, bukan connectionsActive — dengan maxConnections. Jika tidak ada sisa kapasitas, tampilkan opsi tambahan atau peningkatan paket alih-alih membiarkan POST /social/brands/{brandId}/connections/link gagal. Tidak ada pemeriksaan serupa untuk merek: pembuatan merek dengan POST /social/brands tidak pernah kehabisan kapasitas.

Kasus penggunaan: menentukan jumlah paket tambahan berikutnya. Paket koneksi dijual dengan isi lima koneksi per paket, sehingga maxConnections - usage.connections langsung menunjukkan berapa banyak jaringan yang masih dapat Anda hubungkan, dan ceil((needed - headroom) / 5) adalah jumlah paket yang perlu dibeli.

Catatan.

  • Merek tidak dibatasi dan penggunaannya tidak dihitung. brands dikembalikan dengan nilai null untuk akun listingsAPI. Kode klien yang sebelumnya memperlakukannya sebagai batas berupa bilangan bulat harus menangani null, dan sebaiknya tidak menampilkan "tersisa 0 merek".
  • Koneksi menggunakan kumpulan kapasitas bersama dalam satu akun, bukan kuota per merek. Satu merek dapat memiliki koneksi sebanyak yang Anda inginkan, hingga lima jaringan yang didukungnya, selama masih ada ruang dalam kumpulan kapasitas tersebut. Lihat Paket dan tambahan.
  • Endpoint ini hanya mencakup langganan Social. Batas lokasi merupakan bagian dari langganan Listings dan diterapkan secara terpisah di POST /locations, yang mengembalikan SY10155 ketika akun sama sekali tidak memiliki paket Listings.
  • Akun layanan mandiri dibatasi hingga 250 koneksi, berapa pun jumlah paket tambahan yang dibeli. Untuk melampaui batas tersebut, akun harus beralih ke Enterprise.
  • Kapasitas yang tersisa tidak menjamin Instagram dapat terhubung. Instagram hanya mengizinkan akun Business atau Creator yang ditautkan ke Facebook Page; akun pribadi ditolak pada layar persetujuan Meta, bukan oleh batas ini. Jika pelanggan masih memiliki kapasitas di sini dan tautan koneksi tetap gagal untuk Instagram, jenis akun tersebut perlu diubah, bukan kapasitasnya yang perlu ditambah.
  • Angka-angka ini diperbarui secara langsung, tetapi pelepasan bukanlah pengembalian dana. Pemutusan koneksi dengan disconnect, atau pengarsipan merek, tercermin di sini pada pembacaan berikutnya — berupa penurunan usage.connectionsActive dan kenaikan usage.connectionsReleased dengan jumlah yang sama. usage.connections tidak berubah karena slot ditahan hingga periode berakhir. Kedua cara pelepasan tersebut memiliki perilaku yang sama.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/limits' \  -H "Authorization: API $LISTINGSAPI_KEY"