Gå til indhold
ShopentlyLearn

Vis liste · Søgeforespørgsler — Søgeanalyse og regler

Læs data fra ”Søgeanalyse og regler”. Resultatet afhænger af handlingens parametre.

GET/api/v1/search/queries

Godkendelse
Bearer
Tilgængelig fra
STANDARD
Nødvendige rettigheder
search.analytics:read

Kodeeksempler

Eksempel på forespørgsel

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

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

Principper

  • GET /api/v1/search/overview og /api/v1/search/queries viser oversigtsstatistik og grupperede søgninger.
  • Hent forekomster af en søgning med dens query_hash.
  • Rapporteringsperioder understøtter 7, 30 eller 90 dage med de filtre, hvert endepunkt angiver.
  • Søgeregler forbinder fraser med udvalgte produkter og kategorier og kan oprettes, læses, opdateres eller slettes.
  • Regler og analyse har separate rettigheder; læsning af søgestatistik giver ikke adgang til konfiguration.

Parametre

Forespørgselsparametre

limitHeltalValgfrit

Maksimalt antal poster på denne side.

minimum: 1maximum: 100
Standard: 50Eksempel: 20
cursorStreng nullValgfrit

Uigennemsigtig fortsættelsesværdi returneret af den foregående side.

Streng:minLength: 1maxLength: 1024
daysHeltalValgfrit

Rapporteringsperiode i dage.

Begrænsninger
enum
[7, 30, 90]
Standard: 30
localeStreng nullValgfrit

Sprog valgt til denne forespørgsel.

Streng:minLength: 2maxLength: 20
Begrænsninger · Streng 1
pattern
"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
sourceStreng nullValgfrit

Kilden til den registrerede aktivitet.

Begrænsninger · Streng 1
enum
["results", "autocomplete"]
market_idStreng nullValgfrit

Markedsidentifikator returneret af kontekstendepunktet.

Begrænsninger · Streng 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
queryStrengValgfrit

Søgetekst eller filter for søgetekst.

maxLength: 255
Standard: ""
searches_minHeltal nullValgfrit

Filter for minimalt antal søgninger.

Heltal:minimum: 0maximum: 9223372036854775807
searches_maxHeltal nullValgfrit

Filter for maksimalt antal søgninger.

Heltal:minimum: 0maximum: 9223372036854775807
clicks_minHeltal nullValgfrit

Filter for minimalt antal klik.

Heltal:minimum: 0maximum: 9223372036854775807
clicks_maxHeltal nullValgfrit

Filter for maksimalt antal klik.

Heltal:minimum: 0maximum: 9223372036854775807
zero_results_minHeltal nullValgfrit

Filter for minimalt antal søgninger uden resultater.

Heltal:minimum: 0maximum: 9223372036854775807
zero_results_maxHeltal nullValgfrit

Filter for maksimalt antal søgninger uden resultater.

Heltal:minimum: 0maximum: 9223372036854775807
zero_result_scopeZeroResultScope Valgfrit

Filter, der vælger søgninger med eller uden forekomster uden resultater.

Standard: "all"
sortQueryMetricSort Valgfrit

Valgt sorteringsrækkefølge for resultaterne.

Standard: "last_seen_desc"

Denne operation accepterer ikke JSON-indhold.

Svar

Svar 200

dataArray <MetricData > Obligatorisk

Indholdet af et vellykket svar.

Felter · data

MetricData

clicksHeltalObligatorisk

Antal klik.

last_seen_atStrengObligatorisk

Tidspunkt for seneste forekomst.

format: "date-time"
query_displayStrengObligatorisk

Søgefrase vist til en administrator.

query_hashStrengObligatorisk

Stabil identifikator for den grupperede søgefrase.

searchesHeltalObligatorisk

Antal søgninger.

zero_resultsHeltalObligatorisk

Antal søgninger uden resultater.

metaAnalyticsPageMeta AnalyticsMeta Obligatorisk

Svarmetadata.

Felter · meta

AnalyticsPageMeta

paginationPagination Obligatorisk

Metadata for markørbaseret sideinddeling.

periodAnalyticsPeriodData Obligatorisk

Rapporteringsperiode og dens grænser.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100

AnalyticsMeta

periodAnalyticsPeriodData Obligatorisk

Rapporteringsperiode og dens grænser.

request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100
Eksempel på svar

HTTP-status

200
Vellykket svar Skema
400
Ugyldig anmodning
401
Godkendelse påkrævet
403
Adgang nægtet
404
Ressource ikke fundet
409
Versionskonflikt
422
Validering mislykkedes
429
Grænsen for anmodninger er overskredet
Andre HTTP-statusser (7)
405
Metoden er ikke tilladt
413
Anmodningen er for stor
415
Formatet understøttes ikke
500
Serverfejl
502
Fejl i API-gateway
503
Tjenesten er utilgængelig
504
Tidsgrænsen er overskredet

Fejlkatalog: ErrorResponse

Headere

401

WWW-AuthenticateStrengValgfrit

Godkendelsesmetode, som serveren kræver.

405

AllowStrengValgfrit

HTTP-metoder, som denne ressource understøtter.

429, 503

Retry-AfterHeltalValgfrit

Mindste ventetid før næste forsøg, i sekunder.

minimum: 0