mFilterIt Reporting API

MFilterIt Reports are available as postbacks and through the MFilterIt Reporting Server.

Version 1.2

Overview

To allow a deeper and automated integration between the MFilterIt solution and the app developer’s in house systems, MFilterIt transfers reporting data with third party systems. The reporting server allows fraud reports for a given duration to be requested and also allows reporting postbacks to be pushed to third-party systems in real time.

Reporting Schema

The MFilterIT API encodes transaction information as a transaction object. The schema for this object is detailed below.

Parameter Name	Type	Description
timestamp	string	The timestamp fields indicates the time of install, example: "2017-05-12 11:00:00"
package_name	string	The android package name of the app. example: "com.mfilterit.android"
vendor_id	string	The unique vendor identifier which is allocated at the time of registration. example: "mfilterit01"
device_gaid	string	The unique Google Advertising ID associated with the app user/ device. example: "0a946c9e-6df1-4d63-8fb0-679bfba3c2c9"
device_id	string	The unique device identifier associated with the android device. example: "4f36d627af4ab545"
device_imei	string	The unique IMEI number associated with the device. example: "863795035583757"
campaign_id	string	The campaign_id is the name of the campaign which is received in the postback from the attribution platform.example: "Saatchi_MoBrain_IN_Android_Non_Incent"
transaction_id	string	example: "8ba0ec164c729c6b38b50179698c6f25d3dbf9ab"
publisher_id	string	The name of the primary publisher of the advertisement. example: "MoBrain"
publisher_name	string	The name of the primary publisher of the advertisement. This parameter is the same as the publisher_id . example: "MoBrain"
sub_publisher_id	string	The name of the sub publisher associated with the primary publisher of the advertisement. example : "000705_74911824"
user_id	string	This field contains any custom user id that is passed to the attribution platform. When no customer data is passed to the attribution platform in conjunction with the MFilterIt SDK this field is set to “Default” example: "Default"
device_carrier	string	The telecom service provider for the device. example: "Airtel"
conversion_make	string	The make/brand of the device.example: "Intex”
conversion_model	string	The model of the device.example: "Intex_Aqua_Craze_2"
tdr_id	string	A unique transaction identifier maintained by the attribution platform to uniquely identify a given transaction. example: "38755349"
click_id	string	A unique id used to identify the attributed click event.example: "VaTg09zbCs19HhmPO8M_DtbFdc14QsDI0sTiG_OqINhb"
fraud_category	string	The type of fraud detected for the given transaction.The Fraud Category is decided based on the risk scores calculated by various algorithms. example: "Click_Spam"
DF_DuplicateUserRiskScore	string	example: "60"
DF_FAkeDeviceRiskScore	string	example: "0"
DF_APKRiskScore	string	example: "0"
DF_IncorrectRegionRiskScore	string	example: "0"
DF_IncorrectTelcoRiskScore	string	example: "0"
IF_VPNProxyRiskScore	string	example: "0"
IF_DuplicateIPRiskScore	string	example: "0"
IF_BlacklistedRiskScore	string	example: "0"
CF_FakeAttributionRiskScore	string	example: "0"
CF_FakeClickRiskScore	string	example: "0"
CF_ClickSpamRiskSCore	string	example: "100"
Dis_OSRiskScore	string	example: "0"
Dis_DeviceRiskScore	string	example: "0"
Dis_BrowserRiskScore	string	example: "0"
Dis_IPRiskScore	string	example: "0"
Dis_ISPRiskScore	string	example: "0"
INC_HighCRRiskScore	string	example: "0"
INC_clickUnderRiskScore	string	example: "0"

Reporting API

POST /transaction

The Reporting API publishes reporting data with third party servers. The reporting data is shared as an array of transactions. The transaction data is encoded in json format.

consumes	application/json
produces	application/json
parameters: - in: "transactions"	Transactions being posted to third-party server. Transactions are encoded as a json array of transaction objects. The schema of the transaction object is detailed in the above section.
responses:	405: description: "Invalid input"

Swagger Definition

A Swagger definition of the API is available here.

The code generators available at Swagger can be used to generate templates for services that would receive data from this Reporting API.