Skip to main content

We would like to start measuring our shared inbox usage compliance, and we want to get insights from an analytics standpoint (volume for instance). We want to look into the ratio of messages one sends (either through Shared Inboxes or Individual Inboxes).

  • Using our analytics/reports endpoint, you are able to get the total number of messages sent by a teammate from a given shared inbox. This would look like the following:

    POST https://api2.frontapp.com/analytics/reports 
    {
      "filters": {
        "channel_ids":  
          "cha_12345"
        ],
        "teammate_ids":  
          "tea_xyz"
        ]
      },
      "metrics":  
        "num_messages_sent"
      ]
      "end": 1651103999,
      "start": 1648771200
    }

     

  • Your request would also look the same when pulling the total number sent from a private inbox, simply replacing the channel IDs as required.
  • You should expect to see the metric provided within the response payload in the following format: 
    {
      "_links": {
        "self": "https://domain.api.frontapp.com/analytics/reports/714912373297197"
      },
      "status": "done",
      "progress": 100,
      "metrics": :
        {
          "id": "num_messages_sent",
          "type": "number",
          "value": 1
        }
      ]
    }

     

You can then use the 2 values to create your ratio. 

 

--Joel

Reply


Terms & ConditionsCookie settings