Preskoči na vsebino
ShopentlyLearn

Prikaži seznam · Iskalne poizvedbe — Analitika in pravila iskanja

Preberite podatke iz »Analitika in pravila iskanja«. Rezultat je odvisen od parametrov tega dejanja.

GET/api/v1/search/queries

Preverjanje pristnosti
Bearer
Na voljo od paketa
STANDARD
Zahtevana dovoljenja
search.analytics:read

Primeri kode

Primer zahteve

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

Primer odgovora 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"
  }
}

Kako deluje

  • GET /api/v1/search/overview in /api/v1/search/queries prikazujeta zbirne statistike in združene poizvedbe.
  • Pojavitve poizvedbe pridobite z njenim query_hash.
  • Obdobja poročanja podpirajo 7, 30 ali 90 dni in filtre, navedene pri posamezni končni točki.
  • Pravila iskanja povezujejo izraze z izbranimi izdelki in kategorijami ter jih je mogoče ustvarjati, brati, posodabljati in brisati.
  • Pravila in analitika imajo ločena dovoljenja; branje statistike ne daje dostopa do nastavitev.

Parametri

Parametri poizvedbe

limitCelo številoIzbirno

Največje število zapisov na tej strani.

minimum: 1maximum: 100
Privzeto: 50Primer: 20
cursorNiz nullIzbirno

Vrednost za nadaljevanje, vrnjena na prejšnji strani; njene notranje strukture ne razlagajte.

Niz:minLength: 1maxLength: 1024
daysCelo številoIzbirno

Obdobje poročanja v dnevih.

Omejitve
enum
[7, 30, 90]
Privzeto: 30
localeNiz nullIzbirno

Jezik, izbran za to zahtevo.

Niz:minLength: 2maxLength: 20
Omejitve · Niz 1
pattern
"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
sourceNiz nullIzbirno

Vir zabeležene dejavnosti.

Omejitve · Niz 1
enum
["results", "autocomplete"]
market_idNiz nullIzbirno

Identifikator trga, vrnjen s končno točko konteksta.

Omejitve · Niz 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
queryNizIzbirno

Besedilo iskanja ali filter iskalnega besedila.

maxLength: 255
Privzeto: ""
searches_minCelo število nullIzbirno

Filter najmanjšega števila iskanj.

Celo število:minimum: 0maximum: 9223372036854775807
searches_maxCelo število nullIzbirno

Filter največjega števila iskanj.

Celo število:minimum: 0maximum: 9223372036854775807
clicks_minCelo število nullIzbirno

Filter najmanjšega števila klikov.

Celo število:minimum: 0maximum: 9223372036854775807
clicks_maxCelo število nullIzbirno

Filter največjega števila klikov.

Celo število:minimum: 0maximum: 9223372036854775807
zero_results_minCelo število nullIzbirno

Filter najmanjšega števila iskanj brez rezultatov.

Celo število:minimum: 0maximum: 9223372036854775807
zero_results_maxCelo število nullIzbirno

Filter največjega števila iskanj brez rezultatov.

Celo število:minimum: 0maximum: 9223372036854775807
zero_result_scopeZeroResultScope Izbirno

Filter za izbiro iskanj s pojavitvami brez rezultatov ali brez takih pojavitev.

Privzeto: "all"
sortQueryMetricSort Izbirno

Izbrano razvrščanje rezultatov.

Privzeto: "last_seen_desc"

Ta operacija ne sprejema telesa JSON.

Odgovori

Odgovor 200

dataPolje elementov <MetricData > Obvezno

Vsebina uspešnega odgovora.

Polja · data

MetricData

clicksCelo številoObvezno

Število klikov.

last_seen_atNizObvezno

Čas zadnje pojavitve.

format: "date-time"
query_displayNizObvezno

Iskalni izraz, prikazan skrbniku.

query_hashNizObvezno

Stabilni identifikator združenega iskalnega izraza.

searchesCelo številoObvezno

Število iskanj.

zero_resultsCelo številoObvezno

Število iskanj brez rezultatov.

metaAnalyticsPageMeta AnalyticsMeta Obvezno

Metapodatki odgovora.

Polja · meta

AnalyticsPageMeta

paginationPagination Obvezno

Metapodatki straničenja s kazalcem.

periodAnalyticsPeriodData Obvezno

Obdobje poročanja in njegove meje.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100

AnalyticsMeta

periodAnalyticsPeriodData Obvezno

Obdobje poročanja in njegove meje.

request_idNizObvezno

Identifikator zahtevka; v metapodatkih odgovora označuje zahtevo HTTP.

minLength: 1maxLength: 100
Primer odgovora

Status HTTP

200
Uspešen odgovor Shema
400
Neveljavna zahteva
401
Potrebna je avtentikacija
403
Dostop zavrnjen
404
Vir ni najden
409
Spor različic
422
Preverjanje ni uspelo
429
Presežena omejitev zahtev
Druga stanja HTTP (7)
405
Metoda ni dovoljena
413
Zahteva je prevelika
415
Nepodprta oblika
500
Napaka strežnika
502
Napaka prehoda API
503
Storitev ni na voljo
504
Časovna omejitev je potekla

Katalog napak: ErrorResponse

Glave

401

WWW-AuthenticateNizIzbirno

Shema preverjanja pristnosti, ki jo zahteva strežnik.

405

AllowNizIzbirno

Metode HTTP, ki jih podpira ta vir.

429, 503

Retry-AfterCelo številoIzbirno

Najkrajši zamik pred ponovitvijo v sekundah.

minimum: 0