Pereiti prie turinio
ShopentlyLearn

Sąrašas · Paieškos užklausos — Paieškos analitika ir taisyklės

Skaitykite „Paieškos analitika ir taisyklės“ duomenis. Rezultatas priklauso nuo šio veiksmo parametrų.

GET/api/v1/search/queries

Tapatybės patvirtinimas
Bearer
Prieinama nuo plano
STANDARD
Būtinos teisės
search.analytics:read

Kodo pavyzdžiai

Užklausos pavyzdys

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))

Atsakymo pavyzdys 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"
  }
}

Kaip tai veikia

  • GET /api/v1/search/overview ir /api/v1/search/queries pateikia bendrą statistiką bei sugrupuotas užklausas.
  • Užklausos pasikartojimus gaukite naudodami jos query_hash.
  • Ataskaitų laikotarpiai yra 7, 30 arba 90 dienų, taikant kiekvieno prieigos taško išvardytus filtrus.
  • Paieškos taisyklės susieja frazes su pasirinktais produktais ir kategorijomis; jas galima kurti, skaityti, keisti ir šalinti.
  • Taisyklėms ir analitikai suteikiamos atskiros teisės; teisė skaityti paieškos statistiką nesuteikia prieigos prie konfigūracijos.

Parametrai

Užklausos parametrai

limitSveikasis skaičiusNeprivalomas

Didžiausias įrašų skaičius šiame puslapyje.

minimum: 1maximum: 100
Numatytoji reikšmė: 50Pavyzdys: 20
cursorEilutė nullNeprivalomas

Ankstesnio puslapio grąžinta tęsimo reikšmė; jos vidinės struktūros neinterpretuokite.

Eilutė:minLength: 1maxLength: 1024
daysSveikasis skaičiusNeprivalomas

Ataskaitos laikotarpis dienomis.

Apribojimai
enum
[7, 30, 90]
Numatytoji reikšmė: 30
localeEilutė nullNeprivalomas

Šiai užklausai pasirinkta kalba.

Eilutė:minLength: 2maxLength: 20
Apribojimai · Eilutė 1
pattern
"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
sourceEilutė nullNeprivalomas

Užregistruotos veiklos šaltinis.

Apribojimai · Eilutė 1
enum
["results", "autocomplete"]
market_idEilutė nullNeprivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

Apribojimai · Eilutė 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
queryEilutėNeprivalomas

Paieškos tekstas arba jo filtras.

maxLength: 255
Numatytoji reikšmė: ""
searches_minSveikasis skaičius nullNeprivalomas

Mažiausio paieškų skaičiaus filtras.

Sveikasis skaičius:minimum: 0maximum: 9223372036854775807
searches_maxSveikasis skaičius nullNeprivalomas

Didžiausio paieškų skaičiaus filtras.

Sveikasis skaičius:minimum: 0maximum: 9223372036854775807
clicks_minSveikasis skaičius nullNeprivalomas

Mažiausio paspaudimų skaičiaus filtras.

Sveikasis skaičius:minimum: 0maximum: 9223372036854775807
clicks_maxSveikasis skaičius nullNeprivalomas

Didžiausio paspaudimų skaičiaus filtras.

Sveikasis skaičius:minimum: 0maximum: 9223372036854775807
zero_results_minSveikasis skaičius nullNeprivalomas

Mažiausio paieškų be rezultatų skaičiaus filtras.

Sveikasis skaičius:minimum: 0maximum: 9223372036854775807
zero_results_maxSveikasis skaičius nullNeprivalomas

Didžiausio paieškų be rezultatų skaičiaus filtras.

Sveikasis skaičius:minimum: 0maximum: 9223372036854775807
zero_result_scopeZeroResultScope Neprivalomas

Filtras, pasirenkantis paieškas su rezultatų neturinčiais pasikartojimais arba be jų.

Numatytoji reikšmė: "all"
sortQueryMetricSort Neprivalomas

Rezultatams pasirinkta rikiavimo tvarka.

Numatytoji reikšmė: "last_seen_desc"

Ši operacija nepriima JSON turinio.

Atsakymai

Atsakymas 200

dataMasyvas <MetricData > Privalomas

Sėkmingo atsakymo duomenys.

Laukai · data

MetricData

clicksSveikasis skaičiusPrivalomas

Paspaudimų skaičius.

last_seen_atEilutėPrivalomas

Paskutinio pasirodymo laikas.

format: "date-time"
query_displayEilutėPrivalomas

Administratoriui rodoma paieškos frazė.

query_hashEilutėPrivalomas

Stabilus sugrupuotos paieškos frazės identifikatorius.

searchesSveikasis skaičiusPrivalomas

Paieškų skaičius.

zero_resultsSveikasis skaičiusPrivalomas

Paieškų be rezultatų skaičius.

metaAnalyticsPageMeta AnalyticsMeta Privalomas

Atsakymo metaduomenys.

Laukai · meta

AnalyticsPageMeta

paginationPagination Privalomas

Skaidymo į puslapius pagal žymeklį metaduomenys.

periodAnalyticsPeriodData Privalomas

Ataskaitos laikotarpis ir jo ribos.

request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100

AnalyticsMeta

periodAnalyticsPeriodData Privalomas

Ataskaitos laikotarpis ir jo ribos.

request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100
Atsakymo pavyzdys

HTTP būsena

200
Sėkmingas atsakymas Schema
400
Netinkama užklausa
401
Būtinas tapatybės patvirtinimas
403
Prieiga uždrausta
404
Išteklius nerastas
409
Versijų konfliktas
422
Tikrinimo klaida
429
Viršytas užklausų limitas
Kitos HTTP būsenos (7)
405
Metodas neleidžiamas
413
Užklausa per didelė
415
Nepalaikomas formatas
500
Serverio klaida
502
API tinklų sietuvo klaida
503
Paslauga nepasiekiama
504
Baigėsi laukimo laikas

Klaidų katalogas: ErrorResponse

Antraštės

401

WWW-AuthenticateEilutėNeprivalomas

Serverio reikalaujama tapatybės patvirtinimo schema.

405

AllowEilutėNeprivalomas

Šio ištekliaus palaikomi HTTP metodai.

429, 503

Retry-AfterSveikasis skaičiusNeprivalomas

Mažiausias laukimo laikas prieš kartojant, sekundėmis.

minimum: 0