Hoppa till innehållet
ShopentlyLearn

Hämta · Sökfrågor — Sökanalys och sökregler

Läs data från ”Sökanalys och sökregler”. Resultatet beror på åtgärdens parametrar.

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

Autentisering
Bearer
Tillgänglig från
STANDARD
Behörigheter som krävs
search.analytics:read

Kodexempel

Exempel på begäran

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

Exempel på svar 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"
  }
}

Så fungerar det

  • GET /api/v1/search/overview och /api/v1/search/queries visar sammanfattande statistik och grupperade sökningar.
  • Hämta en sökfras förekomster med dess query_hash.
  • Rapporteringsperioderna stöder 7, 30 eller 90 dagar och de filter som respektive endpoint anger.
  • Sökregler kopplar fraser till valda produkter och kategorier och kan skapas, läsas, uppdateras och tas bort.
  • Regler och analys har separata behörigheter.
  • Att läsa sökstatistik ger inte tillgång till konfigurationen.

Parametrar

Sökvägsparametrar

query_hashSträngObligatoriskt

Stabil identifierare för den grupperade sökfrasen.

Begränsningar
pattern
"^[a-f0-9]{64}$"
Exempel: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Frågeparametrar

limitHeltalValfritt

Högsta antal poster på denna sida.

minimum: 1maximum: 100
Standardvärde: 50Exempel: 20
cursorSträng nullValfritt

Ogenomskinligt fortsättningsvärde från föregående sida.

Sträng:minLength: 1maxLength: 1024
daysHeltalValfritt

Rapporteringsperiod i dagar.

Begränsningar
enum
[7, 30, 90]
Standardvärde: 30
localeSträng nullValfritt

Språk valt för denna begäran.

Sträng:minLength: 2maxLength: 20
Begränsningar · Sträng 1
pattern
"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
sourceSträng nullValfritt

Källa för registrerad aktivitet.

Begränsningar · Sträng 1
enum
["results", "autocomplete"]
market_idSträng nullValfritt

Marknadsidentifierare returnerad av kontextendpointen.

Begränsningar · Sträng 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"

Den här operationen tar inte emot JSON-innehåll.

Svar

Svar 200

dataArray <OccurrenceData > Obligatoriskt

Innehållet i ett lyckat svar.

Fält · data

OccurrenceData

category_idSträng nullObligatoriskt

Kategorins identifierare.

category_result_countHeltalObligatoriskt

Antal kategoriträffar.

currency_codeSträngObligatoriskt

Valutakod.

is_zero_resultsBooleskt värdeObligatoriskt

Anger om sökningen saknade resultat.

locale_codeSträngObligatoriskt

Språkkod.

market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

max_priceSträng nullObligatoriskt

Högsta pris i det rapporterade intervallet.

min_priceSträng nullObligatoriskt

Lägsta pris i det rapporterade intervallet.

occurred_atSträngObligatoriskt

Händelsens datum och tid.

format: "date-time"
pageHeltalObligatoriskt

Information om CMS-sidan.

product_result_countHeltalObligatoriskt

Antal produktträffar i sökningen.

query_displaySträngObligatoriskt

Sökfras som visas för administratören.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

resultsArray <ResultSnapshotData > nullObligatoriskt

Registrerade sökresultat.

sort_keySträngObligatoriskt

Sorteringsnyckel.

sourceSträngObligatoriskt

Källa för registrerad aktivitet.

Begränsningar
enum
["results", "autocomplete"]
metaAnalyticsPageMeta AnalyticsMeta Obligatoriskt

Metadata för svaret.

Fält · meta

AnalyticsPageMeta

paginationPagination Obligatoriskt

Metadata för markörbaserad paginering.

periodAnalyticsPeriodData Obligatoriskt

Rapporteringsperiod och dess gränser.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100

AnalyticsMeta

periodAnalyticsPeriodData Obligatoriskt

Rapporteringsperiod och dess gränser.

request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100
Exempel på svar

HTTP-status

200
Lyckat svar Schema
400
Ogiltig begäran
401
Autentisering krävs
403
Åtkomst nekad
404
Resursen hittades inte
409
Versionskonflikt
422
Valideringen misslyckades
429
Anropsgränsen överskreds
Övriga HTTP-statusar (7)
405
Metoden tillåts inte
413
För stor begäran
415
Formatet stöds inte
500
Serverfel
502
Fel i API-gateway
503
Tjänsten är inte tillgänglig
504
Tidsgränsen överskreds

Felkatalog: ErrorResponse

HTTP-huvuden

401

WWW-AuthenticateSträngValfritt

Autentiseringsschema som servern kräver.

405

AllowSträngValfritt

HTTP-metoder som resursen stöder.

429, 503

Retry-AfterHeltalValfritt

Minsta väntetid före ett nytt försök, i sekunder.

minimum: 0