Usage log
curl --request POST \
--url https://api.platform.soax.com/v1/proxy/analytics/log \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from_date": "2026-08-01T00:00:00Z",
"to_date": "2026-08-07T23:59:59Z",
"limit": 2,
"countries": [
"us"
],
"include_total": true
}
'import requests
url = "https://api.platform.soax.com/v1/proxy/analytics/log"
payload = {
"from_date": "2026-08-01T00:00:00Z",
"to_date": "2026-08-07T23:59:59Z",
"limit": 2,
"countries": ["us"],
"include_total": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from_date: '2026-08-01T00:00:00Z',
to_date: '2026-08-07T23:59:59Z',
limit: 2,
countries: ['us'],
include_total: true
})
};
fetch('https://api.platform.soax.com/v1/proxy/analytics/log', 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://api.platform.soax.com/v1/proxy/analytics/log",
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([
'from_date' => '2026-08-01T00:00:00Z',
'to_date' => '2026-08-07T23:59:59Z',
'limit' => 2,
'countries' => [
'us'
],
'include_total' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.platform.soax.com/v1/proxy/analytics/log"
payload := strings.NewReader("{\n \"from_date\": \"2026-08-01T00:00:00Z\",\n \"to_date\": \"2026-08-07T23:59:59Z\",\n \"limit\": 2,\n \"countries\": [\n \"us\"\n ],\n \"include_total\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.platform.soax.com/v1/proxy/analytics/log")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from_date\": \"2026-08-01T00:00:00Z\",\n \"to_date\": \"2026-08-07T23:59:59Z\",\n \"limit\": 2,\n \"countries\": [\n \"us\"\n ],\n \"include_total\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.platform.soax.com/v1/proxy/analytics/log")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from_date\": \"2026-08-01T00:00:00Z\",\n \"to_date\": \"2026-08-07T23:59:59Z\",\n \"limit\": 2,\n \"countries\": [\n \"us\"\n ],\n \"include_total\": true\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"date": "2026-08-07T14:00:00Z",
"package": {
"id": "b2f0c3d4-e5a6-4b7c-8d9e-0f1a2b3c4d5e",
"name": "Scraping",
"key": "pk_live_example",
"network_types": [
"residential"
],
"status": "active"
},
"ingress_ip": "203.0.113.10",
"proxy_type": "residential",
"tier": 1,
"country": "us",
"domain": "example.com",
"traffic_gb": 1.25,
"credits_burned": 2.5
}
],
"pagination_metadata": {
"has_more": true,
"next_cursor": "eyJvIjoyfQ",
"total": 148
}
}{
"error": "hour interval requires a date range less than 24 hours"
}{
"detail": "Invalid API key"
}{
"detail": "Missing required scope: proxy:packages:read"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error": "Rate limit exceeded: 5 per 1 second"
}Analytics
Usage log
Retrieve the paginated per-request usage log for the packages your API key can access, with traffic and credits per entry. The date range is at most 90 days. Ordering by a non-date column needs a range of at most 31 days or a package_ids filter. Pass pagination_metadata.next_cursor as cursor to fetch the next page while has_more is true.
If the API key is restricted to specific packages, results (and any package_ids filter) are limited to those packages.
Requires the proxy:analytics:read scope.
POST
/
v1
/
proxy
/
analytics
/
log
Usage log
curl --request POST \
--url https://api.platform.soax.com/v1/proxy/analytics/log \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from_date": "2026-08-01T00:00:00Z",
"to_date": "2026-08-07T23:59:59Z",
"limit": 2,
"countries": [
"us"
],
"include_total": true
}
'import requests
url = "https://api.platform.soax.com/v1/proxy/analytics/log"
payload = {
"from_date": "2026-08-01T00:00:00Z",
"to_date": "2026-08-07T23:59:59Z",
"limit": 2,
"countries": ["us"],
"include_total": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
from_date: '2026-08-01T00:00:00Z',
to_date: '2026-08-07T23:59:59Z',
limit: 2,
countries: ['us'],
include_total: true
})
};
fetch('https://api.platform.soax.com/v1/proxy/analytics/log', 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://api.platform.soax.com/v1/proxy/analytics/log",
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([
'from_date' => '2026-08-01T00:00:00Z',
'to_date' => '2026-08-07T23:59:59Z',
'limit' => 2,
'countries' => [
'us'
],
'include_total' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.platform.soax.com/v1/proxy/analytics/log"
payload := strings.NewReader("{\n \"from_date\": \"2026-08-01T00:00:00Z\",\n \"to_date\": \"2026-08-07T23:59:59Z\",\n \"limit\": 2,\n \"countries\": [\n \"us\"\n ],\n \"include_total\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.platform.soax.com/v1/proxy/analytics/log")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"from_date\": \"2026-08-01T00:00:00Z\",\n \"to_date\": \"2026-08-07T23:59:59Z\",\n \"limit\": 2,\n \"countries\": [\n \"us\"\n ],\n \"include_total\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.platform.soax.com/v1/proxy/analytics/log")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from_date\": \"2026-08-01T00:00:00Z\",\n \"to_date\": \"2026-08-07T23:59:59Z\",\n \"limit\": 2,\n \"countries\": [\n \"us\"\n ],\n \"include_total\": true\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"date": "2026-08-07T14:00:00Z",
"package": {
"id": "b2f0c3d4-e5a6-4b7c-8d9e-0f1a2b3c4d5e",
"name": "Scraping",
"key": "pk_live_example",
"network_types": [
"residential"
],
"status": "active"
},
"ingress_ip": "203.0.113.10",
"proxy_type": "residential",
"tier": 1,
"country": "us",
"domain": "example.com",
"traffic_gb": 1.25,
"credits_burned": 2.5
}
],
"pagination_metadata": {
"has_more": true,
"next_cursor": "eyJvIjoyfQ",
"total": 148
}
}{
"error": "hour interval requires a date range less than 24 hours"
}{
"detail": "Invalid API key"
}{
"detail": "Missing required scope: proxy:packages:read"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error": "Rate limit exceeded: 5 per 1 second"
}Authorizations
API key secret (starts with s_live_). Create keys in the dashboard under Settings → API keys, or via POST /v1/api-keys/. Send it as Authorization: Bearer <secret>.
Body
application/json
Request model for the usage log.
Was this page helpful?