Search Console

Dados de desempenho do Google Search Console (impressões, cliques, CTR, posição média) para projetos com uma propriedade do GSC ligada. Requer o plano Growth ou superior. ctr é uma fração entre 0 e 1 e position é a média ponderada pelas impressões. O cabeçalho de resposta X-Search-Console-Backend identifica se as leituras são stored ou live. As leituras de dados sincronizados usam dados já sincronizados sem contactar o Google. As leituras em direto devolvem ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) quando o acesso ao Google foi revogado; volte a ligar a propriedade em Preferências > Definições do projeto > Ligações de dados. Devolvem ERR_SEARCH_CONSOLE_UPSTREAM (503) quando o Google está indisponível ou a quota foi excedida; aguarde o número de segundos indicado em Retry-After antes de tentar novamente. As leituras de dados sincronizados recusam consultas, páginas e pedidos restringidos com ERR_INVALID_PARAM. Para consultas e páginas, total conta as linhas de um único pedido ao Google, até 25 000 (truncated: true quando esse limite é atingido). A soma das linhas das listas não corresponde aos totais: para obter o total de um conjunto de páginas ou consultas, chame /search_console/summary com filters e sem dimension.

GET`/search_console/summary`

Totais gerais do intervalo, de toda a propriedade salvo se filters os restringir, com uma desagregação opcional agregada no mesmo intervalo. breakdown_truncated: true significa que a desagregação omitiu linhas. As linhas da dimensão query excluem as consultas anonimizadas, e as das dimensões page e searchAppearance são contabilizadas por página e não por propriedade, pelo que as linhas da desagregação podem diferir dos totais.

Parâmetros:

project_idobrigatório
range
from
to
dimensioncountry|device|page|query|searchAppearance
limitpredefinido e máximo 1000
search_typeweb|image|video|news|discover|googleNews
filters
data_statefinal|all
aggregation_typeauto|byPage|byProperty

GET`/search_console/timeseries`

Séries agrupadas por dia, semana ou mês, de toda a propriedade salvo se filters as restringir.

Parâmetros:

project_idobrigatório
range
from
to
granularityday|week|month
search_typeweb|image|video|news|discover|googleNews
filters
data_statefinal|all
aggregation_typeauto|byPage|byProperty
outputflat|csv

GET`/search_console/queries`

Principais consultas de pesquisa do intervalo, ordenadas e paginadas. Subestima intencionalmente as consultas anonimizadas, pelo que não somam exatamente os totais do resumo (tal como na interface do GSC).

Parâmetros:

project_idobrigatório
range
from
to
sortimpressions|clicks|ctr|position
page
per_page
start_row
search_typeweb|image|video|news|discover|googleNews
filters
data_statefinal|all
aggregation_typeauto|byPage|byProperty
outputflat|csv

GET`/search_console/pages`

Principais páginas de destino do intervalo, ordenadas e paginadas. O mesmo formato do endpoint de consultas, em que a chave de cada linha é um URL de página.

Parâmetros:

project_idobrigatório
range
from
to
sortimpressions|clicks|ctr|position
page
per_page
start_row
search_typeweb|image|video|news|discover|googleNews
filters
data_statefinal|all
aggregation_typeauto|byPage|byProperty
outputflat|csv

GET`/search_console/rows`

Linhas agrupadas por até três dimensões, por exemplo página e consulta, ou data e página, ordenadas e paginadas. Cada dimensão ocupa um campo próprio. O Google devolve, no máximo, 25 000 linhas por pedido: truncated: true indica que esse limite foi atingido e start_row lê o bloco seguinte.

Parâmetros:

project_idobrigatório
dimensionsobrigatório, lista separada por vírgulas com 1 a 3 valores entre date|country|device|page|query|searchAppearance
range
from
to
sortimpressions|clicks|ctr|position
page
per_page
start_row
search_type
filters
data_statefinal|all
aggregation_typeauto|byPage|byProperty
outputflat|csv

Exemplos de código

Download: OpenAPI Swagger Postman

Perguntar à IA: Abrir no ChatGPT Abrir no Claude Ver como Markdown

Linguagem

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/search_console/summary?project_id=PROJECT_ID&range=30&dimension=page&limit=50"

const response = await fetch("https://api.llmpulse.ai/api/v1/search_console/summary?project_id=PROJECT_ID&range=30&dimension=page&limit=50", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/search_console/summary?project_id=PROJECT_ID&range=30&dimension=page&limit=50",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/search_console/summary?project_id=PROJECT_ID&range=30&dimension=page&limit=50",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/search_console/summary?project_id=PROJECT_ID&range=30&dimension=page&limit=50", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/search_console/summary?project_id=PROJECT_ID&range=30&dimension=page&limit=50', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/search_console/summary?project_id=PROJECT_ID&range=30&dimension=page&limit=50"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/search_console/timeseries?project_id=PROJECT_ID&range=30&granularity=day&data_state=all"

const response = await fetch("https://api.llmpulse.ai/api/v1/search_console/timeseries?project_id=PROJECT_ID&range=30&granularity=day&data_state=all", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/search_console/timeseries?project_id=PROJECT_ID&range=30&granularity=day&data_state=all",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/search_console/timeseries?project_id=PROJECT_ID&range=30&granularity=day&data_state=all",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/search_console/timeseries?project_id=PROJECT_ID&range=30&granularity=day&data_state=all", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/search_console/timeseries?project_id=PROJECT_ID&range=30&granularity=day&data_state=all', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/search_console/timeseries?project_id=PROJECT_ID&range=30&granularity=day&data_state=all"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/search_console/queries?project_id=PROJECT_ID&range=30&per_page=50&filters=[{"dimension":"page","operator":"contains","expression":"/guides/"}]"

const response = await fetch("https://api.llmpulse.ai/api/v1/search_console/queries?project_id=PROJECT_ID&range=30&per_page=50&filters=[{"dimension":"page","operator":"contains","expression":"/guides/"}]", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/search_console/queries?project_id=PROJECT_ID&range=30&per_page=50&filters=[{"dimension":"page","operator":"contains","expression":"/guides/"}]",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/search_console/queries?project_id=PROJECT_ID&range=30&per_page=50&filters=[{"dimension":"page","operator":"contains","expression":"/guides/"}]",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/search_console/queries?project_id=PROJECT_ID&range=30&per_page=50&filters=[{"dimension":"page","operator":"contains","expression":"/guides/"}]", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/search_console/queries?project_id=PROJECT_ID&range=30&per_page=50&filters=[{"dimension":"page","operator":"contains","expression":"/guides/"}]', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/search_console/queries?project_id=PROJECT_ID&range=30&per_page=50&filters=[{"dimension":"page","operator":"contains","expression":"/guides/"}]"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/search_console/pages?project_id=PROJECT_ID&range=30&per_page=50&search_type=news"

const response = await fetch("https://api.llmpulse.ai/api/v1/search_console/pages?project_id=PROJECT_ID&range=30&per_page=50&search_type=news", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/search_console/pages?project_id=PROJECT_ID&range=30&per_page=50&search_type=news",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/search_console/pages?project_id=PROJECT_ID&range=30&per_page=50&search_type=news",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/search_console/pages?project_id=PROJECT_ID&range=30&per_page=50&search_type=news", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/search_console/pages?project_id=PROJECT_ID&range=30&per_page=50&search_type=news', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/search_console/pages?project_id=PROJECT_ID&range=30&per_page=50&search_type=news"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Search Console

GET/search_console/summary

GET/search_console/timeseries

GET/search_console/queries

GET/search_console/pages

GET/search_console/rows

GET`/search_console/summary`

GET`/search_console/timeseries`

GET`/search_console/queries`

GET`/search_console/pages`

GET`/search_console/rows`