Synup
Criar chave
v1Recursos/Listagens publicadas/getObter a listagem de um local

Obter a listagem de um local

Retorna o status de sincronização entre publishers, o status do perfil do Google Business e oportunidades de melhoria para um local.

get/api/v1/listings
listings:read
Parâmetros de consulta
locationIdstringobrigatório
O local a ser consultado. Obrigatório. Procure com GET /api/v1/locations.
clientIdstringopcional
O cliente do local. Necessário apenas para desambiguar quando sua chave está limitada a clientes específicos.
Resposta
dataobjectopcional
statsobjectopcional
Números resumidos de todos os publishers deste local.
publishersnumberopcional
Número total de publishers monitorados.
syncednumberopcional
Número de publishers atualmente sincronizados.
notConnectednumberopcional
Número de publishers ainda não conectados.
googleVerifiedLocationsnumberopcional
Número de locais verificados pelo Google.
duplicatesnumberopcional
Número de listagens duplicadas detectadas.
connectionIssuesnumberopcional
Número de publishers com problema de conexão.
requiresActionnumberopcional
Número de publishers que exigem uma ação.
publishersarray of objectopcional
Status de sincronização por publisher.
publisherIdstringopcional
Identificador do diretório/publisher.
publisherNamestringopcional
Nome de exibição do publisher.
statusstring (synced | in_progress | failed | requires_action | not_connected | expired | suspended | pending_approval | inaccessible | credentials_invalidated | not_available)opcional
Um de: synced, in_progress, failed, requires_action, not_connected, expired, suspended, pending_approval, inaccessible, credentials_invalidated, not_available.
liveLinksnumberopcional
Número de links ativos encontrados para este publisher, ou null.
gbpobjectopcional
Resumo do perfil do Google Business, quando conectado.
connectedbooleanopcional
Se um perfil do Google Business está conectado.
scorenumberopcional
Pontuação de completude do perfil, de 0 a 100, ou null.
donearray of stringopcional
Itens de melhoria do perfil já concluídos.
todoarray of stringopcional
Itens de melhoria do perfil pendentes.
opportunitiesarray of objectopcional
Melhorias sugeridas, cada uma com uma mensagem curta e um tom.
textstringopcional
tonestring (amber | rose | blue | zinc)opcional
aiobjectopcional
Um breve título gerado por IA e até 3 correções priorizadas para este local, ou null.
headlinestringopcional
Resumo de uma frase sobre a saúde das listagens deste local.
fixFirstarray of objectopcional
Até 3 ações sugeridas, classificadas por impacto.
textstringopcional
impactstring (High | Med | Low)opcional
noticestringopcional
Um aviso legível sobre os dados de listagens deste local, ou null.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/listings
Sua chave de API
locationId *
clientId
{
  "data": {
    "stats": {
      "publishers": 42,
      "synced": 38,
      "notConnected": 2,
      "googleVerifiedLocations": 1,
      "duplicates": 0,
      "connectionIssues": 1,
      "requiresAction": 1
    },
    "publishers": [
      {
        "publisherId": "google",
        "publisherName": "Google",
        "status": "synced",
        "liveLinks": 1
      }
    ],
    "gbp": {
      "connected": true,
      "score": 82,
      "done": [
        "Business name",
        "Address"
      ],
      "todo": [
        "Add photos"
      ]
    },
    "opportunities": [
      {
        "text": "Add more photos to your Google profile",
        "tone": "amber"
      }
    ],
    "ai": {
      "headline": "90% synced — 1 listing needs action.",
      "fixFirst": [
        {
          "text": "Reconnect 1 listing needing action.",
          "impact": "High"
        }
      ]
    },
    "notice": null
  }
}

Guias que usam este endpoint