Uitpakken van bulkactiviteiten

Uittreksel van het EindpuntVerwijzing van de Activiteit van de Bulk

De reeks van het Uittreksel van de Activiteit van het Bulk van REST APIs verstrekt een programmatic interface voor het terugwinnen van grote hoeveelheden activiteitengegevens uit Marketo.  Voor gevallen die geen lage latentie vereisen, en significante volumes van activiteitsgegevens uit Marketo, zoals CRM-integratie, ETL, gegevensopslag, en gegevensarchivering moeten overbrengen.

Machtigingen

De Bulk Activity Extraheren-API's vereisen dat de API-gebruiker beschikt over de machtiging "Alleen-lezen activiteit" of "activiteit lezen-schrijven".

Filters

Opties voor primaryAttributeValueIds primaryattributevalueids-options

Wanneer u primaryAttributeValueIds gebruikt, moet het filter activityTypeIds aanwezig zijn en mag het alleen activiteiten-id's bevatten die overeenkomen met de overeenkomstige elementgroep. Als u bijvoorbeeld filtert op webformulierelementen, is alleen de activiteitstype-id Formulier invullen toegestaan in activityTypeIds .

Hoofdtekst voorbeeldaanvraag:

{
  "filter": {
    "createdAt": {
      "startAt": "2021-07-01T23:59:59-00:00",
      "endAt": "2021-07-02T23:59:59-00:00"
    },
    "activityTypeIds": [
      2
    ],
    "primaryAttributeValueIds": [
      16,102,95,8
    ]
  }
}

primaryAttributeValueIds en primaryAttributeValues kunnen niet samen worden gebruikt.

Opties voor primaryAttributeValues primaryattributevalues-options

Merk op dat u "< programma > moet gebruiken.< activa >"aantekening om de naam voor de volgende activagroepen te specificeren: Het Programma van de marketing, Statische Lijst, de Vorm van het Web. Een formulier met de naam "MPS Outbound" dat zich bijvoorbeeld onder een programma met de naam "GL_OP_ALL_2021" bevindt, wordt opgegeven als "GL_OP_ALL_2021.MPS Outbound".

Hoofdtekst voorbeeldaanvraag:

{
  "filter": {
    "createdAt": {
      "startAt": "2021-07-01T23:59:59-00:00",
      "endAt": "2021-07-02T23:59:59-00:00"
    },
    "activityTypeIds": [
      2
    ],
    "primaryAttributeValues": [
      "GL_OP_ALL_2021.MPS Outbound"
    ]
  }
}

Wanneer u primaryAttributeValues gebruikt, moet het filter activityTypeIds aanwezig zijn en mag het alleen activiteiten-id's bevatten die overeenkomen met de overeenkomstige elementgroep. Als u bijvoorbeeld filtert op webformulierelementen, is alleen de activiteitstype-id Formulier invullen toegestaan in activityTypeIds . primaryAttributeValues en primaryAttributeValueIds kunnen niet samen worden gebruikt.

Opties

Een taak maken

Als u records wilt exporteren, moet u eerst de taak en de set records definiëren die u wilt ophalen.  Creeer de baan gebruikend creeer de Eis van de Activiteit van de Uitvoereindpunt.  Bij het exporteren van activiteiten kunnen twee primaire filters worden toegepast: createdAt (altijd verplicht) en activityTypeIds (optioneel).  Het filter createdAt wordt gebruikt om een datumbereik te definiëren waarin activiteiten zijn gemaakt. Hierbij wordt gebruikgemaakt van de parameters startAt en endAt , die beide datetime-velden zijn en die respectievelijk de vroegste toegestane aanmaakdatum en de laatst toegestane aanmaakdatum vertegenwoordigen.  U kunt desgewenst ook filteren op alleen bepaalde typen activiteiten met het filter activityTypeIds .  Dit is handig als u resultaten wilt verwijderen die niet relevant zijn voor uw gebruiksscenario.

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

{
   "format": "CSV",
   "filter": {
      "createdAt": {
         "startAt": "2017-07-01T23:59:59-00:00",
         "endAt": "2017-07-31T23:59:59-00:00"
      },
      "activityTypeIds": [
         1,
         12,
         13
      ]
   }
}

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

De taak heeft nu de status 'Gemaakt', maar bevindt zich nog niet in de verwerkingswachtrij.  Om het in de rij te zetten zodat kan het beginnen verwerkend, het in de rij stellende eindpunt van de Baan van de Activiteit van de Uitvoer van de Activiteitgebruikend exportId van de reactie van de aanmaakstatus.

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

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

De status rapporteert dat de taak in de wachtrij is geplaatst.  Wanneer een worker beschikbaar komt voor deze taak, wordt de status overgeschakeld op "Verwerken" en begint de taak met het samenvoegen van records van Marketo.

Status opiniepeilingtaak

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

Het Extraheren van de Activiteit van de Bulk van Marketo is een asynchroon eindpunt, zodat moet de baanstatus worden gepolled om te bepalen wanneer de baan volledig is.  Opiniepeiling die het gebruiken krijgt de Status van de Taak van de Activiteit van de Uitvoerals volgt:

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

{
   "requestId": "e42b#14272d07d78",
   "success": true,
   "result": [
      {
         "exportId": "ce45a7a1-f19d-4ce2-882c-a3c795940a7d",
         "status": "Completed",
         "createdAt": "2017-01-21T11:47:30-08:00",
         "queuedAt": "2017-01-21T11:48:30-08:00",
         "startedAt": "2017-01-21T11:51:30-08:00",
         "finishedAt": "2017-01-21T12:59:30-08:00",
         "format": "CSV",
         "numberOfRecords": 15423,
         "fileSize": 12342,
         "fileChecksum": "sha256:c16514c7e80fcac5ea055dacae9617fc3c29aff5365e3743071313ce0ed2a815"
      }
   ]
}

Het statusveld kan reageren met een van de volgende waarden:

Uw gegevens ophalen

Zodra de baan volledig is, wint uw gegevens terug gebruikend krijgt het 1} eindpunt van het Dossier van de Activiteit van de Uitvoer.

GET /bulk/v1/activities/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 then null in het corresponderende veld in het exportbestand geplaatst.  In het onderstaande voorbeeld is het veld campaignId voor de geretourneerde activiteit leeg.

marketoGUID,leadId,activityDate,activityTypeId,campaignId,primaryAttributeValueId,primaryAttributeValue,attributes
783957693,5414087,2022-02-13T14:06:20Z,104,8497,1670,MembershipTest1,"{""Reason"":""Changed by Smart Campaign MembershipTestCampaignStepChoice.MembershipTestCampaignStepChoiceSetUp action Change Data Value"",""Program Member ID"":3240303,""Acquired By"":true,""Old Status"":""Not in Program"",""New Status ID"":21,""Success"":false,""New Status"":""On List"",""Old Status ID"":20}"
783958220,5414094,2022-02-13T14:08:50Z,104,17240,3569,SuccessWebCPS,"{""Program Member ID"":3240305,""Acquired By"":false,""Old Status"":""Not in Program"",""New Status ID"":6,""Success"":true,""New Status"":""Attended"",""Old Status ID"":1}"
783958306,5414094,2022-02-13T14:09:16Z,104,17240,3569,SuccessWebCPS,"{""Program Member ID"":3240305,""Acquired By"":false,""Old Status"":""Attended"",""New Status ID"":6,""Success"":false,""New Status"":""Attended"",""Old Status ID"":6}"
783961924,5316669,2022-02-13T14:27:21Z,104,11614,2333,Nurture Automation,"{""Program Member ID"":3240306,""Acquired By"":false,""Old Status"":""Not in Program"",""New Status ID"":27,""Success"":false,""New Status"":""Member"",""Old Status ID"":26}"

Om gedeeltelijke en hervattingsvriendelijke herwinning van gehaalde gegevens te steunen, steunt het dossiereindpunt naar keuze de kopbal van HTTP Range van het type bytes.  Als de header niet is ingesteld, wordt de gehele inhoud geretourneerd.  U kunt meer lezen over het gebruiken van de kopbal van de Waaier met Marketo Bulk Extraheert.

Een taak annuleren

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

POST /bulk/v1/activities/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"
      }
   ]
}

Deze reactie heeft een status die aangeeft dat de taak is geannuleerd.