URL for a request
Method
GET
Incoming Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| api_token | string | Yes | API token for access |
| time_from | string | No | Time from [Y-m-d H:i:s] |
| time_to | string | No | Time to [Y-m-d H:i:s] |
| date_from | string | No | Date from [Y-m-d] |
| date_to | string | No | Date to [Y-m-d] |
| dates | array | No | List of specific dates [Y-m-d] |
| links | array | No | Array of link IDs |
| clicks_id | array | No | Array of click IDs |
| clicker_id | int | No | Clicker ID |
| unique_click | bool | No | Unique clicks or not. [0, 1] |
| click_out | bool | No | The link redirect is confirmed or not. [0, 1] |
| ad_click | bool | No | Click on an ad. [0, 1] |
| sub_id | string | No | Sub ID, transmitted via the Traffic Analysis > Subid analysis option |
| sub_id1 | string | No | Sub ID 1, transmitted via the Traffic Analysis > Subid analysis option |
| sub_id2 | string | No | Sub ID 2, transmitted via the Traffic Analysis > Subid analysis option |
| sub_id3 | string | No | Sub ID 3, transmitted via the Traffic Analysis > Subid analysis option |
| out_url | string | No | The link that the user go to. Partial Match Search |
| link_clicks | int | No | Total number of clicks on links |
| ip_version | int | No | IP version. 4 or 6 |
| ip | string | No | Accurate IP filter |
| ipv6 | string | No | Accurate IPV6 filter |
| ip_network1 | string | No | Accurate filter by subnet 1 |
| ip_network2 | string | No | Accurate filter by subnet 2 |
| proxy | string | No | Filter by proxy |
| proxy_type | string | No | By proxy type. Available options:
|
| ua | string | No | Filter by any part of the User Agent |
| referer | string | No | Full click source |
| referer_domain | string | No | Domain of a click source |
| referer_name | string | No | Name of a well-known click source |
| cc | string | No | Country ISO code |
| country | string | No | Country name |
| region | string | No | Region of a country |
| city | string | No | City |
| device | string | No | Device type |
| brand | string | No | Device Brand |
| model | string | No | Device Model |
| os | string | No | OS |
| os_ver | string | No | OS version |
| browser | string | No | Browser |
| browser_ver | string | No | Browser version |
| browser_type | string | No | Browser type |
| lang | string | No | The main language of the device |
| lang_full | string | No | Full device language |
| is_bot | boot | No | The click was made by a bot |
| quality | int | No | Traffic quality. Available options:
|
| isp | string | No | Internet service provider |
| load_file | bool | No | Downloaded file or not. [0, 1] |
| adblock | bool | No | Ad blocker enabled. [0, 1] |
| cl_lang | string | No | Browser language |
| cl_platform | string | No | Client platform |
| cl_timezone | string | No | Client time zone |
| cl_ua | string | No | Client browser |
| cl_color_depth | int | No | Client device color depth |
| cl_java_enabled | bool | No | Client JAVA support. [0, 1] |
| cl_cookie_enabled | bool | No | Client cookies support. [0, 1] |
| cl_pixel_depth | int | No | Client the bit depth of the screen |
| cl_screen_size | string | No | Client screen sizes |
| cl_window_size | string | No | Client window sizes |
| cl_screen_width | int | No | Client screen width |
| cl_screen_height | int | No | Client screen height |
| cl_window_width | int | No | Client window width |
| cl_screen_height | int | No | Client window height |
| ip_from | int | No | IP from. Converted via ip2long |
| ip_to | int | No | IP to. Converted via ip2long |
| sort | string | No | A field for sorting. By default - time |
| order | string | No | The direction of sorting. desc - descending, asc - ascending. By default - desc |
| limit | int | No | Number of records to output. By default - 100. From 1 to 10000. |
Return values
The server returns a response in JSON format. The list of parameters depends on the server response code:
Request example
curl 'https://firelinks.cc/api/out/stat/clicks?api_token=W9DtD7JtyHI7nPj8eEWul2pVkcobE62IHaHi3n8ClQdogBGZe6n70fIgTH3u'
Response example 200
{
"success": true,
"data": [
{
"date": "2022-08-21",
"time": "2022-08-21 18:36:18",
"click_id": 2382356,
"clicker_id": "251119170618",
"link_id": 411,
"unique_click": 1,
"click_out": 0,
"link_clicks": 113,
"ip_version": 4,
"ip": "95.108.213.75",
"ipv6": "",
"ip_network1": "95.108",
"ip_network2": "95.108.213",
"isp": "Yandex LLC",
"cc": "RU",
"country": "Russian Federation",
"region": "Moskva",
"city": "Moscow",
"os": null,
"os_ver": null,
"browser": null,
"browser_ver": null,
"browser_type": null,
"device": null,
"is_bot": 1,
"money": 0,
"ad_click": 0,
"proxy": null,
"proxy_type": "SES",
"ua": "Mozilla/5.0 (compatible; YandexBot/3.0; +http://yandex.com/bots)",
"client_lang": null,
"client_platform": null,
"client_timezone": null,
"client_ua": null,
"client_color_depth": 0,
"client_java_enabled": 0,
"client_cookie_enabled": 0,
"client_pixel_depth": 0,
"client_screen_size": null,
"client_window_size": null,
"client_screen_width": 0,
"client_window_width": 0,
"client_screen_height": 0,
"client_window_height": 0,
"referer": null,
"referer_domain": null,
"referer_name": null,
"brand": null,
"model": null,
"lang": null,
"lang_full": null,
"comment": "No click out",
"quality": 3,
"params_req": 1,
"sub_id": null,
"sub_id1": null,
"sub_id2": null,
"sub_id3": null,
"out_url": "https://https://firelinks.cc",
"load_file": 0
}
]
}
Response example 422
{
"success": false,
"errors": "Validation errors",
"data": {
"date_from": [
"The date from field is not a date."
]
}
}