fraudshield/fraudshield-php

A PHP wrapper for Fraudshield's API

Fraudshield PHP SDK

Welcome to Fraudshield PHP SDK. This repository contains Fraudshield's PHP SDK and samples for REST API., _(*1)

SDK Documentation

Our API Documentation page includes all the documentation related to this PHP SDK, _(*2)

Installation

composer require "fraudshield/fraudshield-php", _(*3)

Usage

Conversion Report

<?php
require_once __DIR__ . '/vendor/autoload.php';

use Fraudshield\Fraudshield;
use Fraudshield\Reports\ConversionReport;

$fs = new Fraudshield(USER_ID, API_TOKEN);

// create a conversion report
$report = new ConversionReport(186,'2017-06-05', '2017-06-05'); 

// dump the report content
var_dump($fs->getReport($report));

Fraud Report

<?php
require_once __DIR__ . '/vendor/autoload.php';

use Fraudshield\Fraudshield;
use Fraudshield\Reports\FraudReport;

$fs = new Fraudshield(USER_ID, API_TOKEN);

// create a conversion report
$report = new FraudReport(186,'2017-06-05', '2017-06-05');

// add data sources
$report
    ->addDataSource('sub_id')
    ->addDataSource('partner')
    ->addDataSource('affiliate')
    ->addDataSource('product')
    ->addDataSource('goal');

// add filter
$report
    ->addFilter('min_conversions', 1)
    ->addFilter('min_rejection_rate', 1)
    ->addFilter('max_rejection_rate', 50)
    ->addFilter('min_goals_reached', 50)
    ->addFilter('max_goals_reached', 50);

// dump the report content
var_dump($fs->getReport($report));

License

MIT, _(*4)