Przejdź do treści
ShopentlyLearn

Pobierz zapytania wyszukiwarki

Pobierz zapytania wyszukiwarki przez Shopently API. Parametry limit, cursor, days, source. Przykłady cURL, PHP i Python.

GET/api/v1/search/queries

Uwierzytelnianie
Bearer
Dostępne od planu
STANDARD
Wymagane uprawnienia
search.analytics:read

Przykłady kodu

Przykład żądania

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"'/api/v1/search/queries?limit=20'

PHP

<?php
declare(strict_types=1);

$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
    isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
    isset($origin['query']) || isset($origin['fragment'])) {
    throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
    throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/search/queries?limit=20');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
        if (str_contains($line, ':')) {
            [$name, $value] = explode(':', $line, 2);
            $responseHeaders[strtolower(trim($name))] = trim($value);
        }
        return strlen($line);
    },
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
    throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
    throw new RuntimeException('HTTP ' . $status . '; request_id=' .
        ($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;

Python

from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit

import requests  # python -m pip install requests

base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
    raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
    raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
    headers["Content-Type"] = "application/json"

with ExitStack() as stack:
    session = stack.enter_context(requests.Session())
    files = None
    if False:
        image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
        if os.fstat(image.fileno()).st_size > 5242880:
            raise ValueError("Image exceeds 5 MiB")
        files = {"file": ("article.png", image, "image/png")}
    response = session.request(
        'GET', base_url + '/api/v1/search/queries?limit=20', headers=headers,
        data=body.encode("utf-8") if body is not None else None, files=files,
        timeout=(5, 30), allow_redirects=False,
    )
    if not 200 <= response.status_code < 300:
        raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
    if False:
        if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
            raise ValueError("Unexpected image response")
        with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
            output.write(response.content)
    else:
        result = response.json() if response.content else None
        print(json.dumps(result, ensure_ascii=False, indent=2))

Przykład odpowiedzi 200

JSON
{
  "data": [
    {
      "clicks": 1,
      "last_seen_at": "2026-01-01T12:00:00Z",
      "query_display": "example",
      "query_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "searches": 1,
      "zero_results": 1
    }
  ],
  "meta": {
    "pagination": {
      "has_more": false,
      "limit": 20,
      "next_cursor": null
    },
    "period": {
      "as_of": "2026-01-02T00:00:00Z",
      "days": 1,
      "started_at": "2026-01-01T00:00:00Z"
    },
    "request_id": "example"
  }
}

Jak to działa

  • GET /api/v1/search/overview i /api/v1/search/queries udostępniają podsumowanie statystyk oraz zgrupowane zapytania.
  • Wystąpienia zapytania pobierz przy użyciu query_hash.
  • Raporty obsługują okresy 7, 30 lub 90 dni oraz filtry podane przy endpointach.
  • Reguły wyszukiwania łączą frazy z wybranymi produktami i kategoriami; można je tworzyć, odczytywać, zmieniać i usuwać.
  • Reguły i analityka mają oddzielne uprawnienia; odczyt statystyk nie przyznaje dostępu do konfiguracji.

Parametry

Parametry zapytania

limitLiczba całkowitaOpcjonalne

Maksymalna liczba rekordów na tej stronie.

minimum: 1maximum: 100
Wartość domyślna: 50Przykład: 20
cursorTekst nullOpcjonalne

Nieinterpretowany znacznik kontynuacji zwrócony na poprzedniej stronie.

Tekst:minLength: 1maxLength: 1024
daysLiczba całkowitaOpcjonalne

Okres raportowania w dniach.

Ograniczenia
enum
[7, 30, 90]
Wartość domyślna: 30
localeTekst nullOpcjonalne

Język wybrany dla tego żądania.

Tekst:minLength: 2maxLength: 20
Ograniczenia · Tekst 1
pattern
"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
sourceTekst nullOpcjonalne

Źródło zarejestrowanej aktywności.

Ograniczenia · Tekst 1
enum
["results", "autocomplete"]
market_idTekst nullOpcjonalne

Identyfikator rynku zwrócony przez endpoint kontekstu.

Ograniczenia · Tekst 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
queryTekstOpcjonalne

Tekst wyszukiwania lub filtr tego tekstu.

maxLength: 255
Wartość domyślna: ""
searches_minLiczba całkowita nullOpcjonalne

Filtr minimalnej liczby wyszukiwań.

Liczba całkowita:minimum: 0maximum: 9223372036854775807
searches_maxLiczba całkowita nullOpcjonalne

Filtr maksymalnej liczby wyszukiwań.

Liczba całkowita:minimum: 0maximum: 9223372036854775807
clicks_minLiczba całkowita nullOpcjonalne

Filtr minimalnej liczby kliknięć.

Liczba całkowita:minimum: 0maximum: 9223372036854775807
clicks_maxLiczba całkowita nullOpcjonalne

Filtr maksymalnej liczby kliknięć.

Liczba całkowita:minimum: 0maximum: 9223372036854775807
zero_results_minLiczba całkowita nullOpcjonalne

Filtr minimalnej liczby wyszukiwań bez wyników.

Liczba całkowita:minimum: 0maximum: 9223372036854775807
zero_results_maxLiczba całkowita nullOpcjonalne

Filtr maksymalnej liczby wyszukiwań bez wyników.

Liczba całkowita:minimum: 0maximum: 9223372036854775807
zero_result_scopeZeroResultScope Opcjonalne

Filtr wybierający wyszukiwania z wystąpieniami bez wyników lub bez takich wystąpień.

Wartość domyślna: "all"
sortQueryMetricSort Opcjonalne

Wybrana kolejność sortowania wyników.

Wartość domyślna: "last_seen_desc"

Ta operacja nie przyjmuje treści JSON.

Odpowiedzi

Odpowiedź 200

dataTablica <MetricData > Wymagane

Dane poprawnej odpowiedzi.

Pola · data

MetricData

clicksLiczba całkowitaWymagane

Liczba kliknięć.

last_seen_atTekstWymagane

Data i czas ostatniego wystąpienia.

format: "date-time"
query_displayTekstWymagane

Fraza wyszukiwania wyświetlana administratorowi.

query_hashTekstWymagane

Stały identyfikator zgrupowanej frazy wyszukiwania.

searchesLiczba całkowitaWymagane

Liczba wyszukiwań.

zero_resultsLiczba całkowitaWymagane

Liczba wyszukiwań bez wyników.

metaAnalyticsPageMeta AnalyticsMeta Wymagane

Metadane odpowiedzi.

Pola · meta

AnalyticsPageMeta

paginationPagination Wymagane

Metadane stronicowania z użyciem kursora.

periodAnalyticsPeriodData Wymagane

Okres raportowania i jego granice.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

AnalyticsMeta

periodAnalyticsPeriodData Wymagane

Okres raportowania i jego granice.

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100
Przykład odpowiedzi

Status HTTP

200
Poprawna odpowiedź Schemat
400
Nieprawidłowe żądanie
401
Wymagane uwierzytelnienie
403
Brak uprawnień
404
Nie znaleziono zasobu
409
Konflikt wersji
422
Błąd walidacji danych
429
Przekroczono limit zapytań
Pozostałe statusy HTTP (7)
405
Niedozwolona metoda
413
Zbyt duże żądanie
415
Nieobsługiwany format
500
Błąd serwera
502
Błąd bramy API
503
Usługa niedostępna
504
Przekroczono czas odpowiedzi

Katalog błędów: ErrorResponse

Nagłówki

401

WWW-AuthenticateTekstOpcjonalne

Schemat uwierzytelniania wymagany przez serwer.

405

AllowTekstOpcjonalne

Metody HTTP obsługiwane przez ten zasób.

429, 503

Retry-AfterLiczba całkowitaOpcjonalne

Minimalny czas przed ponowieniem, w sekundach.

minimum: 0