Skip to content
ShopentlyLearn

List occurrences of a search query

List occurrences for a query_hash using Shopently API. Filter by time range, source and market, and paginate the returned occurrences with a cursor.

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

Authentication
Bearer
Available from
STANDARD
Required permissions
search.analytics:read

Code examples

Request example

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

Response example 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"
  }
}

How it works

  • GET /api/v1/search/overview and /api/v1/search/queries expose summary statistics and grouped queries.
  • Fetch a query's occurrences using its query_hash.
  • Reporting periods support 7, 30 or 90 days, with the filters listed by each endpoint.
  • Search rules connect phrases to selected products and categories and can be created, read, updated or deleted.
  • Rules and analytics have separate permissions; reading search statistics does not grant configuration access.

Parameters

Path parameters

query_hashStringRequired

Stable identifier of the grouped search phrase.

Constraints
pattern
"^[a-f0-9]{64}$"
Example: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Query parameters

limitIntegerOptional

Maximum number of records on this page.

minimum: 1maximum: 100
Default: 50Example: 20
cursorString nullOptional

Opaque continuation value returned by the previous page.

String:minLength: 1maxLength: 1024
daysIntegerOptional

Reporting period in days.

Constraints
enum
[7, 30, 90]
Default: 30
localeString nullOptional

Language selected for this request.

String:minLength: 2maxLength: 20
Constraints · String 1
pattern
"^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
sourceString nullOptional

Source of the recorded activity.

Constraints · String 1
enum
["results", "autocomplete"]
market_idString nullOptional

Market identifier returned by the context endpoint.

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

This operation does not accept a JSON body.

Responses

Response 200

dataArray <OccurrenceData > Required

Successful response payload.

Fields · data

OccurrenceData

category_idString nullRequired

Category identifier.

category_result_countIntegerRequired

Number of category results.

currency_codeStringRequired

Currency code.

is_zero_resultsBooleanRequired

Whether the search returned no results.

locale_codeStringRequired

Language code.

market_idStringRequired

Market identifier returned by the context endpoint.

max_priceString nullRequired

Maximum price in the reported range.

min_priceString nullRequired

Minimum price in the reported range.

occurred_atStringRequired

Event date and time.

format: "date-time"
pageIntegerRequired

CMS page information.

product_result_countIntegerRequired

Number of product search results.

query_displayStringRequired

Search phrase displayed to an administrator.

request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

resultsArray <ResultSnapshotData > nullRequired

Recorded search results.

sort_keyStringRequired

Ordering key.

sourceStringRequired

Source of the recorded activity.

Constraints
enum
["results", "autocomplete"]
metaAnalyticsPageMeta AnalyticsMeta Required

Response metadata.

Fields · meta

AnalyticsPageMeta

paginationPagination Required

Cursor pagination metadata.

periodAnalyticsPeriodData Required

Reporting period and its boundaries.

request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100

AnalyticsMeta

periodAnalyticsPeriodData Required

Reporting period and its boundaries.

request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100
Response example

HTTP status

200
Successful response Schema
400
Invalid request
401
Authentication required
403
Permission denied
404
Resource not found
409
Version conflict
422
Validation failed
429
Rate limit exceeded
Other HTTP statuses (7)
405
Method not allowed
413
Request too large
415
Unsupported media type
500
Server error
502
API gateway error
503
Service unavailable
504
Gateway timeout

Error catalog: ErrorResponse

Headers

401

WWW-AuthenticateStringOptional

Authentication scheme required by the server.

405

AllowStringOptional

HTTP methods supported by this resource.

429, 503

Retry-AfterIntegerOptional

Minimum delay before retrying, in seconds.

minimum: 0