Obter analytics de tráfego do site

GET

apps

{app_id}

network

analytics

Obter analytics de tráfego do site

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/network/analytics \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/network/analytics"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/network/analytics', 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.squarecloud.app/v2/apps/{app_id}/network/analytics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/network/analytics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/network/analytics")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "visits": [
      { "visits": 1024, "requests": 1247, "bytes": 8421000, "date": "2026-05-21T10:00:00Z" }
    ],
    "countries": [
      { "type": "BR", "visits": 612, "requests": 743, "bytes": 5012000, "date": "2026-05-21T10:00:00Z" }
    ],
    "devices": [
      { "type": "desktop", "visits": 820, "requests": 998, "bytes": 6700000, "date": "2026-05-21T10:00:00Z" }
    ],
    "os": [
      { "type": "Windows", "visits": 540, "requests": 651, "bytes": 4400000, "date": "2026-05-21T10:00:00Z" }
    ],
    "browsers": [
      { "type": "Chrome", "visits": 720, "requests": 870, "bytes": 5800000, "date": "2026-05-21T10:00:00Z" }
    ],
    "protocols": [
      { "type": "HTTP/2", "visits": 900, "requests": 1100, "bytes": 7400000, "date": "2026-05-21T10:00:00Z" }
    ],
    "methods": [
      { "type": "GET", "visits": 850, "requests": 1020, "bytes": 6900000, "date": "2026-05-21T10:00:00Z" }
    ],
    "paths": [
      { "type": "/", "visits": 410, "requests": 498, "bytes": 3320000, "date": "2026-05-21T10:00:00Z" }
    ],
    "referers": [
      { "type": "Direct", "visits": 380, "requests": 462, "bytes": 3100000, "date": "2026-05-21T10:00:00Z" }
    ],
    "providers": [
      { "type": "GOOGLE (15169)", "visits": 210, "requests": 254, "bytes": 1700000, "date": "2026-05-21T10:00:00Z" }
    ],
    "ips": [
      { "type": "203.0.113.45", "visits": 40, "requests": 3120, "bytes": 2100000 }
    ],
    "status_codes": [
      { "type": "200", "visits": 950, "requests": 1180, "bytes": 8100000 }
    ],
    "bots": [
      { "type": "Search Engine Crawler", "visits": 0, "requests": 84, "bytes": 410000 }
    ],
    "content_types": [
      { "type": "json", "visits": 310, "requests": 720, "bytes": 4200000 }
    ]
  }
}

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Requer uma chave de API com o escopo apps:read. A Análise agrega o tráfego de borda do Cloudflare para o domínio squareweb.app padrão da aplicação e qualquer domínio personalizado associado: contagem de requisições, banda, contagem de visitantes e detalhamentos por país, dispositivo, sistema operacional, navegador, protocolo, método, caminho, referer e rede do cliente. Use-a para montar dashboards de tráfego ou identificar padrões incomuns sem precisar puxar logs brutos de requisições. Os resultados ficam em cache em blocos de 5 minutos, então fazer polling repetido da mesma janela é barato. O cache miss compartilha um limite único de 20 requisições por 60 segundos por proprietário da aplicação, entre os endpoints de análise, erros, logs e performance. Respostas em cache não contam. Em períodos de alta demanda em toda a plataforma, o endpoint pode retornar os dados em cache mais recentes da janela solicitada. A janela máxima de retenção é de 7 dias, e o início efetivo é limitado à data de criação da aplicação. Diferente de Logs de rede e Performance de rede, este endpoint está disponível em todos os planos, não apenas Pro e Enterprise. Para tráfego focado em erros em vez de tráfego geral, veja Erros de rede. Para limpar as respostas em cache na borda após um deploy, veja Limpar cache.

Parâmetros

string

obrigatório

O ID da aplicação. Você pode encontrá-lo na URL da sua aplicação no dashboard.

string

obrigatório

Timestamp inicial em formato ISO 8601 para a janela de análise. A janela máxima de retenção é de 7 dias; o início é limitado à data de criação da aplicação.

string

obrigatório

Timestamp final em formato ISO 8601. Deve ser posterior ao start.

Filtros de detalhamento

Filtros opcionais que restringem todos os detalhamentos ao tráfego correspondente. Reutilize o valor type exato retornado pelo detalhamento correspondente em uma resposta anterior. Os filtros combinam entre si (E lógico).

string

Um único país do cliente (código de 2 caracteres), conforme retornado no detalhamento countries.

string

Um único IP do cliente (correspondência exata IPv4/IPv6), conforme retornado no detalhamento ips.

string

Caminhos de requisição que começam com este prefixo (ex.: /api cobre /api/*). Máx. 256 caracteres.

string

Um único código de status de resposta da edge (3 dígitos), conforme retornado no detalhamento status_codes.

string

Um único sistema operacional do cliente, conforme retornado no detalhamento os.

string

Um único navegador do cliente, conforme retornado no detalhamento browsers.

string

Um único protocolo HTTP, conforme retornado no detalhamento protocols.

string

Um único host de referência, conforme retornado no detalhamento referers (Direct = sem referer).

string

Uma única rede do cliente, com o valor exato de type que o detalhamento providers retorna, por exemplo GOOGLE (15169). Um número de ASN puro ou SQUARE-CLOUD-PLATFORM também funcionam. Qualquer outro valor responde INVALID_FILTER.

string

Um único tipo de conteúdo da resposta, conforme retornado no detalhamento content_types (Unknown = não classificado).

string

Uma única categoria de bot verificado, conforme retornada no detalhamento bots (Unverified = tráfego regular, não-bot).

Resposta

Esta rota pode retornar uma resposta em formato compactado, otimizando a transmissão de dados.

string

Indica se a chamada foi bem-sucedida: success se foi, error se não.

object

Cada detalhamento é um array de buckets. type identifica a dimensão, visits é o número de visitantes únicos, requests é a contagem de requisições, bytes é o total de bytes servidos na resposta, e date é o início da janela de 15 minutos. Os detalhamentos ips, status_codes, bots e content_types são totais da janela (top-N sobre toda a janela) e não possuem o campo date. Retorna um objeto vazio ({}) quando a janela solicitada começa antes da data de criação da aplicação.

{
  "status": "success",
  "response": {
    "visits": [
      { "visits": 1024, "requests": 1247, "bytes": 8421000, "date": "2026-05-21T10:00:00Z" }
    ],
    "countries": [
      { "type": "BR", "visits": 612, "requests": 743, "bytes": 5012000, "date": "2026-05-21T10:00:00Z" }
    ],
    "devices": [
      { "type": "desktop", "visits": 820, "requests": 998, "bytes": 6700000, "date": "2026-05-21T10:00:00Z" }
    ],
    "os": [
      { "type": "Windows", "visits": 540, "requests": 651, "bytes": 4400000, "date": "2026-05-21T10:00:00Z" }
    ],
    "browsers": [
      { "type": "Chrome", "visits": 720, "requests": 870, "bytes": 5800000, "date": "2026-05-21T10:00:00Z" }
    ],
    "protocols": [
      { "type": "HTTP/2", "visits": 900, "requests": 1100, "bytes": 7400000, "date": "2026-05-21T10:00:00Z" }
    ],
    "methods": [
      { "type": "GET", "visits": 850, "requests": 1020, "bytes": 6900000, "date": "2026-05-21T10:00:00Z" }
    ],
    "paths": [
      { "type": "/", "visits": 410, "requests": 498, "bytes": 3320000, "date": "2026-05-21T10:00:00Z" }
    ],
    "referers": [
      { "type": "Direct", "visits": 380, "requests": 462, "bytes": 3100000, "date": "2026-05-21T10:00:00Z" }
    ],
    "providers": [
      { "type": "GOOGLE (15169)", "visits": 210, "requests": 254, "bytes": 1700000, "date": "2026-05-21T10:00:00Z" }
    ],
    "ips": [
      { "type": "203.0.113.45", "visits": 40, "requests": 3120, "bytes": 2100000 }
    ],
    "status_codes": [
      { "type": "200", "visits": 950, "requests": 1180, "bytes": 8100000 }
    ],
    "bots": [
      { "type": "Search Engine Crawler", "visits": 0, "requests": 84, "bytes": 410000 }
    ],
    "content_types": [
      { "type": "json", "visits": 310, "requests": 720, "bytes": 4200000 }
    ]
  }
}

Erros comuns

Código	HTTP	Significado
`INVALID_TIME_RANGE`	400	`start`/`end` estão ausentes, malformados ou invertem o intervalo de tempo.
`INVALID_FILTER`	400	Um filtro de detalhamento não corresponde ao formato esperado.
`RATE_LIMITED`	429	O limite compartilhado de cache misses foi atingido. Aguarde e tente novamente.
`UNABLE_TO_FETCH_ANALYTICS`	500	Falha ao obter os dados de análise do provedor de edge.
`ANALYTICS_BUSY`	503	As análises de borda estão temporariamente ocupadas. Tente novamente em um minuto.

Relacionados

CLI: squarecloud app network analytics
SDKs: api.apps.network.analytics() (JavaScript), client.apps.network.analytics() (Python), c.Apps.Network.Analytics() (Go)

Obter analytics de tráfego do site

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/network/analytics \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/network/analytics"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/network/analytics', 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.squarecloud.app/v2/apps/{app_id}/network/analytics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/network/analytics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/network/analytics")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "visits": [
      { "visits": 1024, "requests": 1247, "bytes": 8421000, "date": "2026-05-21T10:00:00Z" }
    ],
    "countries": [
      { "type": "BR", "visits": 612, "requests": 743, "bytes": 5012000, "date": "2026-05-21T10:00:00Z" }
    ],
    "devices": [
      { "type": "desktop", "visits": 820, "requests": 998, "bytes": 6700000, "date": "2026-05-21T10:00:00Z" }
    ],
    "os": [
      { "type": "Windows", "visits": 540, "requests": 651, "bytes": 4400000, "date": "2026-05-21T10:00:00Z" }
    ],
    "browsers": [
      { "type": "Chrome", "visits": 720, "requests": 870, "bytes": 5800000, "date": "2026-05-21T10:00:00Z" }
    ],
    "protocols": [
      { "type": "HTTP/2", "visits": 900, "requests": 1100, "bytes": 7400000, "date": "2026-05-21T10:00:00Z" }
    ],
    "methods": [
      { "type": "GET", "visits": 850, "requests": 1020, "bytes": 6900000, "date": "2026-05-21T10:00:00Z" }
    ],
    "paths": [
      { "type": "/", "visits": 410, "requests": 498, "bytes": 3320000, "date": "2026-05-21T10:00:00Z" }
    ],
    "referers": [
      { "type": "Direct", "visits": 380, "requests": 462, "bytes": 3100000, "date": "2026-05-21T10:00:00Z" }
    ],
    "providers": [
      { "type": "GOOGLE (15169)", "visits": 210, "requests": 254, "bytes": 1700000, "date": "2026-05-21T10:00:00Z" }
    ],
    "ips": [
      { "type": "203.0.113.45", "visits": 40, "requests": 3120, "bytes": 2100000 }
    ],
    "status_codes": [
      { "type": "200", "visits": 950, "requests": 1180, "bytes": 8100000 }
    ],
    "bots": [
      { "type": "Search Engine Crawler", "visits": 0, "requests": 84, "bytes": 410000 }
    ],
    "content_types": [
      { "type": "json", "visits": 310, "requests": 720, "bytes": 4200000 }
    ]
  }
}

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Obter analytics de tráfego do site

Parâmetros

Filtros de detalhamento

Resposta

Erros comuns

Relacionados

​Parâmetros

​Filtros de detalhamento

​Resposta

​Erros comuns

​Relacionados

Parâmetros

Filtros de detalhamento

Resposta

Erros comuns

Relacionados