Attività

Ultimo aggiornamento: 4 novembre 2024
  • Argomenti:

Creato per:

  • Amministratore

Marketo consente un'ampia varietà di tipi di attività relativi ai record dei lead.  Quasi ogni modifica, azione o passaggio di flusso viene registrato rispetto al registro attività di un lead e può essere recuperato tramite l’API o utilizzato nei filtri e nei trigger di Smart Campaign e Smart List.  Le attività sono sempre correlate al record lead tramite il leadId, corrispondente al campo Id del record e dispone anche di un ID univoco.

Esistono molti tipi di attività potenziali, che possono variare da un abbonamento all’altro e che hanno definizioni univoche per ciascuno di essi. Anche se ogni attività ha il proprio id, leadId e activityDate, i valori primaryAttributeValueId e primaryAttributeValue variano nel loro significato.

Marketo consente inoltre la creazione di tipi di attività personalizzati tramite l’API di metadati delle attività personalizzate. L’aggiunta di attività personalizzate viene eseguita tramite l’API Add Custom Activities.

La maggior parte delle attività verrà eliminata dopo un certo periodo di tempo.

Descrivere

Per recuperare un elenco dei tipi disponibili e delle relative definizioni per un'istanza, è possibile utilizzare l'endpoint Get Activity Types.

GET /rest/v1/activities/types.json

  "requestId": "6e78#148ad3b76f1",
  "success": true,
  "result": [
    {
      "id": 2,
      "name": "Fill Out Form",
      "description": "User fills out and submits form on web page",
      "primaryAttribute": {
        "name": "Webform ID",
        "dataType": "integer"
      },
      "attributes": [
        {
          "name": "Client IP Address",
          "dataType": "string"
        },
        {
          "name": "Form Fields",
          "dataType": "text"
        },
        {
          "name": "Query Parameters",
          "dataType": "string"
        },
        {
          "name": "Referrer URL",
          "dataType": "string"
        },
        {
          "name": "User Agent",
          "dataType": "string"
        },
        {
          "name": "Webpage ID",
          "dataType": "integer"
        }
      ]
    }
  ]
}

Le risposte dal mondo reale includono molte più definizioni. In questo esempio, il tipo visualizzato è "Compila modulo", con un attributo principale di "ID modulo web" che fa riferimento all’ID Marketo del modulo compilato e può essere utilizzato per riferirsi a quella particolare risorsa in Marketo. Inoltre, esistono definizioni per ciascuno dei possibili attributi di un particolare record di attività di questo tipo e dei relativi tipi di dati. Tieni presente che se il campo è vuoto, quel particolare attributo viene omesso da un singolo record di attività.

Query

Per recuperare le attività da Marketo, chiama l'endpoint Get Lead Activities. Devi innanzitutto recuperare un token di paging per il datetime da cui vuoi iniziare a recuperare le attività. Passare quindi il token di paging nel parametro di query nextPageToken. Inoltre, si passano fino a dieci ID del tipo di attività nel parametro di query activityTypeIds come elenco separato da virgole.

Facoltativamente è possibile includere un parametro di query listId per limitare la ricerca ai soli record inclusi in un elenco statico specifico oppure un parametro di query leadId e cercare le attività solo da un set specificato di lead. È possibile passare fino a 30 leadID come elenco separato da virgole.

GET /rest/v1/activities.json?activityTypeIds=1&nextPageToken=WQV2VQVPPCKHC6AQYVK7JDSA3I3LCWXH3Y6IIZ7YSGQLXHCPVE5Q====

{
  "requestId": "24fd#15188a88d7f",
  "result": [
    {
      "id": 102988,
      "marketoGUID": "102988",
      "leadId": 1,
      "activityDate": "2023-01-16T23:32:19Z",
      "activityTypeId": 1,
      "primaryAttributeValueId": 71,
      "primaryAttributeValue": "localhost/munchkintest2.html",
      "attributes": [
        {
          "name": "Client IP Address",
          "value": "10.0.19.252"
        },
        {
          "name": "Query Parameters",
          "value": ""
        },
        {
          "name": "Referrer URL",
          "value": ""
        },
        {
          "name": "User Agent",
          "value": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.95 Safari/537.36"
        },
        {
          "name": "Webpage URL",
          "value": "/munchkintest2.html"
        }
      ]
    }
  ],
  "success": true,
  "nextPageToken": "WQV2VQVPPCKHC6AQYVK7JDSA3J62DUSJ3EXJGDPTKPEBFW3SAVUA====",
  "moreResult": false
}

Per la prima chiamata, utilizza l'API Get Paging Token per ottenere nextPageToken. Per le chiamate successive a questo endpoint, utilizza nextPageToken returned dalla risposta. Questo endpoint restituisce sempre the nextPageToken.

Se l'attributo moreResult è true, significa che sono disponibili altri risultati. Continuare a chiamare questo endpoint fino a quando l'attributo moreResult non restituisce false, ovvero non sono disponibili risultati. I nextPageToken restituiti da questa API devono essere sempre riutilizzati per la successiva iterazione di questa chiamata.

In alcuni casi, questa API potrebbe rispondere con meno di 300 elementi attività, ma anche avere l'attributo moreResult impostato su true.  Ciò indica che è possibile restituire più attività e che è possibile eseguire una query sull'endpoint per le attività più recenti includendo nextPageToken restituito in una chiamata successiva.

All'interno di ogni elemento dell'array dei risultati, l'attributo intero id viene sostituito dall'attributo stringa marketoGUID come identificatore univoco.