Modele wyszukiwań i reguł

Schematy statystyk wyszukiwania, zapytań i reguł w Shopently API. Poznaj typy pól i struktury używane przez te operacje.

Schematy danych

Metadane odpowiedzi

AnalyticsMeta · Schemat · Modele wyszukiwań i reguł

periodAnalyticsPeriodData Wymagane: Okres raportowania i jego granice.

Przykład: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idTekstWymagane: Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

minLength: 1maxLength: 100

Przykład: "example"

Dodatkowe pola: Nie

Okres raportowania i jego granice

AnalyticsPeriodData · Schemat · Modele wyszukiwań i reguł

as_ofTekstWymagane: Chwila, do której odnoszą się raportowane dane.

format: "date-time"

Przykład: "2026-01-02T00:00:00Z"
daysLiczba całkowitaWymagane: Okres raportowania w dniach.

Przykład: 1
started_atTekstWymagane: Data i czas rozpoczęcia.

format: "date-time"

Przykład: "2026-01-01T00:00:00Z"

Dodatkowe pola: Nie

Pobierz zapytania wyszukiwarki — Odpowiedź

AnalyticsResponse_list_MetricData__ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataTablica <MetricData > Wymagane: Przykład odpowiedzi · AnalyticsResponse_list_MetricData__.

Przykład: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Wymagane: Metadane odpowiedzi.

Przykład: {"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"}

Dodatkowe pola: Nie

Pobierz wystąpienia zapytania — Odpowiedź

AnalyticsResponse_list_OccurrenceData__ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataTablica <OccurrenceData > Wymagane: Przykład odpowiedzi · AnalyticsResponse_list_OccurrenceData__.

Przykład: [{"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"}]
metaAnalyticsPageMeta AnalyticsMeta Wymagane: Metadane odpowiedzi.

Przykład: {"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"}

Dodatkowe pola: Nie

Pobierz statystyki wyszukiwania — Odpowiedź

AnalyticsResponse_OverviewData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataOverviewData Wymagane: Przykład odpowiedzi · OverviewData.

Przykład: {"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}
metaAnalyticsPageMeta AnalyticsMeta Wymagane: Metadane odpowiedzi.

Przykład: {"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

Dodatkowe pola: Nie

Pobierz listę reguł wyszukiwarki — Odpowiedź

ApiResponse_list_RuleSummaryData__ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataTablica <RuleSummaryData > Wymagane: Przykład odpowiedzi · ApiResponse_list_RuleSummaryData__.

Przykład: [{"created_at":"2026-01-01T12:00:00Z","enabled":true,"id":"example","is_available":true,"market_scope":"all","name":"Example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane: Metadane odpowiedzi.

Przykład: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Dodatkowe pola: Nie

Pobierz regułę wyszukiwarki — Odpowiedź

ApiResponse_RuleDetailData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataRuleDetailData Wymagane: Przykład odpowiedzi · RuleDetailData.

Przykład: {"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}
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane: Metadane odpowiedzi.

Przykład: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Dodatkowe pola: Nie

Pobierz zapytania wyszukiwarki — Odpowiedź

MetricData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

clicksLiczba całkowitaWymagane: Liczba kliknięć.

Przykład: 1
last_seen_atTekstWymagane: Data i czas ostatniego wystąpienia.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"
query_displayTekstWymagane: Fraza wyszukiwania wyświetlana administratorowi.

Przykład: "example"
query_hashTekstWymagane: Stały identyfikator zgrupowanej frazy wyszukiwania.

Przykład: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesLiczba całkowitaWymagane: Liczba wyszukiwań.

Przykład: 1
zero_resultsLiczba całkowitaWymagane: Liczba wyszukiwań bez wyników.

Przykład: 1

Dodatkowe pola: Nie

Pobierz wystąpienia zapytania — Odpowiedź

OccurrenceData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

category_idTekst nullWymagane

Identyfikator kategorii.

Przykład: "example"

category_result_countLiczba całkowitaWymagane

Liczba wyników dotyczących kategorii.

Przykład: 1

currency_codeTekstWymagane

Kod waluty.

Przykład: "PLN"

is_zero_resultsWartość logicznaWymagane

Czy wyszukiwanie nie zwróciło wyników.

Przykład: false

locale_codeTekstWymagane

Kod języka.

Przykład: "en"

market_idTekstWymagane

Identyfikator rynku zwrócony przez endpoint kontekstu.

Przykład: "example"

max_priceTekst nullWymagane

Maksymalna cena w raportowanym zakresie.

Przykład: "0.00"

min_priceTekst nullWymagane

Minimalna cena w raportowanym zakresie.

Przykład: "0.00"

occurred_atTekstWymagane

Data i czas zdarzenia.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

pageLiczba całkowitaWymagane

Informacje o stronie CMS.

Przykład: 1

product_result_countLiczba całkowitaWymagane

Liczba produktów w wynikach wyszukiwania.

Przykład: 1

query_displayTekstWymagane

Fraza wyszukiwania wyświetlana administratorowi.

Przykład: "example"

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

Przykład: "example"

resultsTablica <ResultSnapshotData > nullWymagane

Zapisane wyniki wyszukiwania.

Przykład:

[{"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_keyTekstWymagane

Klucz kolejności.

Przykład: "example"

sourceTekstWymagane

Źródło zarejestrowanej aktywności.

Ograniczenia

enum: ["results", "autocomplete"]

Przykład: "results"

Dodatkowe pola: Nie

Pobierz statystyki wyszukiwania — Odpowiedź

OverviewData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

click_through_rateLiczbaWymagane: Współczynnik kliknięć dla wybranych danych wyszukiwania.

Przykład: 0
clicked_searchesLiczba całkowitaWymagane: Liczba wyszukiwań zakończonych kliknięciem.

Przykład: 1
recentTablica <RecentSearchData > Wymagane: Informacje o ostatnich wyszukiwaniach.

Przykład: [{"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"}]
searchesLiczba całkowitaWymagane: Liczba wyszukiwań.

Przykład: 1
zero_result_rateLiczbaWymagane: Udział wyszukiwań bez wyników.

Przykład: 0
zero_resultsLiczba całkowitaWymagane: Liczba wyszukiwań bez wyników.

Przykład: 1

Dodatkowe pola: Nie

Wybrana kolejność sortowania wyników

QueryMetricSort · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

Tekst

Ograniczenia

enum: ["last_seen_desc", "last_seen_asc", "searches_desc", "searches_asc", "clicks_desc", "clicks_asc"]

Dodatkowe pola: Tak

Informacje o ostatnich wyszukiwaniach

RecentSearchData · Schemat · Modele wyszukiwań i reguł

is_zero_resultsWartość logicznaWymagane

Czy wyszukiwanie nie zwróciło wyników.

Przykład: false

locale_codeTekstWymagane

Kod języka.

Przykład: "en"

occurred_atTekstWymagane

Data i czas zdarzenia.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

query_displayTekstWymagane

Fraza wyszukiwania wyświetlana administratorowi.

Przykład: "example"

query_hashTekstWymagane

Stały identyfikator zgrupowanej frazy wyszukiwania.

Przykład: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idTekstWymagane

Identyfikator zgłoszenia; w metadanych odpowiedzi identyfikuje żądanie HTTP.

Przykład: "example"

result_countLiczba całkowitaWymagane

Liczba wyników wyszukiwania.

Przykład: 1

sourceTekstWymagane

Źródło zarejestrowanej aktywności.

Ograniczenia

enum: ["results", "autocomplete"]

Przykład: "results"

Dodatkowe pola: Nie

Zapisane wyniki wyszukiwania

ResultSnapshotData · Schemat · Modele wyszukiwań i reguł

clickedWartość logicznaWymagane

Czy wynik został kliknięty.

Przykład: false

entity_idTekstWymagane

Identyfikator wskazanego obiektu.

Przykład: "example"

entity_typeTekstWymagane

Typ wskazanego obiektu.

Ograniczenia

enum: ["product", "category"]

Przykład: "product"

image_urlTekst nullWymagane

Adres zdjęcia.

Przykład: "https://example.invalid/product.jpg"

numberTekst nullWymagane

Numer zamówienia lub zgłoszenia widoczny dla użytkownika.

Przykład: "example"

placement_sourceTekstWymagane

Źródło złożenia zamówienia.

Ograniczenia

enum: ["organic", "merchandising"]

Przykład: "organic"

positionLiczba całkowitaWymagane

Pozycja w uporządkowanej kolekcji.

Przykład: 1

skuTekstWymagane

Kod jednostki magazynowej SKU.

Przykład: "example"

slugTekstWymagane

Fragment ścieżki URL w wybranym języku.

Przykład: "example"

titleTekstWymagane

Tytuł w wybranym języku.

Przykład: "example"

Dodatkowe pola: Nie

Utwórz regułę wyszukiwarki — Treść żądania

RuleCreate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

category_idsTablica <Tekst> Opcjonalne

Identyfikatory powiązanych kategorii.

maxItems: 100

Tablica:minLength: 1maxLength: 63

enabledWartość logicznaOpcjonalne

Czy ustawienie jest włączone.

Wartość domyślna: false

market_idsTablica <Tekst> Opcjonalne

Identyfikatory wybranych rynków.

maxItems: 1000

Tablica:minLength: 1maxLength: 63

market_scopeTekstOpcjonalne

Czy zasób dotyczy wszystkich, czy wybranych rynków.

Ograniczenia

enum: ["all", "selected"]

nameTekstWymagane

Nazwa zasobu we właściwym kontekście.

minLength: 1maxLength: 160

Przykład: "Example"

phrasesTablica <Tekst> Wymagane

Frazy używane przez regułę wyszukiwania.

minItems: 1maxItems: 20

Tablica:minLength: 1maxLength: 255

Przykład: ["example"]

product_idsTablica <Tekst> Opcjonalne

Identyfikatory powiązanych produktów.

maxItems: 100

Tablica:minLength: 1maxLength: 63

Przykład: ["example"]

Dodatkowe pola: Nie

Pobierz regułę wyszukiwarki — Odpowiedź

RuleDetailData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

category_idsTablica <Tekst> Wymagane

Identyfikatory powiązanych kategorii.

Przykład: ["example"]

created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

enabledWartość logicznaWymagane

Czy ustawienie jest włączone.

Przykład: true

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. (RuleDetailData).

Przykład: "example"

is_availableWartość logicznaWymagane

Czy pozycja jest dostępna w tym kontekście.

Przykład: true

market_idsTablica <Tekst> Wymagane

Identyfikatory wybranych rynków.

Przykład: ["example"]

market_scopeTekstWymagane

Czy zasób dotyczy wszystkich, czy wybranych rynków.

Ograniczenia

enum: ["all", "selected"]

Przykład: "all"

nameTekstWymagane

Nazwa zasobu we właściwym kontekście.

Przykład: "Example"

phrase_groupsTablica <RulePhraseGroupData > Wymagane

Grupy fraz reguły wyszukiwania.

Przykład: [{"locale":"en","phrases":["example"]}]

product_idsTablica <Tekst> Wymagane

Identyfikatory powiązanych produktów.

Przykład: ["example"]

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

Grupy fraz reguły wyszukiwania

RulePhraseGroupData · Schemat · Modele wyszukiwań i reguł

localeTekstWymagane: Język wybrany dla tego żądania.

Przykład: "en"
phrasesTablica <Tekst> Wymagane: Frazy używane przez regułę wyszukiwania.

Przykład: ["example"]

Dodatkowe pola: Nie

Pobierz listę reguł wyszukiwarki — Odpowiedź

RuleSummaryData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

enabledWartość logicznaWymagane

Czy ustawienie jest włączone.

Przykład: true

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. (RuleSummaryData).

Przykład: "example"

is_availableWartość logicznaWymagane

Czy pozycja jest dostępna w tym kontekście.

Przykład: true

market_scopeTekstWymagane

Czy zasób dotyczy wszystkich, czy wybranych rynków.

Ograniczenia

enum: ["all", "selected"]

Przykład: "all"

nameTekstWymagane

Nazwa zasobu we właściwym kontekście.

Przykład: "Example"

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

Dodatkowe pola: Nie

Zmień regułę wyszukiwarki — Treść żądania

RuleUpdate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

category_idsTablica <Tekst> Opcjonalne

Identyfikatory powiązanych kategorii.

maxItems: 100

Tablica:minLength: 1maxLength: 63

enabledWartość logicznaOpcjonalne

Czy ustawienie jest włączone.

expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 2147483647

Przykład: 1

market_idsTablica <Tekst> Opcjonalne

Identyfikatory wybranych rynków.

maxItems: 1000

Tablica:minLength: 1maxLength: 63

market_scopeTekstOpcjonalne

Czy zasób dotyczy wszystkich, czy wybranych rynków.

Ograniczenia

enum: ["all", "selected"]

nameTekstOpcjonalne

Nazwa zasobu we właściwym kontekście.

minLength: 1maxLength: 160

Przykład: "Example"

phrasesTablica <Tekst> Opcjonalne

Frazy używane przez regułę wyszukiwania.

maxItems: 20

Tablica:minLength: 1maxLength: 255

product_idsTablica <Tekst> Opcjonalne

Identyfikatory powiązanych produktów.

maxItems: 100

Tablica:minLength: 1maxLength: 63

Dodatkowe pola: Nie

Filtr wybierający wyszukiwania z wystąpieniami bez wyników lub bez takich wystąpień

ZeroResultScope · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

Tekst

Ograniczenia

enum: ["all", "has_zero_results", "no_zero_results"]

Dodatkowe pola: Tak