What Google Search Console measured

Embed

<a href="https://seolyticize.com/docs/ref-get-search-console-performance"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/29964519-3032-461d-b6bd-824dc4f187f0/social-card.svg?v=3e7ae33eec8b" alt="What Google Search Console measured" width="600" height="315"></a>

POSThttps://seolyticize.com/api/v1/tools/get_search_console_performance

Clicks, impressions and position from the client's own Google Search Console, for one search type (web, image, video, news, discover, googleNews) over a date range, optionally filtered to one country (ISO 3166-1 alpha-3, e.g. gbr) and one device. Ask for any of the dimensions date, query, page, country and device; asking for both page and query returns the page-by-query drill-down, which has no country or device split. Answers 'what did this site actually earn in Google'. Discover and Google News have no queries and no position. Days Google is still counting are marked provisional. Returns a refusal with a reason when Search Console is not connected or a filter does not apply.

Request body application/json

clientIdstringrequired

searchTypestring

fromstringrequired

tostringrequired

countrystring

= null

devicestring

= null

dimensionsstring[]

= ["date","query","page"]

pagestring

= null

querystring

= null

{
  "clientId": "string",
  "searchType": "web",
  "from": "string",
  "to": "string",
  "country": null,
  "device": null,
  "dimensions": [
    "date",
    "query",
    "page"
  ],
  "page": null,
  "query": null
}

Code samples

cURL

curl -X POST "https://seolyticize.com/api/v1/tools/get_search_console_performance" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","searchType":"web","from":"string","to":"string","country":null,"device":null,"dimensions":["date","query","page"],"page":null,"query":null}'

TypeScript

const res = await fetch('https://seolyticize.com/api/v1/tools/get_search_console_performance', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"clientId":"string","searchType":"web","from":"string","to":"string","country":null,"device":null,"dimensions":["date","query","page"],"page":null,"query":null}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://seolyticize.com/api/v1/tools/get_search_console_performance",
    headers={
    "Content-Type": "application/json",
    },
    json={"clientId": "string", "searchType": "web", "from": "string", "to": "string", "country": None, "device": None, "dimensions": ["date", "query", "page"], "page": None, "query": None},
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://seolyticize.com/api/v1/tools/get_search_console_performance", strings.NewReader(`{"clientId":"string","searchType":"web","from":"string","to":"string","country":null,"device":null,"dimensions":["date","query","page"],"page":null,"query":null}`))
	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_search_console_performance');
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","searchType":"web","from":"string","to":"string","country":null,"device":null,"dimensions":["date","query","page"],"page":null,"query":null}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://seolyticize.com/api/v1/tools/get_search_console_performance')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"clientId":"string","searchType":"web","from":"string","to":"string","country":null,"device":null,"dimensions":["date","query","page"],"page":null,"query":null}'
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_search_console_performance"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"clientId\":\"string\",\"searchType\":\"web\",\"from\":\"string\",\"to\":\"string\",\"country\":null,\"device\":null,\"dimensions\":[\"date\",\"query\",\"page\"],\"page\":null,\"query\":null}"))
    .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