Vai al contenuto
ShopentlyLearn

Recupera · Ricerche — Analisi e regole di ricerca

Leggi i dati di «Analisi e regole di ricerca». Il risultato dipende dai parametri di questa operazione.

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

Autenticazione
Bearer
Disponibile dal piano
STANDARD
Permessi necessari
search.analytics:read

Esempi di codice

Esempio di richiesta

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

Esempio di risposta 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"
  }
}

Principi

  • GET /api/v1/search/overview e /api/v1/search/queries espongono statistiche riassuntive e query raggruppate.
  • Ottieni le occorrenze di una query tramite query_hash.
  • I periodi disponibili sono 7, 30 o 90 giorni, con i filtri indicati da ogni endpoint.
  • Le regole collegano frasi a prodotti e categorie selezionati e possono essere create, lette, modificate o eliminate.
  • Regole e analisi hanno permessi distinti; leggere le statistiche non concede accesso alla configurazione.

Parametri

Parametri del percorso

query_hashStringaObbligatorio

Identificativo stabile della frase di ricerca raggruppata.

Vincoli
pattern
"^[a-f0-9]{64}$"
Esempio: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Parametri di query

limitInteroFacoltativo

Numero massimo di record in questa pagina.

minimum: 1maximum: 100
Valore predefinito: 50Esempio: 20
cursorStringa nullFacoltativo

Valore opaco di continuazione restituito dalla pagina precedente.

Stringa:minLength: 1maxLength: 1024
daysInteroFacoltativo

Periodo di rendicontazione in giorni.

Vincoli
enum
[7, 30, 90]
Valore predefinito: 30
localeStringa nullFacoltativo

Lingua selezionata per questa richiesta.

Stringa:minLength: 2maxLength: 20
Vincoli · Stringa 1
pattern
"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
sourceStringa nullFacoltativo

Origine dell’attività registrata.

Vincoli · Stringa 1
enum
["results", "autocomplete"]
market_idStringa nullFacoltativo

Identificativo del mercato restituito dall’endpoint del contesto.

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

Questa operazione non accetta un corpo JSON.

Risposte

Risposta 200

dataArray <OccurrenceData > Obbligatorio

Contenuto di una risposta riuscita.

Campi · data

OccurrenceData

category_idStringa nullObbligatorio

Identificativo della categoria.

category_result_countInteroObbligatorio

Numero di risultati relativi alle categorie.

currency_codeStringaObbligatorio

Codice della valuta.

is_zero_resultsBooleanoObbligatorio

Indica se la ricerca non ha prodotto risultati.

locale_codeStringaObbligatorio

Codice della lingua.

market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

max_priceStringa nullObbligatorio

Prezzo massimo nell’intervallo riportato.

min_priceStringa nullObbligatorio

Prezzo minimo nell’intervallo riportato.

occurred_atStringaObbligatorio

Data e ora dell’evento.

format: "date-time"
pageInteroObbligatorio

Informazioni sulla pagina CMS.

product_result_countInteroObbligatorio

Numero di prodotti nei risultati di ricerca.

query_displayStringaObbligatorio

Frase di ricerca mostrata all’amministratore.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

resultsArray <ResultSnapshotData > nullObbligatorio

Risultati di ricerca registrati.

sort_keyStringaObbligatorio

Chiave di ordinamento.

sourceStringaObbligatorio

Origine dell’attività registrata.

Vincoli
enum
["results", "autocomplete"]
metaAnalyticsPageMeta AnalyticsMeta Obbligatorio

Metadati della risposta.

Campi · meta

AnalyticsPageMeta

paginationPagination Obbligatorio

Metadati della paginazione a cursore.

periodAnalyticsPeriodData Obbligatorio

Periodo di rendicontazione e relativi limiti temporali.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100

AnalyticsMeta

periodAnalyticsPeriodData Obbligatorio

Periodo di rendicontazione e relativi limiti temporali.

request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100
Esempio di risposta

Stato HTTP

200
Risposta riuscita Schema
400
Richiesta non valida
401
Autenticazione richiesta
403
Permesso negato
404
Risorsa non trovata
409
Conflitto di versione
422
Validazione non riuscita
429
Limite di richieste superato
Altri stati HTTP (7)
405
Metodo non consentito
413
Richiesta troppo grande
415
Formato non supportato
500
Errore del server
502
Errore del gateway API
503
Servizio non disponibile
504
Tempo di attesa scaduto

Catalogo degli errori: ErrorResponse

Header

401

WWW-AuthenticateStringaFacoltativo

Schema di autenticazione richiesto dal server.

405

AllowStringaFacoltativo

Metodi HTTP supportati da questa risorsa.

429, 503

Retry-AfterInteroFacoltativo

Attesa minima prima di riprovare, in secondi.

minimum: 0