Synup
Criar chave
v1Recursos/Espaço de trabalho/getObter resumo do espaço de trabalho

Obter resumo do espaço de trabalho

Retorna um retrato agregado de toda a sua agência: total de clientes, mais estatísticas consolidadas de localizações, avaliações e SEO.

get/api/v1/workspace/summary
workspace:read
Resposta
dataobjectopcional
clientsnumberopcional
Número total de clientes na sua agência.
locationsobjectopcional
Estatísticas agregadas de localizações de todos os clientes.
reviewsobjectopcional
Estatísticas agregadas de avaliações de todos os clientes.
seoobjectopcional
Estatísticas agregadas de ranking de SEO de todos os clientes.
Erros
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/workspace/summary
Sua chave de API
{
  "data": {
    "clients": 24,
    "locations": {
      "total": 31,
      "byStatus": {
        "approved": 27,
        "archival_pending": 2,
        "pending": 2
      },
      "byVerification": {
        "verified": 22,
        "unverified": 6,
        "unknown": 3
      }
    },
    "reviews": {
      "avgRating": 4.4,
      "total": 1280
    },
    "seo": {
      "avgRank": 5.1,
      "top3Pct": 38
    }
  }
}

Guias que usam este endpoint