Reporting API

This API allows to get Campaign stats using campaign ID via an API call.

API Endpoint

API call is a POST method, and the URL is mentioned below.

HTTP

https://pushapi.moengage.com/v2/transaction/sendpush

Request Headers

HTTP

'Content-Type':'application/json'

Request Body

Parameters necessary for the API call should be passed as a JSON object string in the request body.

appId (Mandatory) : APP ID provided by MoEngage to identify the specific app. You can find it under Settings -> Transactional Push Settings on MoEngage Dashboard.

requestType (Mandatory) : The value of this key is used to indicate the intention of API request. Value of this key should be report.

cid (Mandatory) : ID of the campaign for which stats are required. Campaign ID you can find on MoEngage Dashboard.
NOTE : If the campaign is sent using Transaction API V2 then you can use responseId or requestId instead of cid to get campaign report.

Sample Payload

Using cid

{
  "appId": "MAZW5N1IMMSH5H67C3T9KBHB",
  "cid": "586b6e67079b513c6ed2c555",
  "requestType": "report"
}

Using requestId

// if the campaign is sent using Transaction API v2
{
  "appId": "MAZW5N1IMMSH5H67C3T9KBHB",
  "requestId": "77c23cbe-c2ca-4b0e-b078-86d6de90"
  "requestType": "report"
}

Using responseId

// if the campaign is sent using Transaction API v2
{
  "appId": "MAZW5N1IMMSH5H67C3T9KBHB",
  "responseId": "77c23cbe-c2ca-4b0e-b078-86d6de909",
  "requestType": "report"
}

Sample Response

JSON

{
  "DelieveryStats": {
    "WINDOWS": {
      "impressions": 3,
      "installed_users_in_segment": 124,
      "active_device_tokens": 6,
      "after_fc_removal": 124,
      "successfully_sent": 3
    },
    "WEB": {
      "impressions": 0,
      "installed_users_in_segment": 0,
      "active_device_tokens": 0,
      "after_fc_removal": 0,
      "successfully_sent": 0
    },
    "ANDROID": {
      "impressions": 5,
      "installed_users_in_segment": 2934,
      "active_device_tokens": 1317,
      "after_fc_removal": 2934,
      "successfully_sent": 5
    },
    "IOS": {
      "impressions": 15,
      "installed_users_in_segment": 1289,
      "active_device_tokens": 34,
      "after_fc_removal": 1289,
      "successfully_sent": 15
    }
  },
  "status": "Success",
  "PerformanceStats": {
    "WINDOWS": {
      "conversions": 0,
      "impressions": 3,
      "clicks": 2,
      "conversion_events": 0
    },
    "WEB": {
      "conversions": 0,
      "impressions": 0,
      "clicks": 0,
      "conversion_events": 0
    },
    "ANDROID": {
      "conversions": 0,
      "impressions": 5,
      "clicks": 2,
      "conversion_events": 0
    },
    "IOS": {
      "conversions": 0,
      "impressions": 15,
      "clicks": 2,
      "conversion_events": 0
    },
    "ALL_PLATFORMS": {
      "conversions": 0,
      "impressions": 23,
      "clicks": 6,
      "conversion_events": 0
    }
  }
}