API documentation

The tracker APIs allow you to work with 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!

Integration

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

Postback

URL: https://www.altercpa.red/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.red/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

Statistics functions provide access to reports on leads and clicks.

Leads list

URL: https://www.altercpa.red/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.red/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"
}