> For the complete documentation index, see [llms.txt](https://docs.mfilterit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mfilterit.com/api-integrations/mfilterit-reporting-api.md). # 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](https://app.swaggerhub.com/apis/api-mfilterit/m-filter_it_reporting_api/1.2). The code generators available at Swagger can be used to generate templates for services that would receive data from this Reporting API.