Synupv1
Criar chave
v1Recursos/Review Invites/getListar campanhas

Listar campanhas

Lista as campanhas de convite para avaliação de um local, mais recentes primeiro.

get/api/v1/review-invites/campaigns
review-invite:read
Parâmetros de consulta
locationIdstringobrigatório
O local cujas campanhas serão listadas. Obrigatório.
pageintegeropcional
Número da página, começando em 0. O padrão é 0.
statusstring (all | draft | launched | stopped | archived)opcional
Filtrar por status. O padrão é all.
Resposta
dataobjectopcional
campaignsarray of unknownopcional
As campanhas correspondentes.
totalnumberopcional
Número total de campanhas correspondentes aos filtros.
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/review-invites/campaigns
Sua chave de API
locationId *
page
status
{
  "data": {
    "rows": [
      {
        "id": "cm_campaign_1",
        "name": "Spring Checkup Follow-up",
        "type": "email_sms",
        "collectMode": "directory",
        "status": "draft",
        "archived": false,
        "locationLabel": "Acme Dental — Downtown · Austin",
        "emailsSent": 0,
        "smsSent": 0,
        "repliesCount": 0,
        "clickRate": null,
        "followUpSent": 0,
        "autoSend": true,
        "yelpCompliant": true,
        "staticUrl": null
      }
    ],
    "total": 1
  }
}