GET/api/v4/social/limits

Limits und Nutzung des Social-Tarifs abrufen

Gibt das Social-Verbindungslimit des Kontos und die Zahl abrechenbarer, aktiver und freigegebener Verbindungen im aktuellen Abrechnungszeitraum zurück.

Erfordert einen API-Schlüssel. Format des Headers und Schlüsselrotation finden Sie unter Authentifizierung.

Parameter

Dieser Endpunkt hat keine Parameter.

Antworten

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.

Zeigt, was Ihr Social-Tarif erlaubt und wie viel davon Sie bereits genutzt haben. Rufen Sie diese Informationen ab, bevor Sie einen Verbindungslink ausgeben, damit Sie einem Kunden mitteilen können, dass keine Kapazität mehr verfügbar ist, statt ihm einen SY95042 aus einem fehlgeschlagenen Schreibvorgang anzuzeigen.

FeldBedeutung
brandsMarkenkontingent. null in jedem API-Tarif, also unbegrenzt. Behandeln Sie null hier immer als "kein Limit", nicht als Null.
connectionsIm Abonnement enthaltene Verbindungen: das Kontingent der Tarifstufe zuzüglich aller gekauften Verbindungspakete.
maxConnectionsDas Limit, das beim Herstellen einer Verbindung tatsächlich durchgesetzt wird. In API-Tarifen entspricht es connections.
usersIm Tarif enthaltene Benutzerplätze.
aiCreditsIm aktuellen Zeitraum enthaltene Guthaben für die Inhaltserstellung.
usage.brandsAktuell vorhandene Marken. Nur zur Information – es gibt keinen Vergleichswert dafür.
usage.connectionsDie abrechenbare Anzahl und die einzige, auf die das Limit angewendet wird. Unterschiedliche Verbindungen, die zu irgendeinem Zeitpunkt im aktuellen Abrechnungszeitraum genutzt wurden: weiterhin verbundene sowie in diesem Zeitraum freigegebene Verbindungen. Vergleichen Sie diesen Wert mit maxConnections.
usage.connectionsActiveVerbindungen, die derzeit bestehen. Immer kleiner oder gleich usage.connections. Nützlich, um einem Kunden zu zeigen, was aktiv ist; dies ist nicht die Anzahl, die ihm in Rechnung gestellt wird.
usage.connectionsReleasedVerbindungen, die im aktuellen Abrechnungszeitraum getrennt wurden und deren Plätze weiterhin belegt bleiben. Diese Kapazität wird bei der Verlängerung wieder verfügbar.

usage.connections entspricht genau usage.connectionsActive + usage.connectionsReleased.

Ein freigegebener Platz bleibt bis zum Ende des Zeitraums belegt

Wenn Sie einen Kanal trennen, geht er sofort offline, aber der Platz wird dadurch nicht wieder verfügbar. Innerhalb eines Abrechnungszeitraums werden die unterschiedlichen Verbindungen, die Sie genutzt haben, auf das Limit angerechnet, unabhängig davon, ob sie noch bestehen. Deshalb bleibt der Platz bis zur Verlängerung des Abonnements verbraucht. Drei Konsequenzen, die Sie im Code berücksichtigen sollten:

  • Die verbleibende Kapazität beträgt maxConnections - usage.connections, niemals maxConnections - usage.connectionsActive. Wenn Sie die Anzahl der aktiven Verbindungen verwenden, zeigen Sie einem Kunden verfügbare Kapazität an, die er nicht hat, und der nächste Verbindungslink liefert SY95042 zurück.
  • Dasselbe Konto erneut mit derselben Marke zu verbinden, ist kostenlos. Wenn ein Kunde eine Seite erneut verbindet, die er zuvor im selben Zeitraum von dieser Marke getrennt hat, wird der bereits belegte Platz wiederverwendet: connectionsActive steigt, connectionsReleased sinkt und connections bleibt unverändert. Wird dieselbe Seite mit einer anderen Marke verbunden, belegt dies einen separaten Platz, und der ursprüngliche Platz bleibt bis zur Verlängerung belegt.
  • connectionsReleased ist Ihre Prognose für die Verlängerung. Der Wert gibt genau an, wie viele Plätze zu Beginn des nächsten Abrechnungszeitraums wieder im Pool verfügbar werden. Diesen Wert sollten Sie einem Kunden anzeigen, der entscheiden muss, ob er auf die Verlängerung wartet oder heute ein Paket kauft.

Dies entspricht dem übrigen Abrechnungsmodell: Gekaufte Kapazität ist sofort verfügbar, und Kapazität, auf die Sie verzichten, entfällt am Ende des Abrechnungszeitraums. Siehe Tarife und Zusatzpakete.

Anwendungsfall: eine Vorabprüfung in Ihrem Onboarding-Ablauf. Bevor Sie einem Kunden die Schaltfläche "Konto verbinden" anbieten, vergleichen Sie usage.connections – die abrechenbare Anzahl, nicht connectionsActive – mit maxConnections. Wenn keine Kapazität mehr verfügbar ist, zeigen Sie ihm die Möglichkeit für ein Zusatzpaket oder ein Upgrade an, statt POST /social/brands/{brandId}/connections/link fehlschlagen zu lassen. Für Marken gibt es keine entsprechende Prüfung: Beim Erstellen einer Marke mit POST /social/brands geht die Kapazität nie aus.

Anwendungsfall: den Umfang des nächsten Zusatzpakets bestimmen. Verbindungspakete werden in Fünferpaketen verkauft. Daher zeigt Ihnen maxConnections - usage.connections direkt, wie viele Netzwerke Sie noch verbinden können, und ceil((needed - headroom) / 5) gibt an, wie viele Pakete Sie kaufen müssen.

Hinweise.

  • Marken sind unbegrenzt und werden nicht nach Nutzung abgerechnet. Für listingsAPI-Konten wird brands als null zurückgegeben. Clientcode, der diesen Wert als ganzzahliges Limit behandelt hat, muss null verarbeiten können und sollte nicht "0 Marken verbleibend" anzeigen.
  • Verbindungen bilden einen kontoweiten Pool, kein Kontingent pro Marke. Eine Marke kann beliebig viele Verbindungen bis zu den fünf von ihr unterstützten Netzwerken haben, solange im Pool noch Kapazität verfügbar ist. Siehe Tarife und Zusatzpakete.
  • Dieser Endpunkt deckt ausschließlich das Social-Abonnement ab. Standortlimits gehören zum Listings-Abonnement und werden separat bei POST /locations durchgesetzt; dieser Endpunkt gibt SY10155 zurück, wenn das Konto überhaupt keinen Listings-Tarif hat.
  • Self-Service-Konten sind auf 250 Verbindungen begrenzt, unabhängig davon, wie viele Pakete gekauft werden. Für mehr Verbindungen muss das Konto zu Enterprise wechseln.
  • Freie Kapazität garantiert nicht, dass sich Instagram verbinden lässt. Instagram erlaubt nur ein Business- oder Creator-Konto, das mit einer Facebook-Seite verknüpft ist; ein persönliches Konto wird auf dem Zustimmungsbildschirm von Meta abgelehnt, nicht durch dieses Limit. Wenn ein Kunde hier noch Kapazität hat und der Verbindungslink für Instagram trotzdem fehlschlägt, muss das Konto umgewandelt werden; zusätzliche Kapazität hilft dabei nicht.
  • Die Zahlen sind aktuell, aber eine Freigabe ist keine Rückerstattung. Das Trennen mit disconnect oder das Archivieren einer Marke wird hier beim nächsten Abruf sichtbar – als Rückgang von usage.connectionsActive und entsprechender Anstieg von usage.connectionsReleased. usage.connections bleibt unverändert, weil der Platz bis zum Ende des Zeitraums belegt bleibt. Beide Freigabewege verhalten sich identisch.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/limits' \  -H "Authorization: API $LISTINGSAPI_KEY"