Traffic by page, source, campaign, country or device (first-party)

Embed
Preview of the card
<a href="https://seolyticize.com/docs/ref-get-web-analytics-breakdown"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/04126cbe-0e3b-4b73-8202-62220a8e41a0/social-card.svg?v=3e7ae33eec8b" alt="Traffic by page, source, campaign, country or device (first-party)" width="600" height="315"></a>
POSThttps://seolyticize.com/api/v1/tools/get_web_analytics_breakdown

Lists the top rows of one breakdown from Seolyticize's own web analytics: pages (pageviews), entry_pages and exit_pages (visits), sources and referrers (visits; key null means direct), campaigns (visits, with detail "source / medium"), countries (ISO codes; null means unknown), devices, browsers, os, or custom events (event count). Each row has key, visitors and count; counts says what count counts, and totalKeys how many rows exist before the limit. Answers 'which pages and sources drive visits'. Refuses with a sentence when web analytics has not been set up for the client. Free.

Request body application/json
clientIdstringrequired
breakdownstringrequired
pages | entry_pages | exit_pages | sources | referrers | campaigns | countries | devices | browsers | os | events
daysnumber
The period: the last 7, 30 or 90 days, today included.
= 30
limitinteger
= 25
{
  "clientId": "string",
  "breakdown": "pages",
  "days": 30,
  "limit": 25
}
Code samples
cURL
curl -X POST "https://seolyticize.com/api/v1/tools/get_web_analytics_breakdown" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","breakdown":"pages","days":30,"limit":25}'
TypeScript
const res = await fetch('https://seolyticize.com/api/v1/tools/get_web_analytics_breakdown', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"clientId":"string","breakdown":"pages","days":30,"limit":25}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://seolyticize.com/api/v1/tools/get_web_analytics_breakdown",
    headers={
    "Content-Type": "application/json",
    },
    json={"clientId": "string", "breakdown": "pages", "days": 30, "limit": 25},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://seolyticize.com/api/v1/tools/get_web_analytics_breakdown", strings.NewReader(`{"clientId":"string","breakdown":"pages","days":30,"limit":25}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://seolyticize.com/api/v1/tools/get_web_analytics_breakdown');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"clientId":"string","breakdown":"pages","days":30,"limit":25}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://seolyticize.com/api/v1/tools/get_web_analytics_breakdown')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"clientId":"string","breakdown":"pages","days":30,"limit":25}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://seolyticize.com/api/v1/tools/get_web_analytics_breakdown"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"clientId\":\"string\",\"breakdown\":\"pages\",\"days\":30,\"limit\":25}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 The tool's result, under data.
Example
{
  "data": {}
}
Schema
datarequired
400 The body was not JSON or did not match the tool's input schema.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
401 No key, or a key that is unknown or revoked.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
403 The key's role does not permit the tool, or the key may not reach the named client.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
404 No tool by that name.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
422 A well-formed request the product declined, with the reason — a duplicate name, a plan limit, nothing configured to run.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
429 This key has used its window.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
500 The request could not be completed.
Example
{
  "error": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
Updated