Get report on actions (depricated)

Use this endpoint to get the report on actions performed in your account. 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/action

Method: GET

Request headers

Query parameters

You can use query parameters to retrieve information about specific actions.
This endpoint has no required parameters.

To get reports on actions 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, the information for the past 7 seven days is returned.
Use offset and limit parameters to paginate the response.

If no query parameters are specified, actions performed on all platforms in your account will be returned.

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

Request examples

• 
  curl --location --request GET --header 'Authorization: Bearer <Public Key>' \
  'http://api.takeads.com/v1/api/stats/action?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'
  
  

• fetch("http://api.takeads.com/v1/api/stats/action?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_URL => "http://api.takeads.com/v1/api/stats/action?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.HTTPConnection("api.takeads.com")
  
  payload = ""
  
  headers = {
  'Authorization': "Bearer <Public Key>",
  'Content-Type': "application/json"
  }
  
  conn.request("GET", "/v1/api/stats/action?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 action items is returned.

The returned actions are sorted by the updatedAt parameter.

The response payload is a JSON object that contains meta object with metadata and data array with the retrieved action items. Each item of the array is an object with information about the action.

The following table describes the response properties.

Example value

{

	"meta": {

		"limit": 500,

		"offset": 0,

		"total": 1

	},

	"data": [

		{

			"id": 3841030,

			"status": "CONFIRMED",

                        "orderType": "SALE",

			"adspaceId": "317ea576-72c9-4d9e-a963-092e10ddc212",

			"adspaceName": "name",

			"programId": "fe5b76de-c9a6-4960-ba34-fa239f8e0e47",

			"programName": "name",

			"subId": "test",

			"currencyCode": "EUR",

			"commission": 1.34,

			"revenue": 13.4,

			"productId": "MONETIZE_LINK_SCRIPT",

                        "paidOut": true,

                        "invoiceNumber": "4685261",

			"createdAt": "2022-07-15T10:33:22.659Z",

			"updatedAt": "2022-07-16T08:34:59.786Z"

		}

        ]

}

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