Synupv1
Crear clave
v1Recursos/Review Invites/getListar campañas

Listar campañas

Enumera las campañas de invitación a reseñas de una ubicación, de la más reciente a la más antigua.

get/api/v1/review-invites/campaigns
review-invite:read
Parámetros de consulta
locationIdstringobligatorio
La ubicación cuyas campañas se van a listar. Obligatorio.
pageintegeropcional
Número de página, empezando en 0. El valor predeterminado es 0.
statusstring (all | draft | launched | stopped | archived)opcional
Filtrar por estado. El valor predeterminado es all.
Respuesta
dataobjectopcional
campaignsarray of unknownopcional
Las campañas que coinciden.
totalnumberopcional
Número total de campañas que coinciden con los filtros.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
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.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/review-invites/campaigns
Su clave 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
  }
}