Siirry sisältöön
ShopentlyLearn

Listaa · Hakukyselyt — Hakuanalytiikka ja säännöt

Lue tietoja resurssista ”Hakuanalytiikka ja säännöt”. Tulos riippuu toiminnon parametreista.

GET/api/v1/search/queries

Todentaminen
Bearer
Saatavilla alkaen
STANDARD
Vaaditut käyttöoikeudet
search.analytics:read

Koodiesimerkit

Pyyntöesimerkki

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

Vastausesimerkki 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"
  }
}

Periaatteet

  • GET /api/v1/search/overview ja /api/v1/search/queries tarjoavat yhteenvetotilastot ja ryhmitellyt haut.
  • Hae yksittäisen haun esiintymät sen query_hash-arvolla.
  • Raportointijaksot tukevat 7, 30 tai 90 päivää kunkin päätepisteen luettelemilla suodattimilla.
  • Hakusäännöt yhdistävät ilmauksia valittuihin tuotteisiin ja kategorioihin, ja niitä voi luoda, lukea, päivittää tai poistaa.
  • Säännöillä ja analytiikalla on erilliset käyttöoikeudet.
  • Hakutilastojen lukeminen ei anna määritysoikeutta.

Parametrit

Kyselyparametrit

limitKokonaislukuValinnainen

Tämän sivun tietueiden enimmäismäärä.

minimum: 1maximum: 100
Oletus: 50Esimerkki: 20
cursorMerkkijono nullValinnainen

Edellisen sivun palauttama läpinäkymätön jatkoarvo.

Merkkijono:minLength: 1maxLength: 1024
daysKokonaislukuValinnainen

Raportointijakso päivinä.

Rajoitukset
enum
[7, 30, 90]
Oletus: 30
localeMerkkijono nullValinnainen

Tälle pyynnölle valittu kieli.

Merkkijono:minLength: 2maxLength: 20
Rajoitukset · Merkkijono 1
pattern
"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
sourceMerkkijono nullValinnainen

Kirjatun toiminnan lähde.

Rajoitukset · Merkkijono 1
enum
["results", "autocomplete"]
market_idMerkkijono nullValinnainen

Kontekstipäätepisteen palauttama markkinatunniste.

Rajoitukset · Merkkijono 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
queryMerkkijonoValinnainen

Hakuteksti tai hakutekstin suodatin.

maxLength: 255
Oletus: ""
searches_minKokonaisluku nullValinnainen

Hakujen vähimmäismäärän suodatin.

Kokonaisluku:minimum: 0maximum: 9223372036854775807
searches_maxKokonaisluku nullValinnainen

Hakujen enimmäismäärän suodatin.

Kokonaisluku:minimum: 0maximum: 9223372036854775807
clicks_minKokonaisluku nullValinnainen

Klikkausten vähimmäismäärän suodatin.

Kokonaisluku:minimum: 0maximum: 9223372036854775807
clicks_maxKokonaisluku nullValinnainen

Klikkausten enimmäismäärän suodatin.

Kokonaisluku:minimum: 0maximum: 9223372036854775807
zero_results_minKokonaisluku nullValinnainen

Ilman tuloksia jääneiden hakujen vähimmäismäärän suodatin.

Kokonaisluku:minimum: 0maximum: 9223372036854775807
zero_results_maxKokonaisluku nullValinnainen

Ilman tuloksia jääneiden hakujen enimmäismäärän suodatin.

Kokonaisluku:minimum: 0maximum: 9223372036854775807
zero_result_scopeZeroResultScope Valinnainen

Suodatin, joka valitsee hakuja sen mukaan, onko niillä tuloksettomia esiintymiä.

Oletus: "all"
sortQueryMetricSort Valinnainen

Tuloksille valittu lajittelujärjestys.

Oletus: "last_seen_desc"

Tämä toiminto ei hyväksy JSON-sisältöä.

Vastaukset

Vastaus 200

dataTaulukko <MetricData > Pakollinen

Onnistuneen vastauksen sisältö.

Kentät · data

MetricData

clicksKokonaislukuPakollinen

Klikkausten määrä.

last_seen_atMerkkijonoPakollinen

Viimeisimmän esiintymän ajankohta.

format: "date-time"
query_displayMerkkijonoPakollinen

Ylläpitäjälle näytetty hakuilmaus.

query_hashMerkkijonoPakollinen

Ryhmitellyn hakuilmauksen vakaa tunniste.

searchesKokonaislukuPakollinen

Hakujen määrä.

zero_resultsKokonaislukuPakollinen

Ilman tuloksia jääneiden hakujen määrä.

metaAnalyticsPageMeta AnalyticsMeta Pakollinen

Vastauksen metatiedot.

Kentät · meta

AnalyticsPageMeta

paginationPagination Pakollinen

Kohdistinpohjaisen sivutuksen metatiedot.

periodAnalyticsPeriodData Pakollinen

Raportointijakso ja sen rajat.

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100

AnalyticsMeta

periodAnalyticsPeriodData Pakollinen

Raportointijakso ja sen rajat.

request_idMerkkijonoPakollinen

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100
Vastausesimerkki

HTTP-tilakoodi

200
Onnistunut vastaus Skeema
400
Virheellinen pyyntö
401
Tunnistautuminen vaaditaan
403
Pääsy estetty
404
Resurssia ei löydy
409
Versioristiriita
422
Validointi epäonnistui
429
Pyyntöraja ylitetty
Muut HTTP-tilat (7)
405
Menetelmä ei ole sallittu
413
Pyyntö on liian suuri
415
Muotoa ei tueta
500
Palvelinvirhe
502
API-yhdyskäytävän virhe
503
Palvelu ei ole käytettävissä
504
Aikakatkaisu

Virheluettelo: ErrorResponse

Otsakkeet

401

WWW-AuthenticateMerkkijonoValinnainen

Palvelimen vaatima todentamismenetelmä.

405

AllowMerkkijonoValinnainen

Tämän resurssin tukemat HTTP-metodit.

429, 503

Retry-AfterKokonaislukuValinnainen

Vähimmäisviive ennen uudelleenyritystä sekunteina.

minimum: 0