Mine sisu juurde
ShopentlyLearn

Hangi · Otsingupäringud — Otsinguanalüüs ja reeglid

Lugege andmeid ressursist „Otsinguanalüüs ja reeglid“. Tulemus sõltub toimingu parameetritest.

GET/api/v1/search/queries/{query_hash}

Autentimine
Bearer
Saadaval alates
STANDARD
Nõutavad õigused
search.analytics:read

Koodinäited

Päringu näide

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/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa?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/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa?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/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa?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))

Vastuse näide 200

JSON
{
  "data": [
    {
      "category_id": "example",
      "category_result_count": 1,
      "currency_code": "PLN",
      "is_zero_results": false,
      "locale_code": "en",
      "market_id": "example",
      "max_price": "0.00",
      "min_price": "0.00",
      "occurred_at": "2026-01-01T12:00:00Z",
      "page": 1,
      "product_result_count": 1,
      "query_display": "example",
      "request_id": "example",
      "results": [
        {
          "clicked": false,
          "entity_id": "example",
          "entity_type": "product",
          "image_url": "https://example.invalid/product.jpg",
          "number": "example",
          "placement_source": "organic",
          "position": 1,
          "sku": "example",
          "slug": "example",
          "title": "example"
        }
      ],
      "sort_key": "example",
      "source": "results"
    }
  ],
  "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"
  }
}

Kuidas see toimib

  • GET /api/v1/search/overview ja /api/v1/search/queries annavad koondstatistika ning rühmitatud päringud.
  • Loe päringu esinemised selle query_hash abil.
  • Aruandeperiood on 7, 30 või 90 päeva; filtrid on loetletud iga lõpp-punkti juures.
  • Otsingureeglid seovad fraasid valitud toodete ja kategooriatega ning neid saab luua, lugeda, muuta või kustutada.
  • Reeglitel ja analüüsil on eraldi õigused; statistika lugemine ei anna seadistamisõigust.

Parameetrid

Tee parameetrid

query_hashStringKohustuslik

Rühmitatud otsingufraasi püsiv identifikaator.

Piirangud
pattern
"^[a-f0-9]{64}$"
Näide: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Päringu parameetrid

limitTäisarvValikuline

Kirjete maksimaalne arv sellel lehel.

minimum: 1maximum: 100
Vaikeväärtus: 50Näide: 20
cursorString nullValikuline

Eelmisel lehel tagastatud läbipaistmatu jätkuväärtus.

String:minLength: 1maxLength: 1024
daysTäisarvValikuline

Aruandeperiood päevades.

Piirangud
enum
[7, 30, 90]
Vaikeväärtus: 30
localeString nullValikuline

Selle päringu jaoks valitud keel.

String:minLength: 2maxLength: 20
Piirangud · String 1
pattern
"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
sourceString nullValikuline

Salvestatud tegevuse allikas.

Piirangud · String 1
enum
["results", "autocomplete"]
market_idString nullValikuline

Konteksti lõpp-punkti tagastatud turuidentifikaator.

Piirangud · String 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"

See toiming ei võta vastu JSON-sisu.

Vastused

Vastus 200

dataMassiiv <OccurrenceData > Kohustuslik

Eduka vastuse andmed.

Väljad · data

OccurrenceData

category_idString nullKohustuslik

Kategooria identifikaator.

category_result_countTäisarvKohustuslik

Kategooriatulemuste arv.

currency_codeStringKohustuslik

Valuutakood.

is_zero_resultsTõeväärtusKohustuslik

Kas otsing ei tagastanud tulemusi.

locale_codeStringKohustuslik

Keelekood.

market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

max_priceString nullKohustuslik

Esitatud vahemiku kõrgeim hind.

min_priceString nullKohustuslik

Esitatud vahemiku madalaim hind.

occurred_atStringKohustuslik

Sündmuse kuupäev ja kellaaeg.

format: "date-time"
pageTäisarvKohustuslik

CMS-lehe teave.

product_result_countTäisarvKohustuslik

Tooteotsingu tulemuste arv.

query_displayStringKohustuslik

Administraatorile kuvatav otsingufraas.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

resultsMassiiv <ResultSnapshotData > nullKohustuslik

Salvestatud otsingutulemused.

sort_keyStringKohustuslik

Järjestusvõti.

sourceStringKohustuslik

Salvestatud tegevuse allikas.

Piirangud
enum
["results", "autocomplete"]
metaAnalyticsPageMeta AnalyticsMeta Kohustuslik

Vastuse metaandmed.

Väljad · meta

AnalyticsPageMeta

paginationPagination Kohustuslik

Kursoripõhise lehekülgjaotuse metaandmed.

periodAnalyticsPeriodData Kohustuslik

Aruandeperiood ja selle piirid.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100

AnalyticsMeta

periodAnalyticsPeriodData Kohustuslik

Aruandeperiood ja selle piirid.

request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100
Vastuse näide

HTTP-olek

200
Edukas vastus Skeem
400
Vigane päring
401
Autentimine on nõutav
403
Juurdepääs keelatud
404
Ressurssi ei leitud
409
Versioonikonflikt
422
Valideerimine nurjus
429
Päringupiirang ületatud
Muud HTTP olekud (7)
405
Meetod pole lubatud
413
Päring on liiga suur
415
Vormingut ei toetata
500
Serveri viga
502
API lüüsi viga
503
Teenus pole saadaval
504
Ajalimiit ületatud

Veakataloog: ErrorResponse

Päised

401

WWW-AuthenticateStringValikuline

Serveri nõutav autentimisskeem.

405

AllowStringValikuline

Selle ressursi toetatud HTTP-meetodid.

429, 503

Retry-AfterTäisarvValikuline

Minimaalne viivitus enne korduskatset, sekundites.

minimum: 0