Veri şemaları: Arama analitiği ve kuralları

Veri şemaları: Arama analitiği ve kuralları. API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

Veri şemaları

Yanıt üst verileri

AnalyticsMeta · Şema · Veri şemaları: Arama analitiği ve kuralları

periodAnalyticsPeriodData Zorunlu: Raporlama dönemi ve sınırları.

Örnek: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idDizeZorunlu: Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100

Örnek: "example"

Ek alanlar: Hayır

Raporlama dönemi ve sınırları

AnalyticsPeriodData · Şema · Veri şemaları: Arama analitiği ve kuralları

as_ofDizeZorunlu: Bildirilen verilerin geçerli olduğu zaman.

format: "date-time"

Örnek: "2026-01-02T00:00:00Z"
daysTam sayıZorunlu: Gün cinsinden raporlama dönemi.

Örnek: 1
started_atDizeZorunlu: Başlangıç tarihi ve saati.

format: "date-time"

Örnek: "2026-01-01T00:00:00Z"

Ek alanlar: Hayır

Listele · Arama sorguları — Arama analitiği ve kuralları — Yanıt

AnalyticsResponse_list_MetricData__ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

dataDizi <MetricData > Zorunlu: Yanıt örneği · AnalyticsResponse_list_MetricData__.

Örnek: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Zorunlu: Yanıt üst verileri.

Örnek: {"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"}

Ek alanlar: Hayır

Getir · Arama sorguları — Arama analitiği ve kuralları — Yanıt

AnalyticsResponse_list_OccurrenceData__ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

dataDizi <OccurrenceData > Zorunlu: Yanıt örneği · AnalyticsResponse_list_OccurrenceData__.

Örnek: [{"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 Zorunlu: Yanıt üst verileri.

Örnek: {"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"}

Ek alanlar: Hayır

Özet — Arama analitiği ve kuralları — Yanıt

AnalyticsResponse_OverviewData_ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

dataOverviewData Zorunlu: Yanıt örneği · OverviewData.

Örnek: {"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 Zorunlu: Yanıt üst verileri.

Örnek: {"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

Ek alanlar: Hayır

Listele · Kurallar — Arama analitiği ve kuralları — Yanıt

ApiResponse_list_RuleSummaryData__ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

dataDizi <RuleSummaryData > Zorunlu: Yanıt örneği · ApiResponse_list_RuleSummaryData__.

Örnek: [{"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 Zorunlu: Yanıt üst verileri.

Örnek: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Ek alanlar: Hayır

Getir · Kurallar — Arama analitiği ve kuralları — Yanıt

ApiResponse_RuleDetailData_ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

dataRuleDetailData Zorunlu: Yanıt örneği · RuleDetailData.

Örnek: {"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 Zorunlu: Yanıt üst verileri.

Örnek: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Ek alanlar: Hayır

Listele · Arama sorguları — Arama analitiği ve kuralları — Yanıt

MetricData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

clicksTam sayıZorunlu: Tıklama sayısı.

Örnek: 1
last_seen_atDizeZorunlu: Son görülme zamanı.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"
query_displayDizeZorunlu: Yöneticiye gösterilen arama ifadesi.

Örnek: "example"
query_hashDizeZorunlu: Gruplanmış arama ifadesinin sabit tanımlayıcısı.

Örnek: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesTam sayıZorunlu: Arama sayısı.

Örnek: 1
zero_resultsTam sayıZorunlu: Sonuçsuz aramaların sayısı.

Örnek: 1

Ek alanlar: Hayır

Getir · Arama sorguları — Arama analitiği ve kuralları — Yanıt

OccurrenceData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

category_idDize nullZorunlu

Kategori tanımlayıcısı.

Örnek: "example"

category_result_countTam sayıZorunlu

Kategori sonuçlarının sayısı.

Örnek: 1

currency_codeDizeZorunlu

Para birimi kodu.

Örnek: "PLN"

is_zero_resultsMantıksal değerZorunlu

Aramanın sonuçsuz kalıp kalmadığı.

Örnek: false

locale_codeDizeZorunlu

Dil kodu.

Örnek: "en"

market_idDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.

Örnek: "example"

max_priceDize nullZorunlu

Bildirilen aralıktaki en yüksek fiyat.

Örnek: "0.00"

min_priceDize nullZorunlu

Bildirilen aralıktaki en düşük fiyat.

Örnek: "0.00"

occurred_atDizeZorunlu

Olay tarihi ve saati.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"

pageTam sayıZorunlu

CMS sayfası bilgileri.

Örnek: 1

product_result_countTam sayıZorunlu

Ürün arama sonuçlarının sayısı.

Örnek: 1

query_displayDizeZorunlu

Yöneticiye gösterilen arama ifadesi.

Örnek: "example"

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

Örnek: "example"

resultsDizi <ResultSnapshotData > nullZorunlu

Kaydedilen arama sonuçları.

Örnek:

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

Sıralama anahtarı.

Örnek: "example"

sourceDizeZorunlu

Kaydedilen etkinliğin kaynağı.

Kısıtlamalar

enum: ["results", "autocomplete"]

Örnek: "results"

Ek alanlar: Hayır

Özet — Arama analitiği ve kuralları — Yanıt

OverviewData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

click_through_rateSayıZorunlu: Seçilen arama verilerinin tıklama oranı.

Örnek: 0
clicked_searchesTam sayıZorunlu: Tıklama içeren aramaların sayısı.

Örnek: 1
recentDizi <RecentSearchData > Zorunlu: Son aramalara ilişkin bilgiler.

Örnek: [{"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"}]
searchesTam sayıZorunlu: Arama sayısı.

Örnek: 1
zero_result_rateSayıZorunlu: Sonuç döndürmeyen aramaların oranı.

Örnek: 0
zero_resultsTam sayıZorunlu: Sonuçsuz aramaların sayısı.

Örnek: 1

Ek alanlar: Hayır

Sonuçlar için seçilen sıralama

QueryMetricSort · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

Dize

Kısıtlamalar

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

Ek alanlar: Evet

Son aramalara ilişkin bilgiler

RecentSearchData · Şema · Veri şemaları: Arama analitiği ve kuralları

is_zero_resultsMantıksal değerZorunlu

Aramanın sonuçsuz kalıp kalmadığı.

Örnek: false

locale_codeDizeZorunlu

Dil kodu.

Örnek: "en"

occurred_atDizeZorunlu

Olay tarihi ve saati.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"

query_displayDizeZorunlu

Yöneticiye gösterilen arama ifadesi.

Örnek: "example"

query_hashDizeZorunlu

Gruplanmış arama ifadesinin sabit tanımlayıcısı.

Örnek: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

Örnek: "example"

result_countTam sayıZorunlu

Arama sonucu sayısı.

Örnek: 1

sourceDizeZorunlu

Kaydedilen etkinliğin kaynağı.

Kısıtlamalar

enum: ["results", "autocomplete"]

Örnek: "results"

Ek alanlar: Hayır

Kaydedilen arama sonuçları

ResultSnapshotData · Şema · Veri şemaları: Arama analitiği ve kuralları

clickedMantıksal değerZorunlu

Sonucun tıklanıp tıklanmadığı.

Örnek: false

entity_idDizeZorunlu

Başvurulan varlığın tanımlayıcısı.

Örnek: "example"

entity_typeDizeZorunlu

Başvurulan varlığın türü.

Kısıtlamalar

enum: ["product", "category"]

Örnek: "product"

image_urlDize nullZorunlu

Görsel URL'si.

Örnek: "https://example.invalid/product.jpg"

numberDize nullZorunlu

Kullanıcıya gösterilen sipariş veya talep numarası.

Örnek: "example"

placement_sourceDizeZorunlu

Siparişin verildiği kaynak.

Kısıtlamalar

enum: ["organic", "merchandising"]

Örnek: "organic"

positionTam sayıZorunlu

Sıralı koleksiyondaki konum.

Örnek: 1

skuDizeZorunlu

Stok tutma birimi kodu.

Örnek: "example"

slugDizeZorunlu

Seçilen dilde URL yolu parçası.

Örnek: "example"

titleDizeZorunlu

Seçilen dilde başlık.

Örnek: "example"

Ek alanlar: Hayır

Oluştur · Kurallar — Arama analitiği ve kuralları — İstek gövdesi

RuleCreate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

category_idsDizi <Dize> İsteğe bağlı

İlgili kategorilerin tanımlayıcıları.

maxItems: 100

Dizi:minLength: 1maxLength: 63

enabledMantıksal değerİsteğe bağlı

Bu ayarın etkin olup olmadığı.

Varsayılan: false

market_idsDizi <Dize> İsteğe bağlı

Seçilen pazarların tanımlayıcıları.

maxItems: 1000

Dizi:minLength: 1maxLength: 63

market_scopeDizeİsteğe bağlı

Kaynağın tüm pazarlara mı, seçilen pazarlara mı uygulandığı.

Kısıtlamalar

enum: ["all", "selected"]

nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

minLength: 1maxLength: 160

Örnek: "Example"

phrasesDizi <Dize> Zorunlu

Arama kuralında kullanılan ifadeler.

minItems: 1maxItems: 20

Dizi:minLength: 1maxLength: 255

Örnek: ["example"]

product_idsDizi <Dize> İsteğe bağlı

İlgili ürünlerin tanımlayıcıları.

maxItems: 100

Dizi:minLength: 1maxLength: 63

Örnek: ["example"]

Ek alanlar: Hayır

Getir · Kurallar — Arama analitiği ve kuralları — Yanıt

RuleDetailData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

category_idsDizi <Dize> Zorunlu

İlgili kategorilerin tanımlayıcıları.

Örnek: ["example"]

created_atDizeZorunlu

Oluşturulma zamanı.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"

enabledMantıksal değerZorunlu

Bu ayarın etkin olup olmadığı.

Örnek: true

idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (RuleDetailData).

Örnek: "example"

is_availableMantıksal değerZorunlu

Öğenin bu bağlamda kullanılabilir olup olmadığı.

Örnek: true

market_idsDizi <Dize> Zorunlu

Seçilen pazarların tanımlayıcıları.

Örnek: ["example"]

market_scopeDizeZorunlu

Kaynağın tüm pazarlara mı, seçilen pazarlara mı uygulandığı.

Kısıtlamalar

enum: ["all", "selected"]

Örnek: "all"

nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Example"

phrase_groupsDizi <RulePhraseGroupData > Zorunlu

Arama kuralının ifade grupları.

Örnek: [{"locale":"en","phrases":["example"]}]

product_idsDizi <Dize> Zorunlu

İlgili ürünlerin tanımlayıcıları.

Örnek: ["example"]

updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"

versionTam sayıZorunlu

Eşzamanlılık denetiminde kullanılan kaynak sürümü.

Örnek: 1

Ek alanlar: Hayır

Arama kuralının ifade grupları

RulePhraseGroupData · Şema · Veri şemaları: Arama analitiği ve kuralları

localeDizeZorunlu: Bu istek için seçilen dil.

Örnek: "en"
phrasesDizi <Dize> Zorunlu: Arama kuralında kullanılan ifadeler.

Örnek: ["example"]

Ek alanlar: Hayır

Listele · Kurallar — Arama analitiği ve kuralları — Yanıt

RuleSummaryData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

created_atDizeZorunlu

Oluşturulma zamanı.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"

enabledMantıksal değerZorunlu

Bu ayarın etkin olup olmadığı.

Örnek: true

idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (RuleSummaryData).

Örnek: "example"

is_availableMantıksal değerZorunlu

Öğenin bu bağlamda kullanılabilir olup olmadığı.

Örnek: true

market_scopeDizeZorunlu

Kaynağın tüm pazarlara mı, seçilen pazarlara mı uygulandığı.

Kısıtlamalar

enum: ["all", "selected"]

Örnek: "all"

nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Example"

updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"

Örnek: "2026-01-01T12:00:00Z"

versionTam sayıZorunlu

Eşzamanlılık denetiminde kullanılan kaynak sürümü.

Örnek: 1

Ek alanlar: Hayır

Güncelle · Kurallar — Arama analitiği ve kuralları — İstek gövdesi

RuleUpdate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

category_idsDizi <Dize> İsteğe bağlı

İlgili kategorilerin tanımlayıcıları.

maxItems: 100

Dizi:minLength: 1maxLength: 63

enabledMantıksal değerİsteğe bağlı

Bu ayarın etkin olup olmadığı.

expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 2147483647

Örnek: 1

market_idsDizi <Dize> İsteğe bağlı

Seçilen pazarların tanımlayıcıları.

maxItems: 1000

Dizi:minLength: 1maxLength: 63

market_scopeDizeİsteğe bağlı

Kaynağın tüm pazarlara mı, seçilen pazarlara mı uygulandığı.

Kısıtlamalar

enum: ["all", "selected"]

nameDizeİsteğe bağlı

İlgili bağlamdaki kaynak adı.

minLength: 1maxLength: 160

Örnek: "Example"

phrasesDizi <Dize> İsteğe bağlı

Arama kuralında kullanılan ifadeler.

maxItems: 20

Dizi:minLength: 1maxLength: 255

product_idsDizi <Dize> İsteğe bağlı

İlgili ürünlerin tanımlayıcıları.

maxItems: 100

Dizi:minLength: 1maxLength: 63

Ek alanlar: Hayır

Sonuçsuz arama içeren veya içermeyen aramaları seçen filtre

ZeroResultScope · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

Dize

Kısıtlamalar

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

Ek alanlar: Evet