This page describes API endpoints for viewing and creating Clicks.
GET /backend/open-api/v1/users/clicks
Get all Clicks.
Additionally, you can filter the list of clicks by using the {click_id} path parameter or some of these query parameters: {affiliate_id}, {offer_id}, {created_at_from}, and {created_at_to}.
Headers
| Name | Value |
|---|---|
| Authorization | Bearer <token> |
Path parameters
| Name | Type | Description | Required | Example |
|---|---|---|---|---|
id |
Integer | Add it to get information only about a selected click | 24569 |
Query parameters
| Name | Type | Description | Required | Example |
|---|---|---|---|---|
affiliate_id |
Integer | ID of the affiliate related to the conversion. | 3011 | |
offer_id |
Integer | ID of the related offer. | 78 | |
created_from |
Date | The start of the time period when the conversion was recorded. | 2024-07-08 13:40:00 | |
created_to |
Date | The end of the time period when the conversion was recorded. | 2024-07-20 13:40:00 |
Response
{
"data": [
{
"data": [
{
"id": 184568,
"hash": "12e9d2d9f07cb9a097bac01a127c9e00",
"group_hash": "12e9d2d9f07cb9a097bac01a127c9e00",
"offer_id": 3,
"offer_name": "Test Offer",
"offer_url_id": 132,
"advertiser_id": 1,
"advertiser_name": "PlayGamesl",
"aff_group_id": null,
"brand_id": 1,
"affiliate_id": 513,
"affiliate_name": "John Doe",
"device_model": "",
"device_brand": "",
"sale_status": "New",
"advertiser_external_id": null,
"adv_sub": null,
"adv_sub2": null,
"adv_sub3": null,
"adv_sub4": null,
"adv_sub5": null,
"device_os": "UNK",
"aff_sub": "",
"aff_sub2": "",
"aff_sub3": "",
"aff_sub4": "",
"aff_sub5": "",
"aff_sub6": "",
"aff_sub7": "",
"aff_sub8": "",
"aff_sub9": "",
"aff_sub10": "",
"aff_sub11": "",
"aff_sub12": "",
"aff_sub13": "",
"aff_sub14": "",
"aff_sub15": "",
"aff_sub16": "",
"aff_sub17": "",
"aff_sub18": "",
"aff_sub19": "",
"aff_sub20": "",
"affiliate_source": "",
"user_agent": "Google Chrome",
"browser": "Google Chrome",
"ip": "111.222.333.444",
"device_os_version": "UNK",
"platform": "",
"mobile_carrier": "UNK",
"country_code": "NL",
"region_code": "NH",
"external_id": null,
"has_conversions": true,
"requested_link": "<http://example.com/offer/3?affiliate_id=513>",
"redirected_link": "<https://second.example.net/{free_1}?aff_id={free_2}>",
"is_unique": true,
"created_at": "2024-10-10 11:24:09"
},
{
"data": [
{
"id": 184568,
"hash": "9e09d2d908fcb9a097bac01a127c9e96",
"group_hash": "9e09d2d908fcb9a097bac01a127c9e96",
"offer_id": 3,
"offer_name": "Test Offer",
"offer_url_id": 132,
"advertiser_id": 1,
"advertiser_name": "PlayGamesl",
"aff_group_id": null,
"brand_id": 1,
"affiliate_id": 513,
"affiliate_name": "John Doe",
"device_model": "",
"device_brand": "",
"sale_status": "New",
"advertiser_external_id": null,
"adv_sub": null,
"adv_sub2": null,
"adv_sub3": null,
"adv_sub4": null,
"adv_sub5": null,
"device_os": "UNK",
"aff_sub": "",
"aff_sub2": "",
"aff_sub3": "",
"aff_sub4": "",
"aff_sub5": "",
"aff_sub6": "",
"aff_sub7": "",
"aff_sub8": "",
"aff_sub9": "",
"aff_sub10": "",
"aff_sub11": "",
"aff_sub12": "",
"aff_sub13": "",
"aff_sub14": "",
"aff_sub15": "",
"aff_sub16": "",
"aff_sub17": "",
"aff_sub18": "",
"aff_sub19": "",
"aff_sub20": "",
"affiliate_source": "",
"user_agent": "Google Chrome",
"browser": "Google Chrome",
"ip": "111.222.333.444",
"device_os_version": "UNK",
"platform": "",
"mobile_carrier": "UNK",
"country_code": "NL",
"region_code": "NH",
"external_id": null,
"has_conversions": true,
"requested_link": "<http://example.com/offer/3?affiliate_id=520>",
"redirected_link": "<https://second.example.net/{free_1}?aff_id={free_2}>",
"is_unique": true,
"created_at": "2024-10-10 11:27:09"
}
],
"total": 100,
"per_page": 200,
"page": 1,
"pages": 1
}