Synupv1
Schlüssel erstellen
v1Ressourcen/Review Invites/getKampagnen auflisten

Kampagnen auflisten

Listet die Review-Invite-Kampagnen eines Standorts auf, neueste zuerst.

get/api/v1/review-invites/campaigns
review-invite:read
Query-Parameter
locationIdstringerforderlich
Der Standort, dessen Kampagnen aufgelistet werden. Erforderlich.
pageintegeroptional
Nullbasierte Seitenzahl. Standardmäßig 0.
statusstring (all | draft | launched | stopped | archived)optional
Nach Status filtern. Standardmäßig all.
Antwort
dataobjectoptional
campaignsarray of unknownoptional
Die passenden Kampagnen.
totalnumberoptional
Gesamtzahl der zu den Filtern passenden Kampagnen.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/review-invites/campaigns
Ihr API-Schlüssel
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
  }
}