Aqbeż għall-kontenut
ShopentlyLearn

Sommarju — Analiżi u regoli tat-tiftix

Aqra d-data minn “Analiżi u regoli tat-tiftix”. Ir-riżultat jiddependi fuq il-parametri ta’ din l-operazzjoni.

GET/api/v1/search/overview

Awtentikazzjoni
Bearer
Disponibbli minn
STANDARD
Permessi meħtieġa
search.analytics:read

Eżempji ta’ kodiċi

Eżempju ta’ talba

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/overview

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/overview');
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/overview', 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))

Eżempju ta’ tweġiba 200

JSON
{
  "data": {
    "click_through_rate": 0,
    "clicked_searches": 1,
    "recent": [
      {
        "is_zero_results": false,
        "locale_code": "en",
        "occurred_at": "2026-01-01T12:00:00Z",
        "query_display": "example",
        "query_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "request_id": "example",
        "result_count": 1,
        "source": "results"
      }
    ],
    "searches": 1,
    "zero_result_rate": 0,
    "zero_results": 1
  },
  "meta": {
    "period": {
      "as_of": "2026-01-02T00:00:00Z",
      "days": 1,
      "started_at": "2026-01-01T00:00:00Z"
    },
    "request_id": "example"
  }
}

Kif jaħdem

  • GET /api/v1/search/overview u GET /api/v1/search/queries juru statistika fil-qosor u queries raggruppati.
  • Ikseb l-okkorrenzi ta’ query permezz ta’ query_hash.
  • Il-perjodi ta’ rappurtar jappoġġaw 7, 30 jew 90 jum, bil-filtri elenkati f’kull endpoint.
  • Ir-regoli tat-tiftix jgħaqqdu frażijiet ma’ prodotti u kategoriji magħżula u jistgħu jinħolqu, jinqraw, jiġu aġġornati jew imħassra.
  • Ir-regoli u l-analiżi għandhom permessi separati; il-qari tal-istatistika ma jagħtix aċċess għall-konfigurazzjoni.

Parametri

Parametri tal-mistoqsija

daysNumru sħiħMhux obbligatorju

Perjodu ta’ rappurtar f’jiem.

Restrizzjonijiet
enum
[7, 30, 90]
Valur predefinit: 30

Din l-operazzjoni ma taċċettax kontenut JSON.

Tweġibiet

Risposta 200

dataOverviewData Obbligatorju

Data ta’ tweġiba ta’ suċċess.

Oqsma · data
click_through_rateNumruObbligatorju

Rata tal-klikks għad-data tat-tiftix magħżula.

clicked_searchesNumru sħiħObbligatorju

Numru ta’ tfittxijiet bi klikk.

recentArray <RecentSearchData > Obbligatorju

Informazzjoni dwar tiftix reċenti.

Oqsma · recent
searchesNumru sħiħObbligatorju

Numru ta’ tfittxijiet.

zero_result_rateNumruObbligatorju

Proporzjon ta’ tfittxijiet mingħajr riżultati.

zero_resultsNumru sħiħObbligatorju

Numru ta’ tfittxijiet mingħajr riżultati.

metaAnalyticsPageMeta AnalyticsMeta Obbligatorju

Metadata tat-tweġiba.

Oqsma · meta

AnalyticsPageMeta

paginationPagination Obbligatorju

Metadata tal-paġinazzjoni bil-cursor.

periodAnalyticsPeriodData Obbligatorju

Perjodu tar-rappurtar u l-konfini tiegħu.

request_idStringObbligatorju

Identifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.

minLength: 1maxLength: 100

AnalyticsMeta

periodAnalyticsPeriodData Obbligatorju

Perjodu tar-rappurtar u l-konfini tiegħu.

request_idStringObbligatorju

Identifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.

minLength: 1maxLength: 100
Eżempju ta’ tweġiba

Status HTTP

200
Risposta b’suċċess Skema
400
Talba mhux valida
401
Awtentikazzjoni meħtieġa
403
Permess miċħud
404
Riżorsa ma nstabitx
409
Kunflitt tal-verżjoni
422
Validazzjoni falliet
429
Inqabeż il-limitu tat-talbiet
Stati HTTP oħra (7)
405
Metodu mhux permess
413
Talba kbira wisq
415
Format mhux appoġġjat
500
Żball tas-server
502
Żball tal-gateway tal-API
503
Servizz mhux disponibbli
504
Skada l-ħin ta’ stennija

Katalgu tal-iżbalji: ErrorResponse

Headers

401

WWW-AuthenticateStringMhux obbligatorju

Skema ta’ awtentikazzjoni meħtieġa mis-server.

405

AllowStringMhux obbligatorju

Metodi HTTP appoġġati minn din ir-riżorsa.

429, 503

Retry-AfterNumru sħiħMhux obbligatorju

Dewmien minimu qabel tentattiv ieħor, f’sekondi.

minimum: 0