Search Console

Leistungsdaten aus der Google Search Console (Impressionen, Klicks, CTR, durchschnittliche Position) für Projekte mit verbundener GSC-Property. Verfügbar ab Tarif Growth. ctr ist ein Anteil von 0 bis 1, position der nach Impressionen gewichtete Durchschnitt. Der Antwort-Header X-Search-Console-Backend zeigt, ob gespeicherte Daten (stored) oder Live-Daten (live) gelesen wurden. Abfragen gespeicherter Daten nutzen die synchronisierten Daten, ohne Google zu kontaktieren. Live-Abfragen geben bei widerrufenem Google-Zugriff ERR_SEARCH_CONSOLE_ACCESS_REVOKED (403) zurück. Verbinden Sie die Property dann unter Einstellungen > Projekteinstellungen > Datenverbindungen erneut. Ist Google nicht verfügbar oder das Kontingent überschritten, geben Live-Abfragen ERR_SEARCH_CONSOLE_UPSTREAM (503) zurück. Warten Sie dann die in Retry-After angegebene Anzahl Sekunden, bevor Sie es erneut versuchen. Bei Abfragen gespeicherter Daten werden Auswertungen nach Suchanfragen und Seiten sowie eingegrenzte Anfragen mit ERR_INVALID_PARAM abgelehnt. Für Suchanfragen und Seiten zählt total die Zeilen einer einzelnen Anfrage an Google, höchstens 25.000 (bei Erreichen dieser Grenze truncated: true). Die Zeilenlisten ergeben in der Summe nicht die Gesamtwerte: Um die Summe für eine Gruppe von Seiten oder Suchanfragen zu bilden, rufen Sie /search_console/summary mit filters und ohne dimension auf. Ein Projekt kann bis zu 10 Properties verbinden: property liest eine davon (ohne Angabe die primäre) oder kombiniert mehrere über eine kommagetrennte Liste oder all.

GET`/search_console/properties`

Die mit dem Projekt verbundenen Properties, die primäre zuerst, jeweils mit Typ (domain oder url_prefix) und Status. Jede ID ist ein Wert, den der Parameter property der übrigen Endpunkte für die Search Console akzeptiert.

Parameter:

project_iderforderlich
outputflat|csv

GET`/search_console/summary`

Die wichtigsten Gesamtwerte für den Zeitraum (für die gesamte Property, sofern filters sie nicht eingrenzt), optional mit einer Aufschlüsselung über denselben Zeitraum. breakdown_truncated: true bedeutet, dass in der Aufschlüsselung Zeilen fehlen. Zeilen für Suchanfragen enthalten keine anonymisierten Suchanfragen, und Zeilen für page und searchAppearance werden pro Seite statt pro Property gezählt. Daher können die Zeilen der Aufschlüsselung von den Gesamtwerten abweichen.

Parameter:

project_iderforderlich
propertyeine ID, eine kommagetrennte Liste oder all
range
from
to
dimensioncountry|device|page|query|searchAppearance|property
limitStandard und Maximum: 1.000
search_typeweb|image|video|news|discover|googleNews
filters
data_statefinal|all
aggregation_typeauto|byPage|byProperty

GET`/search_console/timeseries`

Zeitreihen, nach Tag, Woche oder Monat gruppiert, für die gesamte Property, sofern filters sie nicht eingrenzt.

Parameter:

project_iderforderlich
propertyeine ID, eine kommagetrennte Liste oder all
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`

Die Top-Suchanfragen im Zeitraum, sortiert und paginiert. Anonymisierte Suchanfragen werden bewusst nicht vollständig erfasst, daher ergibt die Summe der Zeilen nicht genau die Gesamtwerte der Zusammenfassung (wie in der Oberfläche der Search Console).

Parameter:

project_iderforderlich
propertyeine ID, eine kommagetrennte Liste oder all
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`

Die Top-Landingpages im Zeitraum, sortiert und paginiert. Gleiches Format wie beim Endpunkt für Suchanfragen, wobei der Schlüssel jeder Zeile die URL einer Seite ist.

Parameter:

project_iderforderlich
propertyeine ID, eine kommagetrennte Liste oder all
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`

Zeilen, gruppiert nach bis zu drei Dimensionen (zum Beispiel Seite und Suchanfrage oder Datum und Seite), sortiert und paginiert. Jede Dimension ist ein eigenes Feld. Google liefert höchstens 25.000 Zeilen pro Anfrage: truncated: true kennzeichnet ein volles Fenster, und mit start_row lesen Sie das nächste.

Parameter:

project_iderforderlich
dimensionserforderlich, kommagetrennt, 1 bis 3 aus date|country|device|page|query|searchAppearance|property
propertyeine ID, eine kommagetrennte Liste oder all
range
from
to
sortimpressions|clicks|ctr|position
page
per_page
start_row
search_type
filters
data_statefinal|all
aggregation_typeauto|byPage|byProperty
outputflat|csv

Codebeispiele

Download: OpenAPI Swagger Postman

KI fragen: In ChatGPT öffnen In Claude öffnen Als Markdown anzeigen

Sprache

Request

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/search_console/properties?project_id=PROJECT_ID"

const response = await fetch("https://api.llmpulse.ai/api/v1/search_console/properties?project_id=PROJECT_ID", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/search_console/properties?project_id=PROJECT_ID",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/search_console/properties?project_id=PROJECT_ID",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

package main

import "net/http"

func main() {
	req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/search_console/properties?project_id=PROJECT_ID", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

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

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.llmpulse.ai/api/v1/search_console/properties?project_id=PROJECT_ID"))
            .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/summary?project_id=PROJECT_ID&property=all&range=30&dimension=page&limit=50"

const response = await fetch("https://api.llmpulse.ai/api/v1/search_console/summary?project_id=PROJECT_ID&property=all&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&property=all&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&property=all&range=30&dimension=page&limit=50",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

package main

import "net/http"

func main() {
	req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/search_console/summary?project_id=PROJECT_ID&property=all&range=30&dimension=page&limit=50", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	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&property=all&range=30&dimension=page&limit=50', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.llmpulse.ai/api/v1/search_console/summary?project_id=PROJECT_ID&property=all&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

package main

import "net/http"

func main() {
	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, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	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);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        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=%5B%7B%22dimension%22%3A%22page%22,%22operator%22%3A%22contains%22,%22expression%22%3A%22%2Fguides%2F%22%7D%5D"

const response = await fetch("https://api.llmpulse.ai/api/v1/search_console/queries?project_id=PROJECT_ID&range=30&per_page=50&filters=%5B%7B%22dimension%22%3A%22page%22,%22operator%22%3A%22contains%22,%22expression%22%3A%22%2Fguides%2F%22%7D%5D", {
  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=%5B%7B%22dimension%22%3A%22page%22,%22operator%22%3A%22contains%22,%22expression%22%3A%22%2Fguides%2F%22%7D%5D",
    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=%5B%7B%22dimension%22%3A%22page%22,%22operator%22%3A%22contains%22,%22expression%22%3A%22%2Fguides%2F%22%7D%5D",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

package main

import "net/http"

func main() {
	req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/search_console/queries?project_id=PROJECT_ID&range=30&per_page=50&filters=%5B%7B%22dimension%22%3A%22page%22,%22operator%22%3A%22contains%22,%22expression%22%3A%22%2Fguides%2F%22%7D%5D", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	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=%5B%7B%22dimension%22%3A%22page%22,%22operator%22%3A%22contains%22,%22expression%22%3A%22%2Fguides%2F%22%7D%5D', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        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=%5B%7B%22dimension%22%3A%22page%22,%22operator%22%3A%22contains%22,%22expression%22%3A%22%2Fguides%2F%22%7D%5D"))
            .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

package main

import "net/http"

func main() {
	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, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	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);

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        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/properties

GET/search_console/summary

GET/search_console/timeseries

GET/search_console/queries

GET/search_console/pages

GET/search_console/rows

GET`/search_console/properties`

GET`/search_console/summary`

GET`/search_console/timeseries`

GET`/search_console/queries`

GET`/search_console/pages`

GET`/search_console/rows`