Get report on clicks

You can get the report on clicks that users made after they followed affiliate links on your platform.
This endpoint returns the list of click items, where each item contains information about clicks retrieved according to the specified parameters.

You can get the detailed report for the specified platform or for all platforms in your account.

If your platform has been disconnected from a program, you can still receive reports for it.

You can test this API endpoint and inspect the possible responses using Swagger UI.

Request

URL: https://api.takeads.com/v1/api/stats/click

Method: GET

Request headers

Query parameters

You can use query parameters to get specific reports on clicks or paginate the response.

This endpoint has no required parameters.

To get information about clicks performed within a certain period, use one of the following: days parameter, or date parameter, or a pair of dateFrom and dateTo parameters.

• If days parameter is specified — date, dateFrom and dateTo parameters are ignored.
  
  
• If days parameter is not specified and date parameter is specified — dateFrom and dateTo parameters are ignored.

The specified period cannot exceed 120 days. If you don’t specify the period, information for the past 7 seven days is returned.
Use offset and limit parameters to paginate the response.

The following table describes query parameters that you can use in the request.

Request examples

• curl --request GET \
  
    --url 'https://api.takeads.com/v1/api/stats/click?dateFrom=2021-08-03&dateTo=2021-08-04&subId=test&adspaceId=fb9868e4-b7e3-4d2f-957e-7ed7e0f1e87f&programId=c126a15d-ebb3-4ed8-b5d1-a239ecd52e0d01&limit=100&offset=500' \
    --header 'Authorization: Bearer <Public Key>'\
    --header 'Content-Type: application/json'
  
  
  

• fetch("https://api.takeads.com/v1/api/stats/click?dateFrom=2021-08-03&dateTo=2021-08-04&subId=test&adspaceId=fb9868e4-b7e3-4d2f-957e-7ed7e0f1e87f&programId=c126a15d-ebb3-4ed8-b5d1-a239ecd52e0d01&limit=100&offset=500", {
  
    "method": "GET",
  
    "headers": {
  
      "Authorization": "Bearer <Public Key>",
  
      "Content-Type": "application/json"
  
    }
  
  })
  
  .then(response => {
  
    console.log(response);
  
  })
  
  .catch(err => {
  
    console.error(err);
  
  });
  
  

• <?php
   
  
  $curl = curl_init();
  
   
  curl_setopt_array($curl, [
  
    CURLOPT_PORT => "6110",
  
    CURLOPT_URL => "https://api.takeads.com/v1/api/stats/click?dateFrom=2021-08-03&dateTo=2021-08-04&subId=test&adspaceId=fb9868e4-b7e3-4d2f-957e-7ed7e0f1e87f&programId=c126a15d-ebb3-4ed8-b5d1-a239ecd52e0d01&limit=100&offset=500",
  
    CURLOPT_RETURNTRANSFER => true,
  
    CURLOPT_ENCODING => "",
  
    CURLOPT_MAXREDIRS => 10,
  
    CURLOPT_TIMEOUT => 30,
  
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  
    CURLOPT_CUSTOMREQUEST => "GET",
  
    CURLOPT_POSTFIELDS => "",
  
    CURLOPT_HTTPHEADER => [
  
      "Authorization: Bearer <Public Key>",
  
      "Content-Type: application/json"
  
    ],
  
  ]);
  
   
  $response = curl_exec($curl);
  
  $err = curl_error($curl);
  
   
  
  curl_close($curl);
  
   
  if ($err) {
  
    echo "cURL Error #:" . $err;
  
  } else {
  
    echo $response;
  
  }
  

• import http.client
  
   
  conn = http.client.HTTPSConnection("https://api.takeads.com")
  
   
  payload = ""
  
   
  headers = {
  
      'Authorization': "Bearer <Public Key>",
  
      'Content-Type': "application/json"
  
      }
  
   
  conn.request("GET", "/v1/api/stats/click?dateFrom=2021-08-03&dateTo=2021-08-04&subId=test&adspaceId=fb9868e4-b7e3-4d2f-957e-7ed7e0f1e87f&programId=c126a15d-ebb3-4ed8-b5d1-a239ecd52e0d01&limit=100&offset=500", payload, headers)
  
   
  res = conn.getresponse()
  
  data = res.read()
  
   
  print(data.decode("utf-8"))
  

Response

If the request was successfully processed by the server, the HTTP response with 200 status code and the list of available click items is returned.

The returned click items are sorted by the updatedAt value in the descending order. If the updatedAt value is the same for a number of items, they are filtered by their ids in the ascending order.

The response payload is a JSON object that contains a meta object with metadata and a data array with the retrieved click items. Each item of the array is an object with the details about the clicks retrieved according to request.

The following table describes the response properties.

Example value

{

{

  "meta": {

    "offset": 100,

    "limit": 500,

    "total": 3128

  },

  "data": [

    {

      "id": 554,

      "adspaceId": "4b782606-a17f-427f-9acb-e42ba1397713",

      "adspaceName": "My Adspace",

      "programId": "9b98db20-5cfa-4bf9-97b6-b56a60a0c373",

      "programName": "My Program WW",

      "subId": "abc_123-2",

      "date": "2022-08-03",

      "count": 100,

      "productId": "MONETIZE_API",

      "updatedAt": "2021-08-03T19:53:15.816Z"

    }

  ]

}

To view possible error responses, refer to the Error responses article.