v1Recursos/Locations/getObter resumo de localizações
Obter resumo de localizações
Retorna a contagem agregada de localizações de toda a sua agência (ou de um cliente), detalhada por status, nível de pacote e status de verificação.
get
locations:read/api/v1/locations/summaryParâmetros de consulta
clientIdstringopcional
Limita às localizações de um cliente. Se omitido, resume todas as localizações que sua chave pode ver. Procure com GET /api/v1/clients.
tagsstringopcional
Limita a localizações com qualquer uma destas tags internas separadas por vírgula.
Resposta
dataobjectopcional
totalnumberopcional
Número total de localizações correspondentes.
byStatusobjectopcional
Contagem de localizações agrupada por status.
byVerificationobjectopcional
Contagem de localizações agrupada por status de verificação.
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/locations/summary
Sua chave de API
clientId
tags
{
"data": {
"total": 12,
"byStatus": {
"approved": 10,
"pending_verification": 1,
"archival_pending": 1
},
"byVerification": {
"verified": 9,
"pending": 1,
"unknown": 2
}
}
}