Massenauszug von Blei

Referenz zum Massenextraktionsendpunkt von Leads

Die REST-APIs für die Lead-Extraktion in Batches rufen große Mengen von Lead-/Personen-Datensätzen aus Marketo ab. Sie können Leads auch inkrementell basierend auf dem Erstellungsdatum des Datensatzes, der letzten Aktualisierung, der statischen Mitgliedschaft in der Liste oder der Smart-Listen-Mitgliedschaft abrufen.

Verwenden Sie Lead-Massenextraktion für den kontinuierlichen Datenaustausch zwischen Marketo und externen Systemen, einschließlich ETL, Data Warehousing und Archivierungs-Workflows.

Berechtigungen

Der API-Benutzer, dem der Auftrag gehört, muss über eine Rolle mit der Berechtigung „Schreibgeschützter Lead“, der Berechtigung „Lese-/Schreib-Lead“ oder beiden verfügen.

Filter

Lead-Exportvorgänge unterstützen mehrere Filtertypen. Jeder Exportvorgang kann nur einen Filtertyp verwenden.

Die updatedAt-, smartListName- und smartListId erfordern eine Infrastruktur, die nicht in allen Abonnements verfügbar ist.

Die mit einem Sternchen gekennzeichneten Filtertypen sind für einige Abonnements nicht verfügbar. Wenn für Ihr Abonnement kein Filtertyp verfügbar ist, gibt der Endpunkt Exportleitungs-Auftrag erstellen den Fehler „1035, Nicht unterstützter Filtertyp für Zielabonnement“ zurück. Wenden Sie sich an den Marketo-Support, um diese Funktion für Ihr Abonnement zu aktivieren.

Optionen

Der Endpunkt Exportvorgang erstellen bietet Optionen zum Auswählen exportierter Felder, Umbenennen von Spaltenüberschriften und Festlegen des Dateiformats.

Erstellen von Aufträgen

Verwenden Sie den Endpunkt Exportvorgang erstellen um einen Exportvorgang zu definieren. Geben Sie die zu exportierende fields, einen filter und dessen Parameter, den format und alle benutzerdefinierten Spaltenkopfzeilennamen an.

POST /bulk/v1/leads/export/create.json

{
   "fields": [
      "firstName",
      "lastName",
      "id",
      "email"
   ],
   "format": "CSV",
   "columnHeaderNames": {
      "firstName": "First Name",
      "lastName": "Last Name",
      "id": "Marketo Id",
      "email": "Email Address"
   },
   "filter": {
      "createdAt": {
         "startAt": "2017-01-01T00:00:00Z",
         "endAt": "2017-01-31T00:00:00Z"
      }
   }
}

Diese Anfrage erstellt einen Exportvorgang für Leads, die zwischen dem 1. Januar 2017 und dem 31. Januar 2017 erstellt wurden. Der Export enthält Werte aus den Feldern firstName, lastName, id und email.

{
   "requestId": "e42b#14272d07d78",
   "success": true,
   "result": [
      {
         "exportId": "ce45a7a1-f19d-4ce2-882c-a3c795940a7d",
         "status": "Created",
         "createdAt": "2017-01-21T11:47:30-08:00",
         "queuedAt": "2017-01-21T11:48:30-08:00",
         "format": "CSV"
      }
   ]
}

Die Antwort bestätigt, dass der Auftrag erstellt, aber nicht gestartet wurde. Um den Auftrag zu starten, rufen Sie den Endpunkt Exportvorgang in Warteschlange stellen mit dem exportId aus der Erstellungsantwort auf.

POST /bulk/v1/leads/export/{exportId}/enqueue.json

{
    "requestId": "147e4#16b24d9b913",
    "result": [
        {
            "exportId": "fad2cd1b-e822-4025-be1e-9caa9cf1d4b8",
            "format": "CSV",
            "status": "Queued",
            "createdAt": "2019-06-04T23:35:43Z",
            "queuedAt": "2019-06-04T23:36:17Z"
        }
    ],
    "success": true
}

Die Enqueue-Antwort weist den status „In Warteschlange“ auf. Sobald ein Exportsteckplatz verfügbar ist, wechselt der Status zu „Verarbeitung läuft“.

Status des Abrufauftrags

Sie können den Status nur für Aufträge abrufen, die von demselben API-Benutzer erstellt wurden.

Lead-Exportvorgänge werden asynchron ausgeführt. Abfrage ​ Endpunkts „Exportstatus des Leads abrufen, um den Fortschritt des Auftrags zu verfolgen.

Der Status wird nur einmal alle 60 Sekunden aktualisiert. Führen Sie keine häufigeren Befragungen durch; in fast allen Fällen ist dieses Intervall immer noch zu lang.

GET /bulk/v1/leads/export/{exportId}/status.json

{
   "requestId": "e42b#14272d07d78",
   "success": true,
   "result": [
      {
         "exportId": "ce45a7a1-f19d-4ce2-882c-a3c795940a7d",
         "status": "Processing",
         "createdAt": "2017-01-21T11:47:30-08:00",
         "queuedAt": "2017-01-21T11:48:30-08:00",
         "format": "CSV"
      }
   ]
}

Diese Antwort zeigt an, dass der Auftrag noch verarbeitet wird, sodass die Datei nicht verfügbar ist. Wenn sich der Auftragsstatus in „Abgeschlossen“ ändert, kann die Datei heruntergeladen werden.

Das status kann einen der folgenden Werte zurückgeben:

Daten abrufen

Um einen abgeschlossenen Lead-Export abzurufen, rufen Sie den Endpunkt Lead- abrufen) mit dem exportId auf.

GET /bulk/v1/leads/export/{exportId}/file.json

Der Antworttext enthält die Datei im für den Auftrag konfigurierten Format.

Wenn ein angefordertes Lead-Feld keine Daten enthält, enthält das entsprechende Feld in der Exportdatei null. Im folgenden Beispiel hat der zurückgegebene Lead ein leeres E-Mail-Feld.

firstName,lastName,email,cookies
Russell,Wilson,null,_mch-localhost-1536605780000-12105

Für den teilweisen oder wiederholbaren Abruf unterstützt der Dateiendpunkt den optionalen HTTP-Range-Header mit dem bytes. Wenn Sie die -Kopfzeile nicht festlegen, gibt der Endpunkt den gesamten Inhalt zurück. Erfahren Sie mehr über die Verwendung des Range-Headers mit Marketo Massenextraktion.

Abbrechen von Aufträgen

Um einen falsch konfigurierten oder unnötigen Auftrag abzubrechen, rufen Sie den Endpunkt Exportleadauftrag abbrechen auf.

POST /bulk/v1/leads/export/{exportId}/cancel.json

{
   "requestId": "e42b#14272d07d78",
   "success": true,
   "result": [
      {
         "exportId": "ce45a7a1-f19d-4ce2-882c-a3c795940a7d",
         "status": "Cancelled",
         "createdAt": "2017-01-21T11:47:30-08:00",
         "format": "CSV"
      }
   ]
}

Die Antwort bestätigt, dass der Vorgang abgebrochen wurde.