Lead: Publisher API Integration

How to receive leads from publishers via API and the supported parameters.

Updated over a week ago

Publisher API Integration for Lead Generation

Publishers are often interested in sending leads via API. Swaarm has introduced this functionality to streamline the entire process, facilitating seamless automation from the publisher to the advertiser. Employing this method, publishers can efficiently transmit leads to Swaarm.

Lead API Request

The request can be made to the following using the GET method:

https://track.INSERT_DOMAIN_HERE.swaarm-clients.com/leads?

Parameters

The following parameters can be added to the query string:

Parameter

Definition

Example

fullName

User Full Name

James Robert

details_email

User Email address

details_phone

User phone number

+49738862141

details_freeParameters_param1

Free Parameters 1

examplecode123

details_freeParameters_param2

Free Parameters 2

examplecode123

details_freeParameters_param3

Free Parameters 3

examplecode123

details_freeParameters_param4

Free Parameters 4

examplecode123

details_freeParameters_param5

Free Parameters 5

examplecode123

jsonData

Json Data

offer_id

Swaarm Offer ID

20

publisher_id

Swaarm Publisher ID

5

publisher_subId

Publisher sub source ID

xyz123

publisher_site

Publisher site ID/name

test_site

publisher_app

Publisher App

test_app

geo_country

Country name or Code

US

geo_city

City name or code

New York

Example of API Request for Incoming Lead

The following request is an example how the request should be sent by the publisher in order to create a lead:


โ€‹https://track.INSERT_DOMAIN_HERE.swaarm-clients.com/leads?fullName=Full+Name+5787&details_email=test320%40swaarm.com&details_phone=%2B49738862141&details_freeParameters_param1=Free+Param1+1621&details_freeParameters_param2=Free+Param2+2287&details_freeParameters_param3=Free+Param3+5829&details_freeParameters_param4=Free+Param4+136&details_freeParameters_param5=Free+Param5+6373&details_freeParameters_param6=Free+Param6+9111&jsonData=&offer_id=16832&publisher_id=18&publisher_subId=subid+8150&publisher_subSubId=subsubid+1861&publisher_site=site+1214&publisher_app=app+5868&geo_country=usa&geo_city=new+york


โ€‹

โœ๏ธ Replace Domain

The domain INSERT_DOMAIN_HERE should be replaced by the original domain.

Did this answer your question?