API interface

The filter and tracker APIs allow you to work with visit checking, traffic and statistics. To get an API token, go to your profile page in the system. Interaction with the service is carried out via the HTTP protocol, the response status is always 200. The standard request format is GET or "pure" POST (form-urlencoded). When submitting in JSON, don't forget the Content-type: application/json header. The result format is JSON. There is no limit on the number of requests.

Futher in the text, important parameters are shown in curly brackets:

• {token} - your API key from personal account, for example 123-abdce.
• {flow} - symbolic identifier of a flow from the list, for example ef1c.
• {click} - character ID of a click from the tracker, for example ca1337.

Important! When using links and data, don't use curly braces, only the values themselves!

Filtering

Filtering functions allow you to check visits to your sites as quickly as possible. They are placed in a separate interface, which has the minimum response time and maximum performance.

Check the visit

URL: https://www.altercpa.one/fltr/{user}-{key}-{id}

In the function address, instead of {user} and {key}, specify the API ID and key from the profile, instead of {id} specify the identifier of the filter site you added. You can get the specific URL by clicking on the "Manual" button of the corresponding site in your your personal account.

To check your visit, you need to send a POST request to the above URL. Pass the fields of your array $_SERVER as the body of the request - we will parse them and show the response in JSON format. A successful response includes the status, action and url fields. The status field always contains the value ok. The action field of the response will contain allow or deny depending on the verification results, the url field will contain the corresponding URL. In the error response, the status field will contain error, the error code will be indicated in the error field.

The POST part of the request must be in x-www-form-urlencoded format, JSON format is not supported. We parse the following fields from the $_SERVER array:

HTTP_USER_AGENT, HTTP_ACCEPT, HTTP_ACCEPT_CHARSET, HTTP_ACCEPT_ENCODING, HTTP_ACCEPT_LANGUAGE, HTTP_AUTHORIZATION, HTTP_CACHE_CONTROL, HTTP_CONNECTION, HTTP_CONTENT_DISPOSITION, HTTP_DATE, HTTP_EXPECT, HTTP_FROM, HTTP_HOST, HTTP_IF_MATCH, HTTP_IF_MODIFIED_SINCE, HTTP_IF_NONE_MATCH, HTTP_IF_RANGE, HTTP_IF_UNMODIFIED_SINCE, HTTP_MAX_FORWARDS, HTTP_PRAGMA, HTTP_PROXY_AUTHORIZATION, HTTP_RANGE, HTTP_REFERER, HTTP_TE, HTTP_TRAILER, HTTP_TRANSFER_ENCODING, HTTP_UPGRADE, HTTP_VIA, HTTP_X_FORWARDED_FOR, REMOTE_ADDR, REMOTE_PORT, REQUEST_METHOD, REQUEST_URI, QUERY_STRING, HTTP_CF_CONNECTING_IP, HTTP_CLIENT_IP, HTTP_X_REAL_IP, HTTP_X_PURPOSE, HTTP_X_FB_HTTP_ENGINE

The result of executing the function is an associative array:

An example of the implementation of sending a request:

$curl = curl_init( 'https://www.altercpa.one/fltr/123-abcd-45' );
curl_setopt( $curl, CURLOPT_POST, true );
curl_setopt( $curl, CURLOPT_POSTFIELDS, $_SERVER );
curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
$result = curl_exec( $curl );
curl_close( $curl );
$result = $result ? json_decode( $result, true ) : [];
if ( isset( $result['action'] && $result['action'] == 'allow' ) {
    include( 'target-index.php' );
} else include( 'dummy-index.php' );

Successful server responce example:

{
   "status": "ok",
   "action": "allow",
   "url": "http://black.site/url"
}

Error response example:

{
   "status": "error",
   "error": "access-denied"
}

Campaign setup

URL: https://www.altercpa.one/api/filter/set.json?id={token}&domain={host}

The function modifies the filtering campaign parameters or creates a new campaign. If a campaign identifier is passed in the uid field, the function will modify the existing campaign by this identifier. If the identifier is not passed, but the campaign domain is provided in the domain field, the function will attempt to find a campaign with the specified domain, and if it does not exist, it will create a new one.

The function can accept the following parameters:

The result of the function execution is an associative array:

Successful server responce example:

{
    "status": "ok",
    "id": 4567,
    "api": "https://www.altercpa.one/fltr/123-654b807372f614e64b9-4567"
}

Error response example:

{
    "status": "error",
    "error": "no-domain"
}

Campaigns list

URL: https://www.altercpa.one/api/filter/list.json?id={token}

The function returns a list of campaigns created in the traffic filtering section. The function does not have additional parameters.

The result of the function is a list of associative arrays with the following fields:

Successful server responce example:

[
    {
        "id": 4567,
        "api": "https://www.altercpa.one/fltr/123-654b807372f614e64b9-4567",
        "domain": "pretty-domain.com",
        "mode": 0,
        "stats": {
            "click": 180,
            "black": 123,
            "white": 57,
            "leads": 11,
            "approve": 6,
            "cancel": 1,
            "cash": 387.44,
            "cr": 8.94,
            "epc": 3.15,
            "appr": 54.55
        }
    },
    ...
]

Get campaign info

URL: https://www.altercpa.one/api/filter/get.json?id={token}&domain={host}

The function returns filtering campaign data. If a campaign identifier is passed in the uid field, the function will retrieve the campaign through this identifier. If a campaign domain is passed in the domain field, the function will attempt to find a campaign with the specified domain.

The function can take the following parameters as input:

The result of the function is an associative array with the following fields:

Successful server responce example:

{
    "id": 4567,
    "api": "https://www.altercpa.one/fltr/123-654b807372f614e64b9-4567",
    "domain": "pretty-domain.com",
    "mode": 0,
    "geo": [ "ru", "ua", "by" ],
    "mblack": 1,
    "black": "https://my-main-page.com/",
    "mwhite": 0,
    "white": "http://natribu.org/",
    "trash": 0,
    "proto": 0,
    "mobile": 0,
    "os": [],
    "browser": [],
    "ignore": false,
    "ipmain": false,
    "lang": false,
    "adid": false,
    "list": [],
    "langs": [],
    "nogeo": [],
    "uwl": [],
    "ubl": [],
    "wl": [],
    "stats": {
        "click": 180,
        "black": 123,
        "white": 57,
        "leads": 11,
        "approve": 6,
        "cancel": 1,
        "cash": 387.44,
        "cr": 8.94,
        "epc": 3.15,
        "appr": 54.55
    },
    "postback": {
        "new": "https://www.altercpa.one/api/filter/postback.json?id=123-654b807372f614e64b9&uid=11&status=new",
        "approve": "https://www.altercpa.one/api/filter/postback.json?id=123-654b807372f614e64b9&uid=11&status=approve",
        "paid": "https://www.altercpa.one/api/filter/postback.json?id=123-654b807372f614e64b9&uid=11&status=approve&payout={payout}",
        "cancel": "https://www.altercpa.one/api/filter/postback.json?id=123-654b807372f614e64b9&uid=11&status=cancel"
    }
}

Error response example:

{
    "status": "error",
    "error": "no-site"
}

Delete campaign

URL: https://www.altercpa.one/api/filter/del.json?id={token}&domain={host}

The function deletes a filtering campaign. If the campaign identifier is passed in the uid field, the function will delete the campaign by this identifier. If the campaign domain is passed in the domain field, the function will attempt to find the campaign with the specified domain.

The function can accept the following parameters:

The result of the function execution is an associative array:

Successful server responce example:

{
    "status": "ok",
    "id": 4567
}

Error response example:

{
    "status": "error",
    "error": "no-site"
}

Download filtering file

URL: https://www.altercpa.one/api/filter/make.json?id={token}&domain={host}

This function downloads a prepared file for the filter campaign. If the campaign identifier is passed in the uid field, the function will extract the campaign by this identifier. If the campaign domain is passed in the domain field, the function will attempt to find the campaign with the specified domain. The response of the function is the index.php file.

The function can accept the following parameters:

The result of the function execution is the index.php file in case of success, or an associative array in case of error:

Block IP address or header

URL: https://www.altercpa.one/api/filter/block.json?id={token}&list={list}&ip={ip}

This function adds data to the selected personal blacklist. It can block both IP addresses and ranges, as well as headers. The contents of the fields and the used identifiers are described in the blacklist documentation.

The function can accept the following parameters:

The result of the function execution is an associative array:

Successful server responce example:

{
    "status": "ok",
    "id": 1234567
}

Error response example:

{
    "status": "error",
    "error": "bad-list"
}

Send postback to mini-tracker

URL: https://www.altercpa.one/api/filter/postback.json?id={token}&uid={uid}&status={status}

This function is responsible for operating the built-in mini-tracker. It increases the lead counters with statuses like waiting, approval, and cancellation, as well as increments the earnings amount. It does not support any event deduplication.

The function can accept the following parameters:

The result of the function execution is an associative array:

Successful server responce example:

{
    "status": "ok"
}

Error response example:

{
    "status": "error",
    "error": "bad-status"
}

Integration with tracker

Integration functions are responsible for connecting third-party services and transmitting conversion data.

Postback

URL: https://www.altercpa.one/api/tracker/postback.json?id={token}&click={click}

The most important function of interaction with the tracker. Creates a new lead or modifies an existing lead based on the click or flow IDs sent. You can use two calling options:

• Standard operation: with the click parameter. The data for the lead is taken from the click ID. Used by default, this is the recommended approach.
• Fallback operation: with the flow and subid parameters. The data for the lead is taken from the stream ID, the uniqueness of the request is determined by the subid parameter. Suitable for cases where there is no concept of a click and a click on a link, for example, for application integration.

The function can take the following parameters as input:

The result of the function is an associative array:

Example of a successful server response:

{
    "status": "ok",
    "id": 1337,
    "create": true,
    "stage": "new"
}

Example of a server response with an error:

{
    "status": "error",
    "error": "no-changes"
}

Spend import

URL: https://www.altercpa.one/api/tracker/spend.json?id={token}

The function sets the click price for traffic according to the specified conditions. Allows you to use the ROI calculation functionality. Data can be transmitted in both GET and POST requests. The request must contain the cpc or cost parameters and at least one condition (dates, flow, UTM tags).

The function can take the following parameters as input:

You can also simultaneously update several price tags with one request; to do this, combine all requests into a batch array and send it via POST, for example:

{
    "batch": [
        {
            "flow": "face",
            "cost": 1984,
            "currency": "usd"
        },
        {
            "from": "2020-04-04 00:00:00",
            "to": "2020-04-07 23:59:59",
            "cpc": 1.337,
            "currency": "eur"
        }
    ]
}

The result of the function is an associative array:

Example of a successful server response:

{
    "status": "ok",
    "ok": 1,
    "bad": 0
}

Example of a server response with an error:

{
    "status": "error",
    "error": "empty"
}

Statistics of tracker

Statistics functions provide access to reports on leads and clicks.

Leads list

URL: https://www.altercpa.one/api/tracker/leads.json?id={token}

The function retrieves the list of leads and returns it as an associative array in the leads field. The function has no formal limits on the number of leads displayed, but it is not recommended to load more than a thousand leads at a time. If you get a 500 error, it means that there was not enough memory for your request, you need to reduce the request period.

The function can accept the following GET filtering parameters as input:

The result of the function is an associative array:

Inside the leads field, leads are represented by an associative array with fields:

Example of a successful server response:

{
    "status": "ok",
    "leads": [
        {
            "id": 1,
            "time": 1691303223,
            "click": "ac13",
            "uid": "c1vvkg272m16",
            "flow": "ecb4",
            "way": 123,
            "site": 42,
            "siteurl": "https://meow.pro/c8/cfb72fe561f0/",
            "filter": 0,
            "status": "approve",
            "custom": "Confirmed",
            "goal": "paid",
            "price": 18,
            "currency": "usd",
            "ip": "12.34.56.78",
            "geo": "de",
            "name": "Hans",
            "phone": "+49 (30) 226-511-83",
            "email": "[email protected]",
            "comment": "Confirmed on sunday",
            "meta": {
                "foo": "bar",
                "bar": "foo"
            },
            "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Safari\605.1.15",
            "referer": "https://meow.pro/c8/cfb72fe561f0/?subid=purr",
            "adid": "bf9d4aa8-4979-11ee-94c6-005056aec456",
            "data1": "wj80b89eit8epaarikhe2oge",
            "data2": false,
            "utm_source": "fb",
            "utm_campaign": "1013444211662",
            "utm_content": "432211555332166",
            "utm_term": false,
            "utm_medium": false,
            "domain": "meow.pro",
            "subid": "purr"
        },
        ...
    ]
}

Example of a server response with an error:

{
    "status": "error",
    "error": "payment-required"
}

Click statistics

URL: https://www.altercpa.one/api/tracker/stats.json?id={token}

The function collects general statistics on the number of clicks and leads, broken down by goals for the selected period according to the specified criterion.

The function can accept the following GET filtering parameters as input:

The result of the function is an associative array:

The stats array and the total field are an associative array:

Example of a successful server response:

{
    "status": "ok",
    "stats": {
        "20230805": {
            "id": 20230805,
            "name": "2023-08-05",
            "click": 44,
            "unique": 22,
            "total": 6,
            "cv": 4,
            "cn": 1,
            "ch": 1,
            "ca": 2,
            "cc": 0,
            "ct": 2,
            "mh": 20.0,
            "ma": 135.0,
            "mt": 155.0,
            "cr": 18.2,
            "epc": 6.75,
            "appr": 66.7,
            "app": 33.3
        },
        ...
    },
    "total": {
        "click": 175,
        "unique": 58,
        "total": 25,
        "cv": 23,
        "cn": 11,
        "ch": 8,
        "ca": 9,
        "cc": 0,
        "ct": 2,
        "mh": 160.0,
        "ma": 1200.0,
        "mt": 1360.0,
        "cr": 5.17,
        "epc": 12.3,
        "appr": 46.7,
        "app": 31.0
    }
}

Example of a server response with an error:

{
    "status": "error",
    "error": "no-item"
}