MENU navbar-image

Introduction

The Qliker API is a powerful tool that opens up a world of possibilities for harnessing the potential of click tracking and analytics. Designed to seamlessly integrate with your applications, websites, and services, the Qliker API empowers you to take control of your data and make informed decisions based on real-time insights.

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking on API (https://qliker.io/app/api) and Generate API token.

Tracking Links

APIs for managing tracking links

requires authentication

Example request:
curl --request GET \
    --get "https://api.qliker.io/v1/links?skip=12&take=10&group_id=1&include_archived=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/links"
);

const params = {
    "skip": "12",
    "take": "10",
    "group_id": "1",
    "include_archived": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.qliker.io/v1/links',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'skip' => '12',
            'take' => '10',
            'group_id' => '1',
            'include_archived' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success",
    "links": [
        {
            "id": 1,
            "name": "Dr. Adalberto Beer",
            "slug": "dr-adalberto-beer",
            "group_id": null,
            "archived": 0,
            "created_at": "2023-08-08 11:33:19",
            "updated_at": "2023-08-08 11:33:19"
        },
        {
            "id": 2,
            "name": "Bonita Carter I",
            "slug": "bonita-carter-i",
            "group_id": null,
            "archived": 0,
            "created_at": "2023-08-08 11:33:19",
            "updated_at": "2023-08-08 11:33:19"
        },
        {
            "id": 3,
            "name": "Kenneth Kemmer",
            "slug": "kenneth-kemmer",
            "group_id": null,
            "archived": 0,
            "created_at": "2023-08-08 11:33:19",
            "updated_at": "2023-08-08 11:33:19"
        }
    ]
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

requires authentication

Example request:
curl --request GET \
    --get "https://api.qliker.io/v1/links/details?id=17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/links/details"
);

const params = {
    "id": "17",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.qliker.io/v1/links/details',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'id' => '17',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success",
    "link": {
        "id": 1,
        "name": "Dr. Adalberto Beer",
        "slug": "dr-adalberto-beer",
        "group_id": null,
        "primary_url": "https://page.programmer.in.rs/page.php",
        "domain_id": null,
        "url_backup": null,
        "url_mob": null,
        "url_mob_ios": null,
        "url_repeart": null,
        "blocked_url": null,
        "archived": 0,
        "created_at": "2023-08-08 11:33:19",
        "updated_at": "2023-08-08 11:33:19"
    }
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

requires authentication

Example request:
curl --request GET \
    --get "https://api.qliker.io/v1/links/stats?links_id=9&from=2023-04-14&to=2023-04-14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/links/stats"
);

const params = {
    "links_id": "9",
    "from": "2023-04-14",
    "to": "2023-04-14",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.qliker.io/v1/links/stats',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'links_id' => '9',
            'from' => '2023-04-14',
            'to' => '2023-04-14',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
 "status": "success",
 "stats": {
     'id': 1,
     'tcl': 21667,
     'ucl': 20623,
     'gur': 76.4%,
     'ipq': 89.3%,
     'fcl': 0,
     'bcl': 0,
     'act': 44,
     'acr': 0.2%,
     'eng': 0,
     'ecr': 0%,
     'usl': 9,
     'uscr': 0%,
     'rsl': 0,
     'rscr': 0%,
     'recent_clicks': '2023-04-25 10:28:17',
     'recent_actions': '2023-04-25 10:28:17',
     'recent_engagements': '2023-04-25 10:28:17',
     'recent_sales': '2023-04-25 10:28:17'
     }
 }
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

requires authentication

Example request:
curl --request DELETE \
    "https://api.qliker.io/v1/links/14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/links/14"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.qliker.io/v1/links/14',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success"
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

requires authentication

Example request:
curl --request PATCH \
    "https://api.qliker.io/v1/links/1?name=My+Rotator&primary_url=my-rotator&track_link=my-rotator&domain_id=18&cloak=1&cloak_title=My+Title&cloak_descr=Description+text&cloak_img_url=https%3A%2F%2Fqliker.test%2Fimg%2Flogo.png&frontend=1&cost=0.5&cost_type=total&cpcfilter=1&geotarget_add=1&geotarget_countries_inc=RS%7CHR%7CEN&geotarget_countries_block=RS%7CHR%7CEN&browsertarget_add=1&browsertarget_list_inc=Mozilla&browsertarget_list_block=Mozilla&systemtarget_add=1&systemtarget_list_inc=Windows&systemtarget_list_block=Windows&url_backup=https%3A%2F%2Fqliker.io&url_mob=https%3A%2F%2Fqliker.io&url_mob_ios=https%3A%2F%2Fqliker.io&url_repeart=velit&blocked_url=https%3A%2F%2Fqliker.io&unique_type=none&filtering_bad_click=B&filtering_proxy=B&filtering_spider=B&filtering_server=B&filtering_bad_user=B&link_passwd=1234&max_clicks=200&max_clicks_raw=200&pixels=cum&notes=voluptas&disable_pixels=1&blank_ref=1&skip_url_verf=1&traffic_tablet=M" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/links/1"
);

const params = {
    "name": "My Rotator",
    "primary_url": "my-rotator",
    "track_link": "my-rotator",
    "domain_id": "18",
    "cloak": "1",
    "cloak_title": "My Title",
    "cloak_descr": "Description text",
    "cloak_img_url": "https://qliker.test/img/logo.png",
    "frontend": "1",
    "cost": "0.5",
    "cost_type": "total",
    "cpcfilter": "1",
    "geotarget_add": "1",
    "geotarget_countries_inc": "RS|HR|EN",
    "geotarget_countries_block": "RS|HR|EN",
    "browsertarget_add": "1",
    "browsertarget_list_inc": "Mozilla",
    "browsertarget_list_block": "Mozilla",
    "systemtarget_add": "1",
    "systemtarget_list_inc": "Windows",
    "systemtarget_list_block": "Windows",
    "url_backup": "https://qliker.io",
    "url_mob": "https://qliker.io",
    "url_mob_ios": "https://qliker.io",
    "url_repeart": "velit",
    "blocked_url": "https://qliker.io",
    "unique_type": "none",
    "filtering_bad_click": "B",
    "filtering_proxy": "B",
    "filtering_spider": "B",
    "filtering_server": "B",
    "filtering_bad_user": "B",
    "link_passwd": "1234",
    "max_clicks": "200",
    "max_clicks_raw": "200",
    "pixels": "cum",
    "notes": "voluptas",
    "disable_pixels": "1",
    "blank_ref": "1",
    "skip_url_verf": "1",
    "traffic_tablet": "M",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.qliker.io/v1/links/1',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'name' => 'My Rotator',
            'primary_url' => 'my-rotator',
            'track_link' => 'my-rotator',
            'domain_id' => '18',
            'cloak' => '1',
            'cloak_title' => 'My Title',
            'cloak_descr' => 'Description text',
            'cloak_img_url' => 'https://qliker.test/img/logo.png',
            'frontend' => '1',
            'cost' => '0.5',
            'cost_type' => 'total',
            'cpcfilter' => '1',
            'geotarget_add' => '1',
            'geotarget_countries_inc' => 'RS|HR|EN',
            'geotarget_countries_block' => 'RS|HR|EN',
            'browsertarget_add' => '1',
            'browsertarget_list_inc' => 'Mozilla',
            'browsertarget_list_block' => 'Mozilla',
            'systemtarget_add' => '1',
            'systemtarget_list_inc' => 'Windows',
            'systemtarget_list_block' => 'Windows',
            'url_backup' => 'https://qliker.io',
            'url_mob' => 'https://qliker.io',
            'url_mob_ios' => 'https://qliker.io',
            'url_repeart' => 'velit',
            'blocked_url' => 'https://qliker.io',
            'unique_type' => 'none',
            'filtering_bad_click' => 'B',
            'filtering_proxy' => 'B',
            'filtering_spider' => 'B',
            'filtering_server' => 'B',
            'filtering_bad_user' => 'B',
            'link_passwd' => '1234',
            'max_clicks' => '200',
            'max_clicks_raw' => '200',
            'pixels' => 'cum',
            'notes' => 'voluptas',
            'disable_pixels' => '1',
            'blank_ref' => '1',
            'skip_url_verf' => '1',
            'traffic_tablet' => 'M',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success"
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

requires authentication

Example request:
curl --request POST \
    "https://api.qliker.io/v1/links?name=My+Rotator&primary_url=my-rotator&track_link=my-rotator&domain_id=18&cloak=&cloak_title=My+Title&cloak_descr=Description+text&cloak_img_url=https%3A%2F%2Fqliker.test%2Fimg%2Flogo.png&frontend=1&cost=0.5&cost_type=total&cpcfilter=1&geotarget_add=1&geotarget_countries_inc=RS%7CHR%7CEN&geotarget_countries_block=RS%7CHR%7CEN&browsertarget_add=1&browsertarget_list_inc=Mozilla&browsertarget_list_block=Mozilla&systemtarget_add=1&systemtarget_list_inc=Windows&systemtarget_list_block=Windows&url_backup=https%3A%2F%2Fqliker.io&url_mob=https%3A%2F%2Fqliker.io&url_mob_ios=https%3A%2F%2Fqliker.io&url_repeart=eos&blocked_url=https%3A%2F%2Fqliker.io&unique_type=none&filtering_bad_click=B&filtering_proxy=B&filtering_spider=B&filtering_server=B&filtering_bad_user=B&link_passwd=1234&max_clicks=200&max_clicks_raw=200&pixels=cumque&notes=deserunt&disable_pixels=1&blank_ref=1&skip_url_verf=1&traffic_tablet=M" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/links"
);

const params = {
    "name": "My Rotator",
    "primary_url": "my-rotator",
    "track_link": "my-rotator",
    "domain_id": "18",
    "cloak": "0",
    "cloak_title": "My Title",
    "cloak_descr": "Description text",
    "cloak_img_url": "https://qliker.test/img/logo.png",
    "frontend": "1",
    "cost": "0.5",
    "cost_type": "total",
    "cpcfilter": "1",
    "geotarget_add": "1",
    "geotarget_countries_inc": "RS|HR|EN",
    "geotarget_countries_block": "RS|HR|EN",
    "browsertarget_add": "1",
    "browsertarget_list_inc": "Mozilla",
    "browsertarget_list_block": "Mozilla",
    "systemtarget_add": "1",
    "systemtarget_list_inc": "Windows",
    "systemtarget_list_block": "Windows",
    "url_backup": "https://qliker.io",
    "url_mob": "https://qliker.io",
    "url_mob_ios": "https://qliker.io",
    "url_repeart": "eos",
    "blocked_url": "https://qliker.io",
    "unique_type": "none",
    "filtering_bad_click": "B",
    "filtering_proxy": "B",
    "filtering_spider": "B",
    "filtering_server": "B",
    "filtering_bad_user": "B",
    "link_passwd": "1234",
    "max_clicks": "200",
    "max_clicks_raw": "200",
    "pixels": "cumque",
    "notes": "deserunt",
    "disable_pixels": "1",
    "blank_ref": "1",
    "skip_url_verf": "1",
    "traffic_tablet": "M",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.qliker.io/v1/links',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'name' => 'My Rotator',
            'primary_url' => 'my-rotator',
            'track_link' => 'my-rotator',
            'domain_id' => '18',
            'cloak' => '0',
            'cloak_title' => 'My Title',
            'cloak_descr' => 'Description text',
            'cloak_img_url' => 'https://qliker.test/img/logo.png',
            'frontend' => '1',
            'cost' => '0.5',
            'cost_type' => 'total',
            'cpcfilter' => '1',
            'geotarget_add' => '1',
            'geotarget_countries_inc' => 'RS|HR|EN',
            'geotarget_countries_block' => 'RS|HR|EN',
            'browsertarget_add' => '1',
            'browsertarget_list_inc' => 'Mozilla',
            'browsertarget_list_block' => 'Mozilla',
            'systemtarget_add' => '1',
            'systemtarget_list_inc' => 'Windows',
            'systemtarget_list_block' => 'Windows',
            'url_backup' => 'https://qliker.io',
            'url_mob' => 'https://qliker.io',
            'url_mob_ios' => 'https://qliker.io',
            'url_repeart' => 'eos',
            'blocked_url' => 'https://qliker.io',
            'unique_type' => 'none',
            'filtering_bad_click' => 'B',
            'filtering_proxy' => 'B',
            'filtering_spider' => 'B',
            'filtering_server' => 'B',
            'filtering_bad_user' => 'B',
            'link_passwd' => '1234',
            'max_clicks' => '200',
            'max_clicks_raw' => '200',
            'pixels' => 'cumque',
            'notes' => 'deserunt',
            'disable_pixels' => '1',
            'blank_ref' => '1',
            'skip_url_verf' => '1',
            'traffic_tablet' => 'M',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success"
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

Tracking Rotators

APIs for managing tracking rotators

GET v1/rotators

requires authentication

Example request:
curl --request GET \
    --get "https://api.qliker.io/v1/rotators?skip=15&take=10&group_id=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/rotators"
);

const params = {
    "skip": "15",
    "take": "10",
    "group_id": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.qliker.io/v1/rotators',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'skip' => '15',
            'take' => '10',
            'group_id' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success",
    "rotators": [
        {
            "id": 9,
            "name": "Sandrine Gutkowski",
            "slug": "sandrine-gutkowski",
            "mode": "fulfillment",
            "group_id": null,
            "created_at": "2023-08-08 11:33:19",
            "updated_at": "2023-08-08 11:33:19"
        },
        {
            "id": 19,
            "name": "Audreanne Crooks",
            "slug": "audreanne-crooks",
            "mode": "random",
            "group_id": null,
            "created_at": "2023-08-08 11:33:19",
            "updated_at": "2023-08-08 11:33:19"
        },
        {
            "id": 20,
            "name": "Dr. Deborah Klein DDS",
            "slug": "dr-deborah-klein-dds",
            "mode": "sequential",
            "group_id": null,
            "created_at": "2023-08-08 11:33:19",
            "updated_at": "2023-08-08 11:33:19"
        }
    ]
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

Request      

GET v1/rotators

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Accept      

Example: application/json

Query Parameters

skip   integer  optional  

Position to paginate. Defaults to '0'. Example: 15

take   integer  optional  

The number of links to retrieve at one time, based on the skip position. Default 10. Example: 10

group_id   integer  optional  

Return only the links in the group specified by the group_id. Example: 1

GET v1/rotators/details

requires authentication

Example request:
curl --request GET \
    --get "https://api.qliker.io/v1/rotators/details?id=10" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/rotators/details"
);

const params = {
    "id": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.qliker.io/v1/rotators/details',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'id' => '10',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "rotators": "success",
    "rotator": {
        "id": 80,
        "name": "Alec Funk",
        "slug": "alec-funk",
        "group_id": null,
        "mode": "fulfillment",
        "domain_id": null,
        "backup_url": "http://page.programmer.in.rs/page.php",
        "blocked_url": null,
        "url_mob": null,
        "url_mob_ios": null,
        "archived": 0,
        "created_at": "2023-08-08 11:33:19",
        "updated_at": "2023-08-08 11:33:19"
    }
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

Request      

GET v1/rotators/details

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Accept      

Example: application/json

Query Parameters

id   integer   

Rotator ID. Example: 10

GET v1/rotators/stats

requires authentication

Example request:
curl --request GET \
    --get "https://api.qliker.io/v1/rotators/stats?rotator_id=19&from=2023-04-14&to=2023-04-14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/rotators/stats"
);

const params = {
    "rotator_id": "19",
    "from": "2023-04-14",
    "to": "2023-04-14",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.qliker.io/v1/rotators/stats',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'rotator_id' => '19',
            'from' => '2023-04-14',
            'to' => '2023-04-14',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
 "status": "success",
 "stats": {
     'id': 1,
     'mode': 'random',
     'url': 7,
     'tcl': 21667,
     'ucl': 20623,
     'fcl': 0,
     'bcl': 0,
     'bcu': 0,
     'mcl': 0
     }
 }
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

Request      

GET v1/rotators/stats

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Accept      

Example: application/json

Query Parameters

rotator_id   integer   

Rotator ID. Example: 19

from   string  optional  

The ISO-8601 timestamp YYYY-MM-DD for the starting date and time of the time range for the link stats. Must be used in conjunction with 'to'. Example: Example: 2023-04-14

to   string  optional  

The ISO-8601 timestamp YYYY-MM-DD for the ending date and time of the time range for the link stats. Must be used in conjunction with 'from'. Example: 2023-04-14

DELETE v1/rotators/{rotator_id}

requires authentication

Example request:
curl --request DELETE \
    "https://api.qliker.io/v1/rotators/qui?id=7" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/rotators/qui"
);

const params = {
    "id": "7",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.qliker.io/v1/rotators/qui',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'id' => '7',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success"
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

Request      

DELETE v1/rotators/{rotator_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Accept      

Example: application/json

URL Parameters

rotator_id   string   

The ID of the rotator. Example: qui

Query Parameters

id   integer   

Rotator ID. Example: 7

PATCH v1/rotators/{rotator_id}

requires authentication

Example request:
curl --request PATCH \
    "https://api.qliker.io/v1/rotators/12?name=My+Rotator&rotators_link=my-rotator&rotators_mode=spillover&rotators_spillover_mode=backup_url&rotators_random_mode=random_url&rotators_sequential_mode=next_url&domain_id=18&cloak=&cloak_title=My+Title&cloak_descr=Description+text&cloak_img_url=https%3A%2F%2Fqliker.test%2Fimg%2Flogo.png&geotarget_add=1&geotarget_countries_inc=RS%7CHR%7CEN&geotarget_countries_block=RS%7CHR%7CEN&browsertarget_add=1&browsertarget_list_inc=Mozilla&browsertarget_list_block=Mozilla&systemtarget_add=1&systemtarget_list_inc=Windows&systemtarget_list_block=Windows&backup_url=https%3A%2F%2Fqliker.io&url_mob=https%3A%2F%2Fqliker.io&url_mob_ios=https%3A%2F%2Fqliker.io&blocked_url=https%3A%2F%2Fqliker.io&filtering_bad_click=B&filtering_proxy=B&filtering_spider=B&filtering_server=B&filtering_bad_user=B&rpixels=qui&notes=aspernatur&blank_ref=1&skip_url_verf=1&randomize_enable=1&randomize_min=1&randomize_realtime=1&randomize_ignore=1&randomize_ignore_first=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/rotators/12"
);

const params = {
    "name": "My Rotator",
    "rotators_link": "my-rotator",
    "rotators_mode": "spillover",
    "rotators_spillover_mode": "backup_url",
    "rotators_random_mode": "random_url",
    "rotators_sequential_mode": "next_url",
    "domain_id": "18",
    "cloak": "0",
    "cloak_title": "My Title",
    "cloak_descr": "Description text",
    "cloak_img_url": "https://qliker.test/img/logo.png",
    "geotarget_add": "1",
    "geotarget_countries_inc": "RS|HR|EN",
    "geotarget_countries_block": "RS|HR|EN",
    "browsertarget_add": "1",
    "browsertarget_list_inc": "Mozilla",
    "browsertarget_list_block": "Mozilla",
    "systemtarget_add": "1",
    "systemtarget_list_inc": "Windows",
    "systemtarget_list_block": "Windows",
    "backup_url": "https://qliker.io",
    "url_mob": "https://qliker.io",
    "url_mob_ios": "https://qliker.io",
    "blocked_url": "https://qliker.io",
    "filtering_bad_click": "B",
    "filtering_proxy": "B",
    "filtering_spider": "B",
    "filtering_server": "B",
    "filtering_bad_user": "B",
    "rpixels": "qui",
    "notes": "aspernatur",
    "blank_ref": "1",
    "skip_url_verf": "1",
    "randomize_enable": "1",
    "randomize_min": "1",
    "randomize_realtime": "1",
    "randomize_ignore": "1",
    "randomize_ignore_first": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.qliker.io/v1/rotators/12',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'name' => 'My Rotator',
            'rotators_link' => 'my-rotator',
            'rotators_mode' => 'spillover',
            'rotators_spillover_mode' => 'backup_url',
            'rotators_random_mode' => 'random_url',
            'rotators_sequential_mode' => 'next_url',
            'domain_id' => '18',
            'cloak' => '0',
            'cloak_title' => 'My Title',
            'cloak_descr' => 'Description text',
            'cloak_img_url' => 'https://qliker.test/img/logo.png',
            'geotarget_add' => '1',
            'geotarget_countries_inc' => 'RS|HR|EN',
            'geotarget_countries_block' => 'RS|HR|EN',
            'browsertarget_add' => '1',
            'browsertarget_list_inc' => 'Mozilla',
            'browsertarget_list_block' => 'Mozilla',
            'systemtarget_add' => '1',
            'systemtarget_list_inc' => 'Windows',
            'systemtarget_list_block' => 'Windows',
            'backup_url' => 'https://qliker.io',
            'url_mob' => 'https://qliker.io',
            'url_mob_ios' => 'https://qliker.io',
            'blocked_url' => 'https://qliker.io',
            'filtering_bad_click' => 'B',
            'filtering_proxy' => 'B',
            'filtering_spider' => 'B',
            'filtering_server' => 'B',
            'filtering_bad_user' => 'B',
            'rpixels' => 'qui',
            'notes' => 'aspernatur',
            'blank_ref' => '1',
            'skip_url_verf' => '1',
            'randomize_enable' => '1',
            'randomize_min' => '1',
            'randomize_realtime' => '1',
            'randomize_ignore' => '1',
            'randomize_ignore_first' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success"
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

Request      

PATCH v1/rotators/{rotator_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Accept      

Example: application/json

URL Parameters

rotator_id   string   

integer Rotator ID. Example: 12

Query Parameters

name   string   

[ 4 .. 30 ] characters. Rotator's Name will help you to easily recognize what it's related to and will help you to easily manage your rotators once you have many. Rotator's name is for your own eyes only. Example: My Rotator

rotators_link   string   

[ 4 .. 30 ] characters. The main part of Rotator's link address is defined by your account username, but you can edit the last part of the address and define it in a way to help you recognize every of your rotator by their link names which will be handy for you. Example: my-rotator

rotators_mode   string   

Rotators mode: Fullfillment: Every new person clicking on your Rotator link will land on the very first Rotator URL until the maximum number of clicks for that first URL has been reached. Spillover: Every person that clicks on your Rotator link will go to the first URL, and the second time they click will be to the second URL, and so on. Every new person after that will still land on the first URL, and keep going down the list. Random: Every person that clicks on your Rotator link will simply go to a random URL. Sequential: Every person that clicks on your Rotator link will go down the list sequentially of your URLs. The first person will go to URL 1, the second person will go to URL 2, and so on. Enum: fulfillment, spillover, random, sequential Example: spillover

rotators_spillover_mode   string  optional  

Traffic on finish go to: Backup, Last Url or on top of rotator. Enum: backup_url, last_url, top_of_rotator Example: backup_url

rotators_random_mode   string  optional  

Send repeat clicks to same URL or random URL. Enum: same_url, random_url Example: random_url

rotators_sequential_mode   string  optional  

Send repeat clicks to same URL or next URL. Enum: same_url, next_url Example: next_url

domain_id   integer  optional  

If you have any custom Rotators domains set up to use with your Rotator. Example: 18

cloak   boolean  optional  

This option allows you to change your link destination (Primary URL) meta tags. Or by other words, if you use this option and paste your link to Facebook for example, Facebook will parse the information that you've set here instead of parsing the default Qliker's meta tags. Example 'false'. Example: false

cloak_title   string  optional  

Here you can change title meta tag for this link. Example: My Title

cloak_descr   string  optional  

Here you can change description meta tag for this link. Example: Description text

cloak_img_url   string  optional  

Here you can change image meta tag for this link. Example: https://qliker.test/img/logo.png

geotarget_add   boolean  optional  

With Geotargeting you're having the option to include or exclude visitors from specified countries from reaching and loading you Primary URL. Non included or excluded country visitors will end up loading the Backup link which you can also set among Advanced option. Example: true

geotarget_countries_inc   string  optional  

Here you can specify countries which you want to allow loading and reaching your Primary URL. All the other countries will automatically be considered blocked and visitors from blocked countries will then be sent to your Backup URL. You can find a full list of two-letter country codes in the International Banking (IBAN) Country Code List. f you use this parameter, all clicks from countries that are not explicitly included will be redirected through the backup_url. Example: RS|HR|EN

geotarget_countries_block   string  optional  

Here you can specify countries which you want to block from loading and reaching your Primary URL. Blocked visitors will then be sent to your Backup URL. You can find a full list of two-letter country codes in the International Banking (IBAN) Country Code List. Example: RS|HR|EN

browsertarget_add   boolean  optional  

With Browser targeting you have the option to include or exclude visitors using specified browsers from reaching and loading your Primary URL. Non included or excluded browser visitors will end up loading the Backup link which you can also set among Advanced option. Example: true

browsertarget_list_inc   string  optional  

Include visitors using specified browsers from reaching and loading your Primary URL. Enum: Opera, Opera Mini, WebTV, Edge, Internet Explorer, Pocket Internet Explorer, Konqueror, iCab, OmniWeb, Firebird, Firefox, Iceweasel, Shiretoko, Mozilla, Amaya, Lynx, Safari, Safari, Chrome, Android, GoogleBot, Yahoo! Slurp, W3C Validator, BlackBerry, IceCat, Nokia S60 OSS Browser, Nokia Browser, MSN Browser, MSN Bot, Bing Bot, Vivalidi, Netscape Navigator, Galeon, NetPositive, Phoenix, PlayStation Example: Mozilla

browsertarget_list_block   string  optional  

Exclude visitors using specified browsers from reaching and loading your Primary URL. Enum: Opera, Opera Mini, WebTV, Edge, Internet Explorer, Pocket Internet Explorer, Konqueror, iCab, OmniWeb, Firebird, Firefox, Iceweasel, Shiretoko, Mozilla, Amaya, Lynx, Safari, Safari, Chrome, Android, GoogleBot, Yahoo! Slurp, W3C Validator, BlackBerry, IceCat, Nokia S60 OSS Browser, Nokia Browser, MSN Browser, MSN Bot, Bing Bot, Vivalidi, Netscape Navigator, Galeon, NetPositive, Phoenix, PlayStation Example: Mozilla

systemtarget_add   boolean  optional  

With System targeting you have the option to include or exclude visitors using specified operating systems from reaching and loading your Primary URL. Non included or excluded operating systems visitors will end up loading the Backup link which you can also set among Advanced option. Example: true

systemtarget_list_inc   string  optional  

Include visitors using specified operating systems from reaching and loading your Primary URL. Enum: Windows, Windows CE, Apple, Linux, OS/2, BeOS, iPhone, iPod, iPad, BlackBerry, Nokia, FreeBSD, OpenBSD, NetBSD, SunOS, OpenSolaris, Android, Sony PlayStation Example: Windows

systemtarget_list_block   string  optional  

Exclude visitors using specified operating systems from reaching and loading your Primary URL. Enum: Windows, Windows CE, Apple, Linux, OS/2, BeOS, iPhone, iPod, iPad, BlackBerry, Nokia, FreeBSD, OpenBSD, NetBSD, SunOS, OpenSolaris, Android, Sony PlayStation Example: Windows

backup_url   string   

At Backup URL you can set the web destination onto which you want to send all the blocked visitors if you used Geotargeting option. Example: https://qliker.io

url_mob   string  optional  

With this option you can redirect all the mobile users to a specific URL. Example: https://qliker.io

url_mob_ios   string  optional  

With this option you can redirect all the iOS users to a specific URL. Example: https://qliker.io

blocked_url   string  optional  

Here you define a URL to which all the blocked visitors will get redirected. Example: https://qliker.io

filtering_bad_click   string  optional  

Abuser is a visitor who clicked on the link 30 or more times within 1 minute, most likely a bot. Enum: B, F, N Example: B

filtering_proxy   string  optional  

Anonymous proxy is a server which user uses to hide his IP address. Enum: B, F, N Example: B

filtering_spider   string  optional  

Spiders from search engines. Enum: B, F, N Example: B

filtering_server   string  optional  

Users using servers to click on your link. Enum: B, F, N Example: B

filtering_bad_user   string  optional  

A bad user is a user who's IP is manually blocked in Tools -> IP Manager. Enum: B, F, N Example: B

rpixels   string  optional  

[ 4 .. 500 ] A particle of website that activates when someone clicks on that website. Example: qui

notes   string  optional  

[ 4 .. 500 ] A simple note text field, made for your own eyes so that you have an option to write down something concerning this link and have it saved here as a reminder which you can always check if needed. Example: aspernatur

blank_ref   boolean  optional  

Blank the referrer when redirecting clicks so that the site you're sending traffic to can't tell where it's coming from. Example: true

skip_url_verf   boolean  optional  

Skips the step of checking if the inserted URL is valid. Example: true

randomize_enable   boolean  optional  

Turn ON/OFF randomization. Example: true

randomize_min   number  optional  

Randomize clicks in every X mnutes. Example: 1

randomize_realtime   boolean  optional  

Real time randomization. Example: true

randomize_ignore   boolean  optional  

Ignore First URL when randomizing. Example: true

randomize_ignore_first   boolean  optional  

Ignore Last URL when randomizing. Example: true

POST v1/rotators

requires authentication

Example request:
curl --request POST \
    "https://api.qliker.io/v1/rotators?name=My+Rotator&rotators_link=my-rotator&rotators_mode=spillover&rotators_spillover_mode=backup_url&rotators_random_mode=random_url&rotators_sequential_mode=next_url&domain_id=18&cloak=&cloak_title=My+Title&cloak_descr=Description+text&cloak_img_url=https%3A%2F%2Fqliker.test%2Fimg%2Flogo.png&geotarget_add=1&geotarget_countries_inc=RS%7CHR%7CEN&geotarget_countries_block=RS%7CHR%7CEN&browsertarget_add=1&browsertarget_list_inc=Mozilla&browsertarget_list_block=Mozilla&systemtarget_add=1&systemtarget_list_inc=Windows&systemtarget_list_block=Windows&backup_url=https%3A%2F%2Fqliker.io&url_mob=https%3A%2F%2Fqliker.io&url_mob_ios=https%3A%2F%2Fqliker.io&blocked_url=https%3A%2F%2Fqliker.io&filtering_bad_click=B&filtering_proxy=B&filtering_spider=B&filtering_server=B&filtering_bad_user=B&rpixels=id&notes=nisi&blank_ref=1&skip_url_verf=1&randomize_enable=1&randomize_min=1&randomize_realtime=1&randomize_ignore=1&randomize_ignore_first=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/rotators"
);

const params = {
    "name": "My Rotator",
    "rotators_link": "my-rotator",
    "rotators_mode": "spillover",
    "rotators_spillover_mode": "backup_url",
    "rotators_random_mode": "random_url",
    "rotators_sequential_mode": "next_url",
    "domain_id": "18",
    "cloak": "0",
    "cloak_title": "My Title",
    "cloak_descr": "Description text",
    "cloak_img_url": "https://qliker.test/img/logo.png",
    "geotarget_add": "1",
    "geotarget_countries_inc": "RS|HR|EN",
    "geotarget_countries_block": "RS|HR|EN",
    "browsertarget_add": "1",
    "browsertarget_list_inc": "Mozilla",
    "browsertarget_list_block": "Mozilla",
    "systemtarget_add": "1",
    "systemtarget_list_inc": "Windows",
    "systemtarget_list_block": "Windows",
    "backup_url": "https://qliker.io",
    "url_mob": "https://qliker.io",
    "url_mob_ios": "https://qliker.io",
    "blocked_url": "https://qliker.io",
    "filtering_bad_click": "B",
    "filtering_proxy": "B",
    "filtering_spider": "B",
    "filtering_server": "B",
    "filtering_bad_user": "B",
    "rpixels": "id",
    "notes": "nisi",
    "blank_ref": "1",
    "skip_url_verf": "1",
    "randomize_enable": "1",
    "randomize_min": "1",
    "randomize_realtime": "1",
    "randomize_ignore": "1",
    "randomize_ignore_first": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.qliker.io/v1/rotators',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'name' => 'My Rotator',
            'rotators_link' => 'my-rotator',
            'rotators_mode' => 'spillover',
            'rotators_spillover_mode' => 'backup_url',
            'rotators_random_mode' => 'random_url',
            'rotators_sequential_mode' => 'next_url',
            'domain_id' => '18',
            'cloak' => '0',
            'cloak_title' => 'My Title',
            'cloak_descr' => 'Description text',
            'cloak_img_url' => 'https://qliker.test/img/logo.png',
            'geotarget_add' => '1',
            'geotarget_countries_inc' => 'RS|HR|EN',
            'geotarget_countries_block' => 'RS|HR|EN',
            'browsertarget_add' => '1',
            'browsertarget_list_inc' => 'Mozilla',
            'browsertarget_list_block' => 'Mozilla',
            'systemtarget_add' => '1',
            'systemtarget_list_inc' => 'Windows',
            'systemtarget_list_block' => 'Windows',
            'backup_url' => 'https://qliker.io',
            'url_mob' => 'https://qliker.io',
            'url_mob_ios' => 'https://qliker.io',
            'blocked_url' => 'https://qliker.io',
            'filtering_bad_click' => 'B',
            'filtering_proxy' => 'B',
            'filtering_spider' => 'B',
            'filtering_server' => 'B',
            'filtering_bad_user' => 'B',
            'rpixels' => 'id',
            'notes' => 'nisi',
            'blank_ref' => '1',
            'skip_url_verf' => '1',
            'randomize_enable' => '1',
            'randomize_min' => '1',
            'randomize_realtime' => '1',
            'randomize_ignore' => '1',
            'randomize_ignore_first' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success"
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

Request      

POST v1/rotators

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Accept      

Example: application/json

Query Parameters

name   string   

[ 4 .. 30 ] characters. Rotator's Name will help you to easily recognize what it's related to and will help you to easily manage your rotators once you have many. Rotator's name is for your own eyes only. Example: My Rotator

rotators_link   string   

[ 4 .. 30 ] characters. The main part of Rotator's link address is defined by your account username, but you can edit the last part of the address and define it in a way to help you recognize every of your rotator by their link names which will be handy for you. Example: my-rotator

rotators_mode   string   

Rotators mode: Fullfillment: Every new person clicking on your Rotator link will land on the very first Rotator URL until the maximum number of clicks for that first URL has been reached. Spillover: Every person that clicks on your Rotator link will go to the first URL, and the second time they click will be to the second URL, and so on. Every new person after that will still land on the first URL, and keep going down the list. Random: Every person that clicks on your Rotator link will simply go to a random URL. Sequential: Every person that clicks on your Rotator link will go down the list sequentially of your URLs. The first person will go to URL 1, the second person will go to URL 2, and so on. Enum: fulfillment, spillover, random, sequential Example: spillover

rotators_spillover_mode   string  optional  

Traffic on finish go to: Backup, Last Url or on top of rotator. Enum: backup_url, last_url, top_of_rotator Example: backup_url

rotators_random_mode   string  optional  

Send repeat clicks to same URL or random URL. Enum: same_url, random_url Example: random_url

rotators_sequential_mode   string  optional  

Send repeat clicks to same URL or next URL. Enum: same_url, next_url Example: next_url

domain_id   integer  optional  

If you have any custom Rotators domains set up to use with your Rotator. Example: 18

cloak   boolean  optional  

This option allows you to change your link destination (Primary URL) meta tags. Or by other words, if you use this option and paste your link to Facebook for example, Facebook will parse the information that you've set here instead of parsing the default Qliker's meta tags. Example 'false'. Example: false

cloak_title   string  optional  

Here you can change title meta tag for this link. Example: My Title

cloak_descr   string  optional  

Here you can change description meta tag for this link. Example: Description text

cloak_img_url   string  optional  

Here you can change image meta tag for this link. Example: https://qliker.test/img/logo.png

geotarget_add   boolean  optional  

With Geotargeting you're having the option to include or exclude visitors from specified countries from reaching and loading you Primary URL. Non included or excluded country visitors will end up loading the Backup link which you can also set among Advanced option. Example: true

geotarget_countries_inc   string  optional  

Here you can specify countries which you want to allow loading and reaching your Primary URL. All the other countries will automatically be considered blocked and visitors from blocked countries will then be sent to your Backup URL. You can find a full list of two-letter country codes in the International Banking (IBAN) Country Code List. f you use this parameter, all clicks from countries that are not explicitly included will be redirected through the backup_url. Example: RS|HR|EN

geotarget_countries_block   string  optional  

Here you can specify countries which you want to block from loading and reaching your Primary URL. Blocked visitors will then be sent to your Backup URL. You can find a full list of two-letter country codes in the International Banking (IBAN) Country Code List. Example: RS|HR|EN

browsertarget_add   boolean  optional  

With Browser targeting you have the option to include or exclude visitors using specified browsers from reaching and loading your Primary URL. Non included or excluded browser visitors will end up loading the Backup link which you can also set among Advanced option. Example: true

browsertarget_list_inc   string  optional  

Include visitors using specified browsers from reaching and loading your Primary URL. Enum: Opera, Opera Mini, WebTV, Edge, Internet Explorer, Pocket Internet Explorer, Konqueror, iCab, OmniWeb, Firebird, Firefox, Iceweasel, Shiretoko, Mozilla, Amaya, Lynx, Safari, Safari, Chrome, Android, GoogleBot, Yahoo! Slurp, W3C Validator, BlackBerry, IceCat, Nokia S60 OSS Browser, Nokia Browser, MSN Browser, MSN Bot, Bing Bot, Vivalidi, Netscape Navigator, Galeon, NetPositive, Phoenix, PlayStation Example: Mozilla

browsertarget_list_block   string  optional  

Exclude visitors using specified browsers from reaching and loading your Primary URL. Enum: Opera, Opera Mini, WebTV, Edge, Internet Explorer, Pocket Internet Explorer, Konqueror, iCab, OmniWeb, Firebird, Firefox, Iceweasel, Shiretoko, Mozilla, Amaya, Lynx, Safari, Safari, Chrome, Android, GoogleBot, Yahoo! Slurp, W3C Validator, BlackBerry, IceCat, Nokia S60 OSS Browser, Nokia Browser, MSN Browser, MSN Bot, Bing Bot, Vivalidi, Netscape Navigator, Galeon, NetPositive, Phoenix, PlayStation Example: Mozilla

systemtarget_add   boolean  optional  

With System targeting you have the option to include or exclude visitors using specified operating systems from reaching and loading your Primary URL. Non included or excluded operating systems visitors will end up loading the Backup link which you can also set among Advanced option. Example: true

systemtarget_list_inc   string  optional  

Include visitors using specified operating systems from reaching and loading your Primary URL. Enum: Windows, Windows CE, Apple, Linux, OS/2, BeOS, iPhone, iPod, iPad, BlackBerry, Nokia, FreeBSD, OpenBSD, NetBSD, SunOS, OpenSolaris, Android, Sony PlayStation Example: Windows

systemtarget_list_block   string  optional  

Exclude visitors using specified operating systems from reaching and loading your Primary URL. Enum: Windows, Windows CE, Apple, Linux, OS/2, BeOS, iPhone, iPod, iPad, BlackBerry, Nokia, FreeBSD, OpenBSD, NetBSD, SunOS, OpenSolaris, Android, Sony PlayStation Example: Windows

backup_url   string   

At Backup URL you can set the web destination onto which you want to send all the blocked visitors if you used Geotargeting option. Example: https://qliker.io

url_mob   string  optional  

With this option you can redirect all the mobile users to a specific URL. Example: https://qliker.io

url_mob_ios   string  optional  

With this option you can redirect all the iOS users to a specific URL. Example: https://qliker.io

blocked_url   string  optional  

Here you define a URL to which all the blocked visitors will get redirected. Example: https://qliker.io

filtering_bad_click   string  optional  

Abuser is a visitor who clicked on the link 30 or more times within 1 minute, most likely a bot. Enum: B, F, N Example: B

filtering_proxy   string  optional  

Anonymous proxy is a server which user uses to hide his IP address. Enum: B, F, N Example: B

filtering_spider   string  optional  

Spiders from search engines. Enum: B, F, N Example: B

filtering_server   string  optional  

Users using servers to click on your link. Enum: B, F, N Example: B

filtering_bad_user   string  optional  

A bad user is a user who's IP is manually blocked in Tools -> IP Manager. Enum: B, F, N Example: B

rpixels   string  optional  

[ 4 .. 500 ] A particle of website that activates when someone clicks on that website. Example: id

notes   string  optional  

[ 4 .. 500 ] A simple note text field, made for your own eyes so that you have an option to write down something concerning this link and have it saved here as a reminder which you can always check if needed. Example: nisi

blank_ref   boolean  optional  

Blank the referrer when redirecting clicks so that the site you're sending traffic to can't tell where it's coming from. Example: true

skip_url_verf   boolean  optional  

Skips the step of checking if the inserted URL is valid. Example: true

randomize_enable   boolean  optional  

Turn ON/OFF randomization. Example: true

randomize_min   number  optional  

Randomize clicks in every X mnutes. Example: 1

randomize_realtime   boolean  optional  

Real time randomization. Example: true

randomize_ignore   boolean  optional  

Ignore First URL when randomizing. Example: true

randomize_ignore_first   boolean  optional  

Ignore Last URL when randomizing. Example: true

requires authentication

Example request:
curl --request GET \
    --get "https://api.qliker.io/v1/rotators/links?rotator_id=20&skip=1&take=6&status=active" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/rotators/links"
);

const params = {
    "rotator_id": "20",
    "skip": "1",
    "take": "6",
    "status": "active",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.qliker.io/v1/rotators/links',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'rotator_id' => '20',
            'skip' => '1',
            'take' => '6',
            'status' => 'active',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success",
    "urls": [
        {
            "id": 120,
            "name": "Prof. Brenden Adams",
            "status": "archived",
            "created_at": "2023-08-08 11:33:19",
            "updated_at": "2023-08-08 11:33:19"
        },
        {
            "id": 329,
            "name": "Mrs. Selina Murray MD",
            "status": "archived",
            "created_at": "2023-08-08 11:33:20",
            "updated_at": "2023-08-08 11:33:20"
        },
        {
            "id": 657,
            "name": "Carleton Schulist",
            "status": "paused",
            "created_at": "2023-08-08 11:33:22",
            "updated_at": "2023-08-08 11:33:22"
        }
    ]
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

requires authentication

Example request:
curl --request GET \
    --get "https://api.qliker.io/v1/rotators/links/details?id=11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/rotators/links/details"
);

const params = {
    "id": "11",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.qliker.io/v1/rotators/links/details',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'id' => '11',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success"
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

requires authentication

Example request:
curl --request DELETE \
    "https://api.qliker.io/v1/rotators/links/12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/rotators/links/12"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.qliker.io/v1/rotators/links/12',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "rotators": "success",
    "url": {
        "id": 120,
        "rotator_id": 80,
        "name": "Prof. Brenden Adams",
        "status": "archived",
        "url": "https://page.programmer.in.rs/page.php",
        "position": 2,
        "maxclick": null,
        "maxclick_daily": null,
        "maxclick_bonus": null,
        "min_t1": null,
        "max_t1": null,
        "min_mobile": null,
        "max_mobile": null,
        "start": null,
        "end": null,
        "created_at": "2023-08-08 11:33:19",
        "updated_at": "2023-08-08 11:33:19"
    }
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

requires authentication

Example request:
curl --request PATCH \
    "https://api.qliker.io/v1/rotators/links/12?name=My+Rotator+Link&url=https%3A%2F%2Fqliker.io&status=active&position=1&weight=1&maxclick_bonus=100&maxclick=200&maxclick_daily=200&maxclick_raw=200&maxclick_daily_raw=200&min_t1=100&max_t1=100&max_qfr=100&min_mobile=100&max_mobile=100&start=2023-04-14+16%3A02%3A10&end=2023-04-14+16%3A02%3A10&notify=1&notify_on_start=1&notify_on_end=1&notify_client_email=john.doe%40example.com&remote_stats=https%3A%2F%2Fqliker.io%2Fshare%2Fr%2F24946647&finish_activate=12&geotarget_add=1&geotarget_countries_inc=RS%7CHR%7CEN&geotarget_countries_block=RS%7CHR%7CEN&browsertarget_add=1&browsertarget_list_inc=Mozilla&browsertarget_list_block=Mozilla&systemtarget_add=1&systemtarget_list_inc=Windows&systemtarget_list_block=Windows&smart_swap=12&filtering_nocookies=B&filtering_nojavascript=B&lpixels=ipsum&notes=veritatis&skip_url_verf=1&traffic_tablet=0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/rotators/links/12"
);

const params = {
    "name": "My Rotator Link",
    "url": "https://qliker.io",
    "status": "active",
    "position": "1",
    "weight": "1",
    "maxclick_bonus": "100",
    "maxclick": "200",
    "maxclick_daily": "200",
    "maxclick_raw": "200",
    "maxclick_daily_raw": "200",
    "min_t1": "100",
    "max_t1": "100",
    "max_qfr": "100",
    "min_mobile": "100",
    "max_mobile": "100",
    "start": "2023-04-14 16:02:10",
    "end": "2023-04-14 16:02:10",
    "notify": "1",
    "notify_on_start": "1",
    "notify_on_end": "1",
    "notify_client_email": "john.doe@example.com",
    "remote_stats": "https://qliker.io/share/r/24946647",
    "finish_activate": "12",
    "geotarget_add": "1",
    "geotarget_countries_inc": "RS|HR|EN",
    "geotarget_countries_block": "RS|HR|EN",
    "browsertarget_add": "1",
    "browsertarget_list_inc": "Mozilla",
    "browsertarget_list_block": "Mozilla",
    "systemtarget_add": "1",
    "systemtarget_list_inc": "Windows",
    "systemtarget_list_block": "Windows",
    "smart_swap": "12",
    "filtering_nocookies": "B",
    "filtering_nojavascript": "B",
    "lpixels": "ipsum",
    "notes": "veritatis",
    "skip_url_verf": "1",
    "traffic_tablet": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->patch(
    'https://api.qliker.io/v1/rotators/links/12',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'name' => 'My Rotator Link',
            'url' => 'https://qliker.io',
            'status' => 'active',
            'position' => '1',
            'weight' => '1',
            'maxclick_bonus' => '100',
            'maxclick' => '200',
            'maxclick_daily' => '200',
            'maxclick_raw' => '200',
            'maxclick_daily_raw' => '200',
            'min_t1' => '100',
            'max_t1' => '100',
            'max_qfr' => '100',
            'min_mobile' => '100',
            'max_mobile' => '100',
            'start' => '2023-04-14 16:02:10',
            'end' => '2023-04-14 16:02:10',
            'notify' => '1',
            'notify_on_start' => '1',
            'notify_on_end' => '1',
            'notify_client_email' => 'john.doe@example.com',
            'remote_stats' => 'https://qliker.io/share/r/24946647',
            'finish_activate' => '12',
            'geotarget_add' => '1',
            'geotarget_countries_inc' => 'RS|HR|EN',
            'geotarget_countries_block' => 'RS|HR|EN',
            'browsertarget_add' => '1',
            'browsertarget_list_inc' => 'Mozilla',
            'browsertarget_list_block' => 'Mozilla',
            'systemtarget_add' => '1',
            'systemtarget_list_inc' => 'Windows',
            'systemtarget_list_block' => 'Windows',
            'smart_swap' => '12',
            'filtering_nocookies' => 'B',
            'filtering_nojavascript' => 'B',
            'lpixels' => 'ipsum',
            'notes' => 'veritatis',
            'skip_url_verf' => '1',
            'traffic_tablet' => '0',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success"
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

requires authentication

Example request:
curl --request POST \
    "https://api.qliker.io/v1/rotators/links/12?name=My+Rotator+Link&url=https%3A%2F%2Fqliker.io&status=active&position=1&weight=1&maxclick_bonus=100&maxclick=200&maxclick_daily=200&maxclick_raw=200&maxclick_daily_raw=200&min_t1=100&max_t1=100&max_qfr=100&min_mobile=100&max_mobile=100&start=2023-04-14+16%3A02%3A10&end=2023-04-14+16%3A02%3A10&notify=1&notify_on_start=1&notify_on_end=1&notify_client_email=john.doe%40example.com&remote_stats=https%3A%2F%2Fqliker.io%2Fshare%2Fr%2F24946647&finish_activate=12&geotarget_add=1&geotarget_countries_inc=RS%7CHR%7CEN&geotarget_countries_block=RS%7CHR%7CEN&browsertarget_add=1&browsertarget_list_inc=Mozilla&browsertarget_list_block=Mozilla&systemtarget_add=1&systemtarget_list_inc=Windows&systemtarget_list_block=Windows&smart_swap=12&filtering_nocookies=B&filtering_nojavascript=B&lpixels=error&notes=numquam&skip_url_verf=1&traffic_tablet=0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/rotators/links/12"
);

const params = {
    "name": "My Rotator Link",
    "url": "https://qliker.io",
    "status": "active",
    "position": "1",
    "weight": "1",
    "maxclick_bonus": "100",
    "maxclick": "200",
    "maxclick_daily": "200",
    "maxclick_raw": "200",
    "maxclick_daily_raw": "200",
    "min_t1": "100",
    "max_t1": "100",
    "max_qfr": "100",
    "min_mobile": "100",
    "max_mobile": "100",
    "start": "2023-04-14 16:02:10",
    "end": "2023-04-14 16:02:10",
    "notify": "1",
    "notify_on_start": "1",
    "notify_on_end": "1",
    "notify_client_email": "john.doe@example.com",
    "remote_stats": "https://qliker.io/share/r/24946647",
    "finish_activate": "12",
    "geotarget_add": "1",
    "geotarget_countries_inc": "RS|HR|EN",
    "geotarget_countries_block": "RS|HR|EN",
    "browsertarget_add": "1",
    "browsertarget_list_inc": "Mozilla",
    "browsertarget_list_block": "Mozilla",
    "systemtarget_add": "1",
    "systemtarget_list_inc": "Windows",
    "systemtarget_list_block": "Windows",
    "smart_swap": "12",
    "filtering_nocookies": "B",
    "filtering_nojavascript": "B",
    "lpixels": "error",
    "notes": "numquam",
    "skip_url_verf": "1",
    "traffic_tablet": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.qliker.io/v1/rotators/links/12',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'name' => 'My Rotator Link',
            'url' => 'https://qliker.io',
            'status' => 'active',
            'position' => '1',
            'weight' => '1',
            'maxclick_bonus' => '100',
            'maxclick' => '200',
            'maxclick_daily' => '200',
            'maxclick_raw' => '200',
            'maxclick_daily_raw' => '200',
            'min_t1' => '100',
            'max_t1' => '100',
            'max_qfr' => '100',
            'min_mobile' => '100',
            'max_mobile' => '100',
            'start' => '2023-04-14 16:02:10',
            'end' => '2023-04-14 16:02:10',
            'notify' => '1',
            'notify_on_start' => '1',
            'notify_on_end' => '1',
            'notify_client_email' => 'john.doe@example.com',
            'remote_stats' => 'https://qliker.io/share/r/24946647',
            'finish_activate' => '12',
            'geotarget_add' => '1',
            'geotarget_countries_inc' => 'RS|HR|EN',
            'geotarget_countries_block' => 'RS|HR|EN',
            'browsertarget_add' => '1',
            'browsertarget_list_inc' => 'Mozilla',
            'browsertarget_list_block' => 'Mozilla',
            'systemtarget_add' => '1',
            'systemtarget_list_inc' => 'Windows',
            'systemtarget_list_block' => 'Windows',
            'smart_swap' => '12',
            'filtering_nocookies' => 'B',
            'filtering_nojavascript' => 'B',
            'lpixels' => 'error',
            'notes' => 'numquam',
            'skip_url_verf' => '1',
            'traffic_tablet' => '0',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success"
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

Groups

APIs for managing groups

requires authentication

Example request:
curl --request GET \
    --get "https://api.qliker.io/v1/links/groups?skip=11&take=2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/links/groups"
);

const params = {
    "skip": "11",
    "take": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.qliker.io/v1/links/groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'skip' => '11',
            'take' => '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success",
    "groups": [
        {
            "id": 4,
            "name": "Group 1",
            "subgoup": {
                "id": 5,
                "name": "subgroup",
                "created_at": "2023-08-10 12:11:18",
                "updated_at": null
            },
            "created_at": "2023-08-10 12:11:13",
            "updated_at": null
        },
        {
            "id": 6,
            "name": "Group 2",
            "created_at": "2023-08-10 12:11:22",
            "updated_at": null
        }
    ]
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

GET v1/rotators/groups

requires authentication

Example request:
curl --request GET \
    --get "https://api.qliker.io/v1/rotators/groups?skip=17&take=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/rotators/groups"
);

const params = {
    "skip": "17",
    "take": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.qliker.io/v1/rotators/groups',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'skip' => '17',
            'take' => '1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
 "status": "success",
 "groups": {
     'id': 1,
     'name': 'group1',
     'created_at': '2023-04-25 10:28:17',
     'updated_at': '2023-04-25 10:28:17',
     },
     {
     'id': 2,
     'name': 'group2',
     'created_at': '2023-04-25 10:28:17',
     'updated_at': '2023-04-25 10:28:17',
     }
 }
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

Request      

GET v1/rotators/groups

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Accept      

Example: application/json

Query Parameters

skip   integer  optional  

Position to paginate. Defaults to '0'. Example: 17

take   integer  optional  

The number of group to retrieve at one time, based on the skip position. Default 10. Example 10 Example: 1

Domains

GET v1/domains

requires authentication

Example request:
curl --request GET \
    --get "https://api.qliker.io/v1/domains?skip=17&take=8" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Accept: application/json"
const url = new URL(
    "https://api.qliker.io/v1/domains"
);

const params = {
    "skip": "17",
    "take": "8",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.qliker.io/v1/domains',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Accept' => 'application/json',
        ],
        'query' => [
            'skip' => '17',
            'take' => '8',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200, success):


{
    "status": "success",
    "domains": [
        {
            "id": 2,
            "domain": "mydomain.in.rs",
            "type": "link",
            "cloak": 0,
            "active": 0,
            "created_at": "2023-08-10 14:17:43",
            "updated_at": null
        },
        {
            "id": 1,
            "domain": "mydomain.rs",
            "type": "link",
            "cloak": 0,
            "active": 1,
            "created_at": "2023-08-10 14:17:43",
            "updated_at": null
        }
    ]
}
 

Example response (401):


{
    "message": "Unauthenticated."
}
 

Example response (404):


{
    "stratus": "fail",
    "error": "Error message"
}
 

Request      

GET v1/domains

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Accept      

Example: application/json

Query Parameters

skip   integer  optional  

Position to paginate. Defaults to '0'. Example: 17

take   integer  optional  

The number of domain to retrieve at one time, based on the skip position. Default 10. Example 10 Example: 8