Messaging Insights API Reference

With the Messaging Insights API, you can programatically retrieve the same information that appears in the Page Insights tab of your Facebook Page.

For further information about the Pages Insights API, including information on other metrics available and the permissions required, please see the Pages Insights documentation, or the Insights object reference.

Contents

Base URI

https://graph.facebook.com/v2.8/me/insights/

Daily Unique Active Threads Count

Retrieves a count of the unique active threads your app participated in per day.

Path

GET /page_messages_active_threads_unique

Example Request

curl -X GET "https://graph.facebook.com/v2.8/me/insights/page_messages_active_threads_unique?access_token=<PAGE_ACCESS_TOKEN>"

Example Response

{ 
  "data": [ 
    { 
      "name": "page_messages_active_threads_unique", 
      "period": "day", 
      "values": [ 
        { 
          "value": 83111, 
          "end_time": "2017-02-02T08:00:00+0000" 
        }, 
        { 
          "value": 85215, 
          "end_time": "2017-02-03T08:00:00+0000" 
        }, 
        { 
          "value": 87175, 
          "end_time": "2017-02-04T08:00:00+0000" 
        }
     ]
    } 
  ],
}

Response Properties

Property Name Type Description

data

Array

The response payload.

data.name

String

The long name of the returned report.

data.values

Array<Object>

The unique thread count by day:


  • value: number of unique threads
  • end_time: date of the count

Daily Unique Conversation Actions

Retrieves a count of actions that were initiated by people your app was in an active thread with per day.

Path

GET /page_messages_feedback_by_action_unique

Example Request

curl -X GET "https://graph.facebook.com/v2.8/me/insights/page_messages_feedback_by_action_unique?access_token=<PAGE_ACCESS_TOKEN>"

Example Response

{ 
  "data": [ 
    { 
      "name": "page_messages_feedback_by_action_unique", 
      "period": "day", 
      "values": [ 
        { 
          "value": { 
            "TURN_ON": 40, 
            "TURN_OFF": 167, 
            "DELETE": 720, 
            "OTHER": 0, 
            "REPORT_SPAM": 0 
          }, 
          "end_time": "2017-02-02T08:00:00+0000" 
        }, 
        { 
          "value": { 
            "TURN_ON": 38, // thread started
            "DELETE": 654, // thread deleted
            "TURN_OFF": 155, // blocked
            "REPORT_SPAM": 1, // reported spam
            "OTHER": 0 
          }, 
          "end_time": "2017-02-03T08:00:00+0000" 
        }
      ]
    } 
  ],
}

Response Properties

Property Name Type Description

data

Array

The response payload.

data.name

String

The long name of the returned report.

data.values

Array<value>

The available action counts by day. Includes:


  • value: the actions with counts
  • end_time: date of the count