> 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-backend-data-collection-api.md).

# mFilterIt  Data Collection API

## Version 1.2 <a href="#version-1-2" id="version-1-2"></a>

## &#x20;Overview <a href="#overview" id="overview"></a>

To allow a deeper and automated integration between the mFilterIt solution and the app developer’s in house systems, mFilterIt provides an endpoint to receive data from app developers backend system.

### Backend API Schema

| **Parameter Name**  | **Type** | **Description**                                                                                                        |
| ------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| **adid**            | string   | The unique Google Advertising ID associated with the app user/ device. example: "0a946c9e-6df1-4d63-8fb0-679bfba3c2c9" |
| **installed\_app**  | string   | The android package name of the app. example: "com.mfilterit.android"                                                  |
| **customer\_id**    | string   | The unique customer identifier . example: "CUST012345"                                                                 |
| **event\_name**     | string   | The name of the event. example: "click"                                                                                |
| **device\_id**      | string   | The unique device identifier associated with the android device. example: "4f36d627af4ab545"                           |
| **event\_time**     | string   | The timestamp fields indicates the time of install, example: "2017-05-12 11:00:00"                                     |
| **event\_value**    | string   | The value of the event. example:"true"                                                                                 |
| **publisher\_name** | string   | The name of the primary publisher of the advertisement . example: "MoBrain"                                            |
| **order\_id**       | string   | Order id / unique generated id. Example: "12MFTest3"                                                                   |

## Backend API <a href="#reporting-api" id="reporting-api"></a>

An HTTP GET on the data collection endpoint is supported.&#x20;

**GET /**

The Data Collection API receives data from third party servers. The parameters described above are received as Query String parameters.

| **consumes**                                                                              | application/json                                                                      |
| ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| **produces**                                                                              | application/json                                                                      |
| <p><strong>parameters: -</strong></p><p> <strong>in: "queryStringParameters"</strong></p> | Parameters being posted to server                                                     |
| **responses:**                                                                            | <p>400: description: "Invalid input"       </p><p>200: description: "successful" </p> |

## Swagger Definition <a href="#swagger-definition" id="swagger-definition"></a>

&#x20;A Swagger definition of the API is available [here](https://app.swaggerhub.com/apis/mfilterit1/backend_collector/1.4).

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