Saltar para o conteúdo
ShopentlyLearn

Obter · Regras — Análise e regras de pesquisa

Consulte os dados de «Análise e regras de pesquisa». O resultado depende dos parâmetros desta operação.

GET/api/v1/search/rules/{rule_id}

Autenticação
Bearer
Disponível a partir de
STANDARD
Permissões necessárias
search.rule:read

Exemplos de código

Exemplo de requisição

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/rules/example

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

Exemplo de resposta 200

JSON
{
  "data": {
    "category_ids": [
      "example"
    ],
    "created_at": "2026-01-01T12:00:00Z",
    "enabled": true,
    "id": "example",
    "is_available": true,
    "market_ids": [
      "example"
    ],
    "market_scope": "all",
    "name": "Example",
    "phrase_groups": [
      {
        "locale": "en",
        "phrases": [
          "example"
        ]
      }
    ],
    "product_ids": [
      "example"
    ],
    "updated_at": "2026-01-01T12:00:00Z",
    "version": 1
  },
  "meta": {
    "locale": "en",
    "market_code": "PL",
    "market_id": "example",
    "request_id": "example"
  }
}

Como funciona

  • GET /api/v1/search/overview e /api/v1/search/queries apresentam estatísticas resumidas e consultas agrupadas.
  • Obtenha as ocorrências de uma consulta usando seu query_hash.
  • Os períodos dos relatórios aceitam 7, 30 ou 90 dias, com os filtros apresentados por cada endpoint.
  • As regras de pesquisa relacionam frases com produtos e categorias selecionados e podem ser criadas, lidas, atualizadas ou eliminadas.
  • Regras e análises possuem permissões separadas; ler estatísticas de pesquisa não concede acesso à configuração.

Parâmetros

Parâmetros do caminho

rule_idTextoObrigatório

Identificador da regra de pesquisa.

Restrições
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Exemplo: "example"

Parâmetros de consulta

localeTexto nullOpcional

Idioma selecionado para esta requisição.

Texto:minLength: 2maxLength: 20
market_idTexto nullOpcional

Identificador do mercado retornado pelo endpoint de contexto.

Restrições · Texto 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
market_codeTexto nullOpcional

Código do mercado retornado pelo endpoint de contexto.

Texto:minLength: 1maxLength: 16

Esta operação não aceita um corpo JSON.

Respostas

Resposta 200

dataRuleDetailData Obrigatório

Conteúdo de uma resposta bem-sucedida.

Campos · data
category_idsLista <Texto> Obrigatório

Identificadores das categorias relacionadas.

created_atTextoObrigatório

Momento da criação.

format: "date-time"
enabledBooleanoObrigatório

Indica se esta configuração está ativada.

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado.

is_availableBooleanoObrigatório

Indica se o item está disponível neste contexto.

market_idsLista <Texto> Obrigatório

Identificadores dos mercados selecionados.

market_scopeTextoObrigatório

Indica se o recurso se aplica a todos os mercados ou apenas aos selecionados.

Restrições
enum
["all", "selected"]
nameTextoObrigatório

Nome do recurso no contexto correspondente.

phrase_groupsLista <RulePhraseGroupData > Obrigatório

Grupos de frases das regras de pesquisa.

Campos · phrase_groups
product_idsLista <Texto> Obrigatório

Identificadores dos produtos relacionados.

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"
versionNúmero inteiroObrigatório

Versão do recurso utilizada para controlo de concorrência.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório

Metadados da resposta.

Campos · meta

ContextPageMeta

localeTextoObrigatório

Idioma selecionado para esta requisição.

market_codeTextoObrigatório

Código do mercado retornado pelo endpoint de contexto.

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

paginationPagination Obrigatório

Metadados da paginação por cursor.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

ContextMeta

localeTextoObrigatório

Idioma selecionado para esta requisição.

market_codeTextoObrigatório

Código do mercado retornado pelo endpoint de contexto.

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

PageMeta

paginationPagination Obrigatório

Metadados da paginação por cursor.

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

RequestMeta

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100
Exemplo de resposta

Estado HTTP

200
Resposta bem-sucedida Esquema
400
Pedido inválido
401
Autenticação necessária
403
Permissão negada
404
Recurso não encontrado
409
Conflito de versão
422
Falha na validação
429
Limite de pedidos excedido
Outros estados HTTP (7)
405
Método não permitido
413
Pedido demasiado grande
415
Formato não suportado
500
Erro do servidor
502
Erro do gateway da API
503
Serviço indisponível
504
Tempo de espera excedido

Catálogo de erros: ErrorResponse

Cabeçalhos

401

WWW-AuthenticateTextoOpcional

Esquema de autenticação exigido pelo servidor.

405

AllowTextoOpcional

Métodos HTTP aceitos por este recurso.

429, 503

Retry-AfterNúmero inteiroOpcional

Espera mínima antes de tentar novamente, em segundos.

minimum: 0