Bulkladsextrahering

Referens för extrahering av slutpunkt i grupplead

Uppsättningen REST API:er för Bulk Lead Extract utgör ett programmatiskt gränssnitt för att hämta stora uppsättningar lead-/personposter från Marketo. Den kan också användas för att hämta leads inkrementellt baserat på postens skapandedatum, senaste uppdatering, statiskt listmedlemskap eller smart listmedlemskap. Det rekommenderade gränssnittet för användningsfall som kräver kontinuerligt datautbyte mellan Marketo och ett eller flera externa system för ETL, datalagerhantering och arkivering.

Behörigheter

API:erna för extrahering av grupplead kräver att den ägande API-användaren har en roll med en eller båda behörigheterna för skrivskyddad lead eller skrivskyddad lead.

Filter

Leads har stöd för olika filteralternativ. Vissa filter, bland annat updatedAt, smartListName och smartListId, kräver ytterligare infrastrukturkomponenter som ännu inte har lanserats för alla prenumerationer. Endast en filtertyp kan anges per exportjobb.

Filtertypen är inte tillgänglig för vissa prenumerationer. Om du inte är tillgänglig för din prenumeration får du ett felmeddelande när du anropar slutpunkten Skapa Lead-jobb ("1035, filtertypen stöds inte för målprenumerationen"). Kunder kan kontakta Marketo Support för att aktivera den här funktionen i prenumerationen.

Alternativ

Slutpunkten Skapa exportlead-jobb innehåller flera formateringsalternativ som gör att användaren kan ta med särskilda fält i den exporterade filen, ändra namn på kolumnrubriker i dessa fält och formatet för den exporterade filen.

Skapa ett jobb

Parametrarna för jobbet definieras innan exporten avbryts med slutpunkten Skapa exporthuvudjobb. Vi måste definiera de fields som behövs för export, parametertypen för filter, format för filen och kolumnrubriknamnen, om det finns några.

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

Denna begäran börjar exportera en uppsättning leads som skapats mellan 1 januari 2017 och 31 januari 2017, inklusive värdena från motsvarande firstName-, lastName-, id- och email-fält.

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

Detta returnerar ett statussvar som anger att jobbet har skapats. Jobbet har definierats och skapats, men har ännu inte startats. Om du vill göra det måste slutpunkten Enqueue Export Lead Job anropas med exportId från svaret på status när projektet skapades:

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
}

Detta svarar med status i kö, varefter det ställs in på Bearbetning när det finns en tillgänglig exportplats.

Avsökningsjobbstatus

Status för Note: kan bara hämtas för jobb som har skapats av samma API-användare.

Eftersom det här är en asynkron slutpunkt måste vi avfråga status när vi har skapat jobbet för att avgöra hur det förlöper. Avsök med slutpunkten Hämta status för Lead-jobb. Statusen uppdateras endast en gång var 60:e sekund, så en lägre avsökningsfrekvens rekommenderas inte och är i nästan alla fall fortfarande för hög. Låt oss ta en snabb titt på enkäten.

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

Statusslutpunkten svarar som anger att jobbet fortfarande bearbetas, så filen är inte tillgänglig för hämtning än. När jobbstatusen ändras till"Slutfört" förbereds den för hämtning.

Statusfältet kan svara med något av följande:

Hämtar data

Om du vill hämta filen för en slutförd leadexport anropar du Get Export Lead File -slutpunkten med din exportId.

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

Svaret innehåller en fil som är formaterad på det sätt som jobbet konfigurerades. Slutpunkten svarar med filens innehåll.

Om ett begärt lead-fält är tomt (innehåller inga data) placeras null i motsvarande fält i exportfilen. I exemplet nedan är e-postfältet för den returnerade leadet tomt.

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

Om du vill ha stöd för delvis och återinsättningsvänlig hämtning av extraherade data, kan filslutpunkten (om så önskas) ha stöd för HTTP-rubrikintervallet för bytetypen. Om rubriken inte är inställd returneras hela innehållet. Läs mer om hur du använder intervallhuvudet med Marketo Massextrahering.

Avbryta ett jobb

Om ett jobb konfigurerades felaktigt eller blir onödigt kan det enkelt avbrytas med slutpunkten Avbryt export av lead-jobb :

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

Detta svarar med en status som anger att jobbet har avbrutits.