GET/api/v4/social/limits

Obter limites e uso do plano Social

Retorna o limite de conexões Social da conta junto com o uso de conexões faturáveis, ativas e liberadas no período de faturamento atual.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Este endpoint não recebe parâmetros.

Respostas

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.

Informa o que seu plano Social permite e quanto você já utilizou. Consulte essas informações antes de emitir um link de conexão para poder avisar ao cliente que ele está sem capacidade disponível, em vez de exibir um SY95042 resultante de uma falha de gravação.

CampoSignificado
brandsLimite de marcas. null em todos os planos de API, o que significa ilimitado. Trate qualquer null aqui como "sem limite", e não como zero.
connectionsConexões incluídas na assinatura: as do nível contratado mais as de quaisquer pacotes de conexões comprados.
maxConnectionsO limite efetivamente aplicado quando você vincula uma conexão. Nos planos de API, ele é igual a connections.
usersVagas de usuários incluídas no plano.
aiCreditsCréditos de geração de conteúdo incluídos no período atual.
usage.brandsMarcas existentes hoje. Apenas informativo — não há um limite com o qual comparar esse número.
usage.connectionsA contagem faturável, e a única à qual o limite se aplica. Conexões distintas usadas em qualquer momento do período de faturamento atual: as que continuam conectadas mais as liberadas neste período. Compare esse valor com maxConnections.
usage.connectionsActiveConexões que estão conectadas agora. Sempre menor ou igual a usage.connections. Útil para mostrar ao cliente o que está ativo; não é o número pelo qual ele é cobrado.
usage.connectionsReleasedConexões desconectadas durante o período de faturamento atual cujas vagas continuam reservadas. Essa é a capacidade que volta a ficar disponível na renovação.

usage.connections é exatamente usage.connectionsActive + usage.connectionsReleased.

Uma vaga liberada permanece reservada até o fim do período

Desconectar um canal o coloca offline imediatamente, mas não devolve a vaga. Dentro de um período de faturamento, o limite contabiliza as conexões distintas que você usou, estejam elas ainda conectadas ou não, portanto a vaga continua consumida até a renovação da assinatura. Três consequências a considerar no código:

  • A capacidade disponível é maxConnections - usage.connections, nunca maxConnections - usage.connectionsActive. Usar a contagem de conexões ativas fará você informar ao cliente que ele tem uma capacidade que não tem, e o próximo link de conexão retornará SY95042.
  • Vincular novamente a mesma conta à mesma marca não tem custo. Se um cliente reconectar uma Página que desconectou daquela marca anteriormente no período, ela reutilizará a vaga que já mantém reservada: connectionsActive aumenta, connectionsReleased diminui e connections não muda. Vincular essa mesma Página a uma marca diferente ocupa uma vaga separada, e a original permanece reservada até a renovação.
  • connectionsReleased é sua previsão para a renovação. É exatamente o número de vagas que voltam ao conjunto compartilhado quando o ciclo muda, e é isso que você deve mostrar a um cliente que está decidindo entre esperar pela renovação e comprar um pacote hoje.

Isso segue a mesma lógica do restante do modelo de faturamento: a capacidade que você compra fica disponível imediatamente, e a capacidade da qual você abre mão é removida ao fim do ciclo. Consulte Planos e complementos.

Caso de uso: uma verificação prévia no seu fluxo de integração inicial. Antes de oferecer ao cliente o botão "conectar uma conta", compare usage.connections — a contagem faturável, e não connectionsActive — com maxConnections. Se não houver capacidade disponível, mostre a opção de complemento ou de mudança para um plano superior, em vez de deixar POST /social/brands/{brandId}/connections/link falhar. Não há uma verificação equivalente para marcas: a criação de uma marca com POST /social/brands nunca fica sem capacidade disponível.

Caso de uso: dimensionar o próximo complemento. Os pacotes de conexões são vendidos em grupos de 5, portanto maxConnections - usage.connections informa diretamente quantas redes você ainda pode conectar, e ceil((needed - headroom) / 5) é a quantidade de pacotes a comprar.

Observações.

  • As marcas são ilimitadas e não estão sujeitas à medição de uso. brands retorna null para contas listingsAPI. O código cliente que tratava esse valor como um limite inteiro deve lidar com null e não deve exibir "0 marcas restantes".
  • As conexões formam um conjunto compartilhado por toda a conta, e não uma cota por marca. Uma marca pode ter quantas conexões você quiser, até o limite das 5 redes que ela suporta, desde que haja capacidade no conjunto compartilhado. Consulte Planos e complementos.
  • Este endpoint cobre apenas a assinatura Social. Os limites de locais pertencem à assinatura Listings e são aplicados separadamente em POST /locations, que retorna SY10155 quando a conta não tem nenhum plano Listings.
  • Contas de autoatendimento têm um limite de 250 conexões, independentemente de quantos pacotes sejam comprados. Acima disso, a conta precisa migrar para o Enterprise.
  • Ter capacidade disponível não garante que o Instagram será conectado. O Instagram só permite uma conta Business ou Creator vinculada a uma Página do Facebook; uma conta pessoal é recusada na tela de consentimento da Meta, e não por esse limite. Se um cliente tiver capacidade disponível aqui e o link de conexão ainda falhar para o Instagram, a conta precisa ser convertida, em vez de receber mais capacidade.
  • Os números são atualizados em tempo real, mas uma liberação não é um reembolso. A desconexão com disconnect ou o arquivamento de uma marca se reflete aqui na próxima leitura — como uma redução em usage.connectionsActive e um aumento correspondente em usage.connectionsReleased. usage.connections permanece inalterado, porque a vaga fica reservada até o fim do período. As duas formas de liberação se comportam de maneira idêntica.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/limits' \  -H "Authorization: API $LISTINGSAPI_KEY"