API Messaging Insights

Questo documento spiega come ottenere a livello di codice le metriche per i messaggi inviati o ricevuti dalla tua azienda. L'API Messaging Insights è un'estensione dell'API Pages Insights e consente di ottenere le stesse informazioni visualizzate nella tab Insights della Pagina della tua Pagina Facebook.

Prima di iniziare

Questa guida presuppone che tu abbia letto la Panoramica sulla Piattaforma Messenger e implementato i componenti necessari per l'invio e la ricezione di messaggi e notifiche.

Per visualizzare le metriche di una Pagina Facebook di tua proprietà o su cui puoi eseguire l'attività ANALYZE, l'app avrà bisogno di quanto segue:

  • L'ID della Pagina Facebook per cui desideri visualizzare le metriche
    • Per i messaggi di Instagram, questa sarà la Pagina Facebook collegata all'account Instagram per professionisti
  • Un token d'accesso della Pagina
  • Le seguenti autorizzazioni:
    • pages_messaging
    • pages_read_engagement
    • pages_show_list
    • read_insights
  • Accesso standard

Per visualizzare le metriche per una Pagina non di tua proprietà o su cui non puoi eseguire l'attività ANALYZE, l'app avrà bisogno di quanto segue:

  • L'ID della Pagina Facebook per cui desideri visualizzare le metriche
    • Per i messaggi di Instagram, questa sarà la Pagina Facebook collegata all'account Instagram per professionisti
  • Un token d'accesso della Pagina richiesto da un utente che può eseguire l'attività ANALYZE sulla Pagina
  • Le seguenti autorizzazioni tramite Facebook Login:
    • pages_messaging
    • pages_read_engagement
    • pages_show_list
    • read_insights
  • Accesso avanzato

Limitazioni

  • Affinché una nuova conversazione sia conteggiata, la persona deve aver eseguito un'azione, ad esempio aver inviato una risposta alla tua azienda. Finché la persona non eseguirà un'azione, la conversazione sarà visibile solo a lei e non sarà conteggiata.

Lettura delle metriche Insights

Per leggere le informazioni relative a una o più metriche, invia una richiesta GET all'endpoint /PAGE-ID/insights con il parametro metric impostato su una lista separata da virgole di metriche che desideri visualizzare.

Esempio di richiesta

Formattato per una maggiore leggibilità.
curl -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/insights
    ?metric=page_messages_new_conversations_unique,page_messages_blocked_conversations_unique 
    &access_token=PAGE-ACCESS-TOKEN"

Se l'azione viene eseguita correttamente, l'app riceve la seguente risposta JSON:

{ 
  "data": [ 
    { 
      "name": "page_messages_new_conversations_unique", 
      "period": "day", 
      "values": [ 
        { 
          "value": "42", 
          "end_time": "1665175977" 
        }, 
      ]
    },
    { 
      "name": "page_messages_blocked_conversations_unique", 
      "period": "day", 
      "values": [ 
        { 
          "value": "0", 
          "end_time": "1665175977" 
        }, 
      ]
    } 
  ],
}

Esempio di richiesta per un intervallo totale

L'esempio seguente trova il numero di conversazioni uniche e nuove in uno specifico periodo di tempo grazie al parametro period impostato su total_over_range, con l'intervallo temporale definito dai parametri since e until della chiamata API.

Formattato per una maggiore leggibilità.
curl -i -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/insights/
    ?metric=page_messages_new_conversations_unique
    &since=UNIX-TIMESTAMP-START
    &until=UNIX-TIMESTAMP-STOP
    &period=total_over_range
    &access_token=PAGE-ACCESS-TOKEN"

Se l'azione viene eseguita correttamente, l'app riceve la seguente risposta JSON con il numero di conversazioni uniche e nuove alla fine dell'intervallo temporale:

{
  "data": [
    {
      "name": "page_messages_new_conversations_unique",
      "period": "total_over_range",
      "values": [
        {
          "value": 27
          "end_time": "1665175977"
        }
      ],
    }
  ]
}

Esempio di richiesta di dettagli

L'esempio seguente trova il numero di token per notifiche ricorrenti in uno specifico periodo di tempo e raggruppati per argomento e frequenza.

curl -i -X GET "https://graph.facebook.com/LATEST-API-VERSION/PAGE-ID/insights/
    ?metric=recurring_notifications_tokens   
    &since=UNIX-TIMESTAMP-START
    &until=UNIX-TIMESTAMP-STOP
    &period=total_over_range
    &breakdown=recurring_notifications_topic,recurring_notifications_frequency 
    &access_token=PAGE-ACCESS-TOKEN"

Se l'azione viene eseguita correttamente, l'app riceve la seguente risposta JSON, con i token raggruppati per argomento, "newproducts" e "10percentsale" e la frequenza dei messaggi disponibile per ogni argomento, "daily", "weekly" e "monthly" per "newproducts" e "daily" e "weekly" per "10percentsale":

{
  "data": [
    {
      "name": "recurring_notifications_tokens",
      "period": "total_over_range",
      "values": [ 
        {
          "value": 3,
          "end_time": "1665175977",
          "recurring_notifications_topic": "newproducts",
          "recurring_notifications_frequency": "daily"
        },
        {
          "value": 15,
          "end_time": "1665175977",
          "recurring_notifications_topic": "newproducts",
          "recurring_notifications_frequency": "weekly"
        },
        {
          "value": 8,
          "end_time": "1665175977",
          "recurring_notifications_topic": "newproducts",
          "recurring_notifications_frequency": "monthly"
        },
        {
          "value": 17,
          "end_time": "1665175977",
          "recurring_notifications_topic": "10percentsale",
          "recurring_notifications_frequency": "daily"
        },
        {
          "value": 14,
          "end_time": "1665175977",
          "recurring_notifications_topic": "10percentsale",
          "recurring_notifications_frequency": "weekly"
        },
      ]
    }
  ]
}

Parametri di Insights

Parametro Descrizione

breakdown

Dimensioni in base alle quali è raggruppata la risposta. Può essere uno o più dei seguenti elementi:

NomeDescrizione

campaign_id

Visualizza i tuoi dati per numero ID della campagna. Esempi sono "abc123", "Campagna di messaggi estiva" e "Saldi di primavera 2".

engagement_source

Visualizza i tuoi dati in base al tipo di interazione con le notifiche ricorrenti. Esempi sono l'ID di CTA principale e secondario (la CTA su cui è stato fatto clic).

message_type

Visualizza i tuoi dati in base al tipo di messaggio inviato dalla tua azienda. Esempi sono i messaggi di marketing.

messaging_channel

Visualizza i tuoi dati in base al canale usato per consegnare i messaggi agli utenti. Esempi sono Messenger e Instagram.

recurring_notifications_entry_point

Visualizza i tuoi dati in base al punto di accesso alle notifiche ricorrenti. Esempi sono: nella conversazione, plug-in per la chat, inserzioni CTM, plug-in per la casella, link m.me o ig.me e la Pagina Facebook.

recurring_notifications_frequency

Visualizza i tuoi dati in base alla frequenza consentita dall'iscrizione alla ricezione delle notifiche ricorrenti. Esempi sono: giornaliera, settimanale e mensile.

recurring_notifications_topic

Visualizza i tuoi dati in base all'argomento delle notifiche ricorrenti. Esempi sono: messaggi promozionali, lanci di prodotti e offerte.

date_preset

Intervallo di date relativo che può essere utilizzato al posto di since e until. Può essere, ad esempio, last_week, last_month e last_quarter. Altri valori sono consultabili nella guida agli Insights della Pagina.

metric

Obbligatorio. Una lista di metriche separata da virgole da restituire.

period

L'aggregazione fornita nell'intervallo since/until o date_preset. Il valore total_over_range fornisce un singolo valore per la metrica in uno specifico intervallo di date. Può essere day, week, month, days_28 o total_over_range.

since

La data di inizio dell'intervallo di date per il quale desideri visualizzare i dati. Include i dati per la data impostata a partire dalle ore 00:00. Il formato per il valore è YYYY-MM-DD. Il valore 2022-01-31, ad esempio, fornisce i dati dalle ore 00:00 del 31 gennaio 2022.

until

La data di termine dell'intervallo di date per il quale desideri visualizzare i dati. Esclude i dati per la data impostata a partire dalle ore 00:00. Il formato per il valore è YYYY-MM-DD. Il valore 2022-02-01, ad esempio, fornisce i dati fino alle ore 23:59 del 31 gennaio 2022.

Metriche disponibili

Le seguenti metriche sono disponibili tramite l'API Messaging Insights:

metric NomeDescrizione

page_messages_blocked_conversations_unique

Il numero di conversazioni con la Pagina che sono state bloccate.

page_messages_engagement

Il numero di volte in cui i clienti hanno interagito con i messaggi di marketing inviati dalla Pagina della tua azienda toccando un pulsante di call to action.

Possibili valori di breakdown:

  • campaign_id
  • engagement_source
  • message_type
  • messaging_channel
  • recurring_notifications_topic

Questa metrica è in fase di sviluppo.

page_messages_new_conversations_unique

Il numero di conversazioni tramite messaggi su Messenger avviate con persone che non avevano mai inviato messaggi alla tua azienda prima.

page_messages_order_count

Il numero delle volte in cui hai creato un ordine a partire da conversazioni oppure tramite app o siti web di terzi usati per gestire le conversazioni.


Questa metrica è in fase di sviluppo.

page_messages_paid_order_earnings

L'importo stimato che hai guadagnato dagli ordini creati a partire da conversazioni oppure effettuati tramite app o siti web di terzi usati per gestire conversazioni. I ricavi finali potrebbero variare per via delle conversioni di valuta.


Questa metrica è in fase di sviluppo.

page_messages_read_ratio

Il numero di messaggi di marketing letti diviso per il numero di messaggi di marketing inviati dalla tua Pagina.

A volte il dato potrebbe non essere rilevato, ad esempio quando un cliente ha disattivato le conferme di lettura.

Possibili valori di breakdown:

  • campaign_id
  • message_type
  • messaging_channel
  • recurring_notifications_topic

Questa metrica è in fase di sviluppo.

page_messages_reported_conversations_unique

Il numero di conversazioni della tua Pagina che sono state segnalate dalle persone per motivi come spam o per la presenza di contenuti inappropriati.

page_messages_sent

Il numero di messaggi di marketing che la tua Pagina aziendale ha inviato ai clienti.


Possibili valori di breakdown:

  • campaign_id
  • messsage_type
  • messaging_channel
  • recurring_notifications_topic

Questa metrica è in fase di sviluppo.

page_messages_total_messaging_connections

Il numero di persone alle quali la tua azienda può inviare messaggi.


Questa metrica riporta il numero di persone che hanno inviato almeno un messaggio alla tua azienda su Messenger, escluse quelle che hanno bloccato o segnalato la tua azienda su Messenger. Potrebbero esserci vincoli relativi alla tua capacità di inviare messaggi ai contatti, come limitazioni al numero di messaggi che puoi inviare in determinati intervalli di tempo. La metrica include inoltre solo le connessioni avvenute da ottobre 2016, quando i dati sono diventati disponibili.

page_messages_with_business_outcomes

Il numero di contatti dei messaggi con almeno un ordine creato.


Questa metrica è in fase di sviluppo.

recurring_notifications_tokens

Il numero di volte in cui un account ha attivato la ricezione di messaggi di marketing dalla tua azienda. Se un account ha attivato l'iscrizione a più argomenti, verrà conteggiato nuovamente per ciascun argomento.


Modalità di calcolo: questa metrica conta il numero di volte in cui gli account hanno accettato di ricevere i messaggi ricorrenti meno il numero di volte in cui gli account hanno annullato l'iscrizione.


Possibili valori di breakdown:

  • messaging_channel
  • recurring_notifications_frequency
  • recurring_notifications_topic

Questa metrica è in fase di sviluppo.

Ulteriori informazioni sulle metriche in via di sviluppo.

Proprietà della risposta

Le seguenti informazioni potrebbero essere restituite in una chiamata all'API Insights.

Proprietà Descrizione

data

array di oggetti

Una lista di oggetti delle metriche.

name
stringa

Il nome della metrica.

period
stringa

Il periodo di tempo in cui sono stati riportati i dati.

values
array di oggetti

Una lista di dati per una metrica.

value
int

Il conteggio della metrica richiesta nell'intervallo di date specificato.

end_time
marca temporale unix

Marca temporale UTC dell'orario di termine per la metrica.