Extraheren voor bulklood

​ BulkLood Extraheren Verwijzing Eindpunt van het Eindpunt ​

De reeks van het Uittreksel van de Leiding van het Bulk van REST APIs verstrekt een programmatic interface voor het terugwinnen van grote reeksen lood/persoonverslagen uit Marketo. Deze kan ook worden gebruikt om incrementeel leads op te halen op basis van de gemaakte datum van de record, de meest recente update, het lidmaatschap van een statische lijst of het lidmaatschap van een slimme lijst. De aanbevolen interface voor gebruiksgevallen die een continue uitwisseling van gegevens tussen Marketo en een of meer externe systemen vereisen, voor ETL-, data warehousing- en archiefdoeleinden.

Machtigingen

De Bulk Lood Extraheren APIs vereist dat de het bezitten API gebruiker een rol met één of allebei van de read-Only lood, of lees-schrijf lood toestemmingen heeft.

Filters

Leads ondersteunen verschillende filteropties. Voor bepaalde filters, zoals updatedAt , smartListName en smartListId , zijn extra infrastructuurcomponenten nodig die nog niet voor alle abonnementen zijn geïmplementeerd. Per exporttaak kan slechts één filtertype worden opgegeven.

Filtertype is niet beschikbaar voor alle abonnementen. Als deze optie niet beschikbaar is voor uw abonnement, wordt een fout weergegeven wanneer u het eindpunt Taak voor lead exporteren aanroept ("1035, Niet-ondersteund filtertype voor doelabonnement"). Klanten kunnen contact opnemen met Marketo Support om deze functionaliteit in hun abonnement te laten inschakelen.

Opties

Het eindpunt van de Taak van de Lood van de Uitvoer van de Create verstrekt verscheidene formatterende opties, die de gebruiker de capaciteit geven om bepaalde gebieden binnen het uitgevoerde dossier, de capaciteit te omvatten om kolomkopballen van deze gebieden anders te noemen, en het formaat van het uitgevoerde dossier.

Een taak maken

De parameters voor de baan worden bepaald alvorens de uitvoer te schoppen gebruikend ​ creeer het eindpunt van de Baan van de Uitvoer ​. We moeten definiëren welke fields nodig is voor het exporteren, het type parameters van filter , de format van het bestand en de namen van kolomkoppen, indien van toepassing.

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"
      }
   }
}

Met dit verzoek wordt een reeks leads geëxporteerd die zijn gemaakt tussen 1 januari 2017 en 31 januari 2017, inclusief de waarden van de overeenkomende velden firstName , lastName , id en 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"
      }
   ]
}

Dit retourneert een statusreactie die aangeeft dat de taak is gemaakt. De taak is gedefinieerd en gemaakt, maar is nog niet uitgeschakeld. Om dit te doen, moet het ​ eindpunt van de Baan van de Uitvoer van 0} Enqueue het Lood van de Lijn worden geroepen gebruikend exportId van de reactie van de aanmaakstatus:

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
}

Dit reageert met een status van "In wachtrij" waarna deze wordt ingesteld op "Verwerken" wanneer er een beschikbare exportsleuf is.

Status opiniepeilingtaak

Note: De status kan alleen worden opgehaald voor taken die door dezelfde API-gebruiker zijn gemaakt.

Aangezien dit een asynchroon eindpunt is, moeten wij na het creëren van de baan zijn status onderzoeken om zijn vooruitgang te bepalen. Opiniepeiling die ​ gebruikt krijgt de Status van de Taak van de Lood van de Uitvoer ​ eindpunt. De status wordt slechts eenmaal om de 60 seconden bijgewerkt, dus een lagere stemfrequentie dan dit wordt aanbevolen, en in bijna alle gevallen is dit nog steeds buitensporig. Laten we even kijken naar de opiniepeiling.

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"
      }
   ]
}

Het statuseindpunt antwoordt erop wijzend dat de baan nog verwerkt, zodat is het dossier nog niet beschikbaar voor terugwinning. Nadat de taakstatus is gewijzigd in "Voltooid", wordt de taak voorbereid voor downloaden.

Het statusveld kan reageren op:

Uw gegevens ophalen

Om het dossier van een voltooide looduitvoer terug te winnen, roep eenvoudig het ​ krijgen het 1} eindpunt van het Dossier van de Lood van de Uitvoer {met uw ​.exportId

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

De reactie bevat een bestand dat is opgemaakt op de manier waarop de taak is geconfigureerd. Het eindpunt antwoordt met de inhoud van het dossier.

Als een gevraagd lead-veld leeg is (geen gegevens bevat), wordt null in het corresponderende veld in het exportbestand geplaatst. In het onderstaande voorbeeld is het e-mailveld voor de geretourneerde lead leeg.

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

Om gedeeltelijke en hervattingsvriendelijke herwinning van gehaalde gegevens te steunen, steunt het dossiereindpunt naar keuze de de kopbalWaaier van HTTP van de typebytes. Als de header niet is ingesteld, wordt de gehele inhoud geretourneerd. Lees meer over het gebruiken van de kopbal van de Waaier met Marketo ​ Bulk Extraheren ​.

Een taak annuleren

Als een baan verkeerd werd gevormd, of onnodig wordt, kan het gemakkelijk worden geannuleerd gebruikend het ​ annuleert de Uitvoer ​ eindpunt van de Lood van de Uitvoer:

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"
      }
   ]
}

Dit reageert met een status die aangeeft dat de taak is geannuleerd.