v1Recursos/Espacio de trabajo/getObtener resumen del espacio de trabajo
Obtener resumen del espacio de trabajo
Devuelve una instantánea agregada de toda tu agencia: total de clientes, más estadísticas consolidadas de ubicaciones, reseñas y SEO.
get
workspace:read/api/v1/workspace/summaryRespuesta
dataobjectopcional
clientsnumberopcional
Número total de clientes en tu agencia.
locationsobjectopcional
Estadísticas agregadas de ubicaciones de todos los clientes.
reviewsobjectopcional
Estadísticas agregadas de reseñas de todos los clientes.
seoobjectopcional
Estadísticas agregadas de posicionamiento SEO de todos los clientes.
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/workspace/summary
Su clave 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
}
}
}Guías que usan este endpoint
- How to Manage Thousands of Business Locations via APIDesign a sync job for thousands of locations on the Synup API with cursor pagination, tags, rate-limit handling, an id map and rollup health checks.
- How to Build a White-Label Local Marketing PlatformBuild a multi-tenant white-label local marketing platform on the API, with client provisioning, team access, per-client summaries and scoped API keys.