Skip to main content
POST
/
api
/
v2
/
advertiser
/
reports
/
statistics
Get statistics (POST)
curl --request POST \
  --url https://{domain}/api/v2/advertiser/reports/statistics \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "rangeFrom": "string",
  "rangeTo": "string",
  "page": 1,
  "perPage": 1,
  "sortField": "string",
  "sortDirection": "asc",
  "columns": "string"
}
'
import requests

url = "https://{domain}/api/v2/advertiser/reports/statistics"

payload = {
"rangeFrom": "string",
"rangeTo": "string",
"page": 1,
"perPage": 1,
"sortField": "string",
"sortDirection": "asc",
"columns": "string"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rangeFrom: 'string',
rangeTo: 'string',
page: 1,
perPage: 1,
sortField: 'string',
sortDirection: 'asc',
columns: 'string'
})
};

fetch('https://{domain}/api/v2/advertiser/reports/statistics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/v2/advertiser/reports/statistics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rangeFrom' => 'string',
'rangeTo' => 'string',
'page' => 1,
'perPage' => 1,
'sortField' => 'string',
'sortDirection' => 'asc',
'columns' => 'string'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://{domain}/api/v2/advertiser/reports/statistics"

payload := strings.NewReader("{\n \"rangeFrom\": \"string\",\n \"rangeTo\": \"string\",\n \"page\": 1,\n \"perPage\": 1,\n \"sortField\": \"string\",\n \"sortDirection\": \"asc\",\n \"columns\": \"string\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{domain}/api/v2/advertiser/reports/statistics")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rangeFrom\": \"string\",\n \"rangeTo\": \"string\",\n \"page\": 1,\n \"perPage\": 1,\n \"sortField\": \"string\",\n \"sortDirection\": \"asc\",\n \"columns\": \"string\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v2/advertiser/reports/statistics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rangeFrom\": \"string\",\n \"rangeTo\": \"string\",\n \"page\": 1,\n \"perPage\": 1,\n \"sortField\": \"string\",\n \"sortDirection\": \"asc\",\n \"columns\": \"string\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>",
  "timezone": "<string>",
  "rows": [
    {}
  ],
  "totals": {}
}
{
"message": "Request could not be parsed.",
"success": false,
"info": {
"errors": {}
}
}
{
"message": "API key is invalid or missing.",
"success": false
}
{
"message": "This endpoint is not available for your role.",
"success": false
}
{
"message": "Validation error",
"success": false,
"info": {
"errors": {
"email": [
"Email cannot be blank."
],
"currency": [
"Currency must be a valid ISO code."
]
}
}
}
{
"message": "An unexpected error occurred.",
"success": false,
"info": {
"errors": {}
}
}

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Body

application/json
rangeFrom
string
required

Supports YYYY-MM-DD and YYYY-MM-DD HH:mm:ss.

rangeTo
string
required

Supports YYYY-MM-DD and YYYY-MM-DD HH:mm:ss.

page
integer
perPage
integer
sortField
string
sortDirection
enum<string>
Available options:
asc,
desc
columns
string
breakdown
string
breakdowns
string
filters
object

Response

Aggregated statistics.

message
string
timezone
string
rows
object[]
totals
object