Server-to-Server
This section covers the integration setup in the Server-to-Server format.
The Server-to-Server configuration allows integration with unsupported platforms and custom-developed platforms using the PostBack method.
Important
Before starting the setup, Create an integration in the FraudScore account if you haven’t done it already.
Postback: Conversions¶
Request
Important
Use only the https protocol for requests.
Important
All request parameters must be URL-encoded.
| Method | URI |
|---|---|
| GET | https://postback.fraudscore.ai/?c=install |
https://postback.fraudscore.ai/?c=install&
key=aSDtrvA&
id=1234567890abc&
advertiser_id=835&
affiliate_id=6251&
offer_id=34713&
session_time=2016-01-01+00%3A00%3A00&
conversion_time=2016-01-01+00%3A00%3A00&
aff_sub1=62511133827&
session_ip=217.12.13.43&
ua=Mozilla%2F5.0+%28Macintosh%3B+Intel+Mac+OS+X+10_12_0%29+AppleWebKit%2F537.36+%28KHTML
%2C+like+Gecko%29+Chrome%2F53.0.2785.116+Safari%2F537.36
Request Parameters
Required:
| Parameter | Data type | Description | Example |
|---|---|---|---|
| key | string | Your API key | aSDtrvA |
| id | string | Unique conversion ID | 1234567890abc |
| advertiser_id | string | Advertiser ID | 835 |
| affiliate_id | string | Affiliate ID | 6251 |
| offer_id | string | Offer ID | 34713 |
| session_time | datetime | Click time | 2018-01-01 00:00:00 |
| conversion_time | datetime | Conversion time | 2018-01-01 00:00:00 |
| session_ip | string (16) | Session (click) IP | 217.12.13.43 |
| ua | string | Full device "User agent" | Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.116 Safari/537.36 |
Important
For mobile traffic, we strongly recommend sending the following parameters, as their absence will affect the completeness of the analysis:
app_idapp_versionattributed_touch_type
Optional:
| Parameter | Data type | Description | Example |
|---|---|---|---|
| advertiser_name | string | Advertiser Name (in case of "empty" will be equal to "advertiser_id") | BestMediaCPANetwork |
| advertiser_manager_id | string | Advertiser Manager IDAdvertiser Manager ID | 4 |
| advertiser_manager_name | string | Advertiser Manager Name (in case of "empty" will be equal to "advertiser_manager_id") | John |
| affiliate_name | string | Affiliate Name (in case of "empty" will be equal to "affiliate_id") | Partner 1 |
| affiliate_manager_id | string | Affiliate Manager ID | 12 |
| affiliate_manager_name | string | Affiliate Manager Name (in case of "empty" will be equal to "affiliate_manager_id") | Jane |
| offer_name | string | Offer Name (in case of "empty" will be equal to "offer_id") | Mobile App (iOS) |
| aff_sub1 | string | Additional affiliate info (ID of your sub-sources) | |
| aff_sub2 | string | Additional affiliate info (ID of your sub-sources) | |
| aff_sub3 | string | Additional affiliate info (ID of your sub-sources) | |
| aff_sub4 | string | Additional affiliate info (ID of your sub-sources) | |
| aff_sub5 | string | Additional affiliate info (ID of your sub-sources) | |
| conversion_status | string | Status of conversion | "Pending", "Approved", "Hold", e.t.c |
| refer | string (1024) | Click URL | http://e1.ru/ad_banner |
| user_mail | string | User's e-mail | john_doe@gmail.com |
| idfa | string | iOS device ID | 6D92078A-8246-4BA4-AE5B-76104861E7DC |
| android_id | string | Android device ID | 1919FC51E20A1732 |
| source | string | Traffic Source | "MyTarget", "Facebook", "Network", e.t.c. |
| app_id | string | App ID | 1234567890, com.company.appname |
| app_version | string | Application version | 1.35.0 |
| funnel_id | string | Funnel ID | 5ea20b93a28bde0001f07382 |
| attributed_touch_type | string | Attributed type of touch | click, impression, pre-install |
| contrib1_touch_type | string | Contributor touch type 1 | click, impression |
| contrib2_touch_type | string | Contributor touch type 2 | click, impression |
| contrib3_touch_type | string | Contributor touch type 3 | click, impression |
| contrib1_touch_time | datetime | Contributor touch time 1 | 2018-01-01 00:00:00 |
| contrib2_touch_time | datetime | Contributor touch time 2 | 2018-01-01 00:00:00 |
| contrib3_touch_time | datetime | Contributor touch time 3 | 2018-01-01 00:00:00 |
| contrib1_partner | string | Contibutor partner 1 | Partner 1 |
| contrib2_partner | string | Contibutor partner 2 | Partner 2 |
| contrib3_partner | string | Contibutor partner 3 | Partner 3 |
| contrib1_media_source | string | Contributor media source 1 | Media source 1 |
| contrib2_media_source | string | Contributor media source 2 | Media source 2 |
| contrib3_media_source | string | Contributor media source 3 | Media source 3 |
| app_name | string | App name | Application name |
| sdk_version | string | SDK version | v5.1.1 |
| cost | float32 | Costs | 0 |
| cost_currency | string | Currency of the costs | USD, EUR |
Warning
The FraudScore team emphasizes that the effectiveness of analysis based on multiple parameters directly depends on the number of unique values. We recommend not exceeding 1000. This will affect the results of your traffic quality assessment in FraudScore reports. Parameters to which this recommendation applies:
advertiser_idadvertiser_nameadvertiser_manager_idadvertiser_manager_nameoffer_idoffer_nameaffiliate_idaffiliate_nameaffiliate_manager_idaffiliate_manager_name
Response
The status code HTTP 200 OK will be returned after a successful postback.
Postback: Custom¶
Request
Important
Use only the https protocol for requests.
Important
All request parameters must be URL-encoded.
| Method | URI |
|---|---|
| GET | https://postback.fraudscore.ai/?c=custom |
Request Parameters
| Parameter | Data type | Description |
|---|---|---|
| key | string | Your API key |
| id | string | Unique event ID |
| ip | string (16) | Event IP-address |
| ua | string | Event user agent |
| datetime | datetime | Session time (timestamp) |
| name | string | Event name (shown in FraudScore report) |
| funnel_id | string | Pass-through identifier for joining the conversion with its other events |
Important
Include the funnel_id parameter for each conversion.
Response
The status code HTTP 200 OK will be returned after a successful postback.
Postback: Click¶
Request
Important
Use only the https protocol for requests.
Important
All request parameters must be URL-encoded.
| Method | URI |
|---|---|
| GET | https://postback.fraudscore.ai/?c=click |
Request Parameters
| Parameter | Data type | Description |
|---|---|---|
| key | string | Your API key |
| id | string | Unique click ID |
| ip | string (16) | Click IP-address |
| ua | string | Click user agent |
| datetime | datetime | Click time (timestamp) |
| affiliate_id | string | Affiliate ID |
| offer_id | string | Offer ID |
Important
Include affiliate_id and offer_id parameters to every click for CR (click rate) counting!
Response
The status code HTTP 200 OK will be returned after a successful postback.
Postback: Impression¶
Request
Important
Use only the https protocol for requests.
Important
All request parameters must be URL-encoded.
| Method | URI |
|---|---|
| GET | https://postback.fraudscore.ai/?c=impression |
Request Parameters
| Parameter | Data type | Description |
|---|---|---|
| key | string | Your API key |
| id | string | Unique impression ID |
| ip | string (16) | Impression IP-address |
| ua | string | Impression user agent |
| datetime | datetime | Impression time (timestamp) |
| affiliate_id | string | Affiliate ID |
| offer_id | string | Offer ID |
Response
The status code HTTP 200 OK will be returned after a successful postback.
Postback: Session¶
Request
Important
Use only the https protocol for requests.
Important
All request parameters must be URL-encoded.
| Method | URI |
|---|---|
| GET | https://postback.fraudscore.ai/?c=session |
Request Parameters
| Parameter | Data type | Description |
|---|---|---|
| key | string | Your API key |
| id | string | Unique session ID |
| ip | string (16) | Session IP-address |
| ua | string | Session user agent |
| datetime | datetime | Session time (timestamp) |
| funnel_id | string | Pass-through identifier for joining the conversion with its other events |
Important
Include the funnel_id parameter for each conversion.
Response
The status code HTTP 200 OK will be returned after a successful postback.