This site uses cookies. By continuing, your consent is assumed. More…
Continue
affiliate network

How to use Postback URL?

If, when working with Admitad, you use your own system of sales and leads statistics, you can add your server's postback URL to our system, and instantly get information about completed conversions.

Own statistics system is convenient because you can obtain all initial data about the target action, and convert it at your discretion to necessary tables, graphs, charts, or use it in your own applications. It also facilitates working with several affiliate networks, as all the stats will be gathered in one location. The data is transmitted using GET or POST HTTP requests from the Admitad server to your server.

You may use over 20 parameters that contain all possible information about the action — from the moment when the customer clicks on your affiliate link, to the status of your earnings. Properly analyzed, all this data may significantly help you to improve conversion rate of your advertisements.

 

Step 1

Select Postback URL in theTools menu, and click Add Postback URL. You can add several postback URLs, and configure them for various purposes.

 

Step 2

The Add a new Postback URL page has several drop-down lists in the top, which can be used for filtering the data that the system will send to you. From the Event type menu, select the event for which the information will be transmitted to this Postback URL:

Action — the request will be triggered upon every conversion, i.e., a lead or a sale.

Program status — the request is sent upon changes in the status of the affiliate program to which you are connected. For example, upon confirmation of cooperation, in case of discontinuance of the program or if you are disconnected from it.

A referral joined — the data will be transferred upon registration of the new publishers that you brought to Admitad through your referral link.

Note
This refers to the built-in Admitad referral program, the information about which can be viewed at the Dashboard in the Admitad Referral program block. The information about referral programs Admitad Global, Admitad TR, etc. will not be transmitted in case of this event. To obtain statistics for these, use the Action event type, same as for usual affiliate programs.

 

Step 3

Select the ad space for which you wish to retrieve statistics.

You can also select All ad spaces, and sort all actions in your system by parameters Ad space name or Ad space ID. Details about available parameters will be shown below.

 

Step 4

Specify the affiliate program conversions you would like to receive information about.

Here you can also leave the All programs item.

 

Step 5

If you specify a certain affiliate program from the list, the Rate menu will also be available for you.

In this case, you can also select nothing, and information will be transmitted for all tariffs.


 

Step 6

If a specific tariff has not been selected, you can specify the desired action type — Sale, Lead or leave All.

Sale — is an action when the user has confirmed the order at the website of the online store. However, this order may still be edited in the future, or it can be completely canceled.

Lead — is user’s action that may imply registration, subscription to newsletters, installation of the application, or reaching a certain level in an online game.

 

Step 7

Specify the type of request that you would prefer to use for obtaining information.

The main difference between the GET and the POST methods is the way of transmitting the data. The GET method sends all collected information as a part of the URL, by adding the parameters and their values to the end of the link, while the POST method sends the data in the body of the request, rather than in the URL.

More information about the features of each method is available here.

 

Step 8

Select which statuses of payment for actions you would like to receive the data about.

Created > this status appears when a visitor you brought to the advertiser's website makes a purchase, installs an app, reaches the required level in an online game, etc., when you get a conversion scored and remuneration has been accrued. Until the advertiser confirms or declines it, the payment will remain in this status.

Confirmed > the payment for a committed target action has been confirmed by the advertiser.

Declined > the advertiser has not counted this purchase or lead after verification.

On hold > the payment has been confirmed, but was again placed on hold afterwards. Unlike this status, the Created status is assigned to the payments that had been first entered into the system.

 

Step 9

Enter the link to your server that will be used for receiving the HTTP request.

 

Step 10

Select one of the two editing modes.

 

Simple mode — is the mode where the query will contain the complete set of parameters, and the parameters themselves will have standard names adopted in the Admitad system.

 

Advanced mode allows you to create a list of desired parameters, and to assign the names that you are already using in your own system. To do so, just enter the Parameter name and drag the appropriate Parameter content from the right pane to the field to the right from the equality sign:

 

If you select the GET request, in the Generated link line you will see the URL, where the selected parameters and their contents are displayed after symbol ?:

This is what the link will look like for HTTP requests to your server, but [[[...]]] will be substituted by real parameters values.

 

Step 11

Now that you have defined the required parameters, it's time to check whether your system receives data from Admitad. To do so, in the bottom of the page, click Test.

 

Depending on the selected request type, you will see in the opened window:

GET

POST

 

The URL with the test parameter values that will be sent to your server. By editing the code, you can replace these values with your own values.

 

The top field displays the URL that will be used for the request, and the bottom one displays the parameters and their test values from the body of the request. In this case you cannot insert your own test values.

 

Click the Test button to send the request, and you will see a message next to it:

The request has been sent to your address.

 

Next, you have to check the receipt of the sent data in your statistics system.

If the request has been successful, but no data arrived, contact our support team.

 

If the server does not accept POST requests, is unavailable, or its address has been specified incorrectly, you will see the following message:

An error occurred during the request. Check the address.

 

 

Step 12

If you are sure that correct data arrives to your server, close the test window and save the new Postback URL.

Now it will appear in your table below:

and you will be able to return to editing or testing it in column Settings.

 

 

The types of parameters and their valid values

Parameters for event type “Action”

Name

Type

Description

offer_id

integer

Affiliate program ID

offer_name

string

Affiliate program name

admitad_id

integer

Payment ID

website_name

string

Ad space name

website_id

integer

Ad space ID

subid

string

SubID

action

string

Tariff (or rate) name

subid1

string

SubID1

subid2

string

SubID2

subid3

string

SubID3

subid4

string

SubID4

payment_sum

real

Amount of your earnings

payment_status

 



 

string, allowed values:

Payment status

new

- the new payment that has been neither confirmed nor declined yet

approved

- payment confirmed

declined

- payment declined

pending

- confirmed payment placed on hold again

currency

string (max. length = 3)

Program currency

order_id

integer

Order number

order_sum

real

Order amount

click_time

Unix-time

Click time

time

Unix-time

Action time

conversion_time

integer

 

Duration of conversion (in seconds) is the time elapsed from the moment of the click to the moment of the action (conversion)

 

type


 

string, allowed values:

Action type

 

 

 

 

lead

sale

action_ip

string

Action IP in the format 255.255.255.255

user_agent

string

User-Agent

user_referer

string

User-Refferer

click_ip

string

Click IP in the format 255.255.255.255

 

 

Parameters for event type “Program status”

Name

Type

Description

offer_id

integer

Affiliate program ID

offer_name

string

Affiliate program name

offer_status






 

string, allowed values:

New status of the affiliate program

active

- the affiliate program is active and cooperates with you

denied

- the program has declined your request for cooperation

disabled

- the program has been deactivated, but may again become active

dead

- the program has been closed, and will no longer work in the Admitad network