Skemi tad-data: Analiżi u regoli tat-tiftix

Skemi tad-data: Analiżi u regoli tat-tiftix. L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

Skemi tad-data

Metadata tat-tweġiba

AnalyticsMeta · Skema · Skemi tad-data: Analiżi u regoli tat-tiftix

periodAnalyticsPeriodData Obbligatorju: Perjodu tar-rappurtar u l-konfini tiegħu.

Eżempju: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idStringObbligatorju: Identifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.

minLength: 1maxLength: 100

Eżempju: "example"

Oqsma addizzjonali: Le

Perjodu tar-rappurtar u l-konfini tiegħu

AnalyticsPeriodData · Skema · Skemi tad-data: Analiżi u regoli tat-tiftix

as_ofStringObbligatorju: Il-ħin li għalih tapplika d-data rrappurtata.

format: "date-time"

Eżempju: "2026-01-02T00:00:00Z"
daysNumru sħiħObbligatorju: Perjodu ta’ rappurtar f’jiem.

Eżempju: 1
started_atStringObbligatorju: Data u ħin tal-bidu.

format: "date-time"

Eżempju: "2026-01-01T00:00:00Z"

Oqsma addizzjonali: Le

Elenka · Mistoqsijiet tat-tiftix — Analiżi u regoli tat-tiftix — Risposta

AnalyticsResponse_list_MetricData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <MetricData > Obbligatorju: Eżempju ta’ tweġiba · AnalyticsResponse_list_MetricData__.

Eżempju: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"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"}

Oqsma addizzjonali: Le

Ikseb · Mistoqsijiet tat-tiftix — Analiżi u regoli tat-tiftix — Risposta

AnalyticsResponse_list_OccurrenceData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <OccurrenceData > Obbligatorju: Eżempju ta’ tweġiba · AnalyticsResponse_list_OccurrenceData__.

Eżempju: [{"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"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"}

Oqsma addizzjonali: Le

Sommarju — Analiżi u regoli tat-tiftix — Risposta

AnalyticsResponse_OverviewData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataOverviewData Obbligatorju: Eżempju ta’ tweġiba · OverviewData.

Eżempju: {"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

Oqsma addizzjonali: Le

Elenka · Regoli — Analiżi u regoli tat-tiftix — Risposta

ApiResponse_list_RuleSummaryData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <RuleSummaryData > Obbligatorju: Eżempju ta’ tweġiba · ApiResponse_list_RuleSummaryData__.

Eżempju: [{"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Oqsma addizzjonali: Le

Ikseb · Regoli — Analiżi u regoli tat-tiftix — Risposta

ApiResponse_RuleDetailData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataRuleDetailData Obbligatorju: Eżempju ta’ tweġiba · RuleDetailData.

Eżempju: {"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Oqsma addizzjonali: Le

Elenka · Mistoqsijiet tat-tiftix — Analiżi u regoli tat-tiftix — Risposta

MetricData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

clicksNumru sħiħObbligatorju: Numru ta’ klikks.

Eżempju: 1
last_seen_atStringObbligatorju: Ħin tal-aktar okkorrenza reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"
query_displayStringObbligatorju: Frażi tat-tiftix murija lill-amministratur.

Eżempju: "example"
query_hashStringObbligatorju: Identifikatur stabbli tal-frażi tat-tiftix raggruppata.

Eżempju: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesNumru sħiħObbligatorju: Numru ta’ tfittxijiet.

Eżempju: 1
zero_resultsNumru sħiħObbligatorju: Numru ta’ tfittxijiet mingħajr riżultati.

Eżempju: 1

Oqsma addizzjonali: Le

Ikseb · Mistoqsijiet tat-tiftix — Analiżi u regoli tat-tiftix — Risposta

OccurrenceData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

category_idString nullObbligatorju

Identifikatur tal-kategorija.

Eżempju: "example"

category_result_countNumru sħiħObbligatorju

Numru ta’ riżultati ta’ kategoriji.

Eżempju: 1

currency_codeStringObbligatorju

Kodiċi tal-munita.

Eżempju: "PLN"

is_zero_resultsBooleanObbligatorju

Jekk it-tiftix ma tax riżultati.

Eżempju: false

locale_codeStringObbligatorju

Kodiċi tal-lingwa.

Eżempju: "en"

market_idStringObbligatorju

Identifikatur tas-suq mogħti mill-endpoint tal-kuntest.

Eżempju: "example"

max_priceString nullObbligatorju

L-ogħla prezz fil-firxa rrappurtata.

Eżempju: "0.00"

min_priceString nullObbligatorju

L-inqas prezz fil-firxa rrappurtata.

Eżempju: "0.00"

occurred_atStringObbligatorju

Data u ħin tal-avveniment.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

pageNumru sħiħObbligatorju

Informazzjoni tal-paġna CMS.

Eżempju: 1

product_result_countNumru sħiħObbligatorju

Numru ta’ riżultati tat-tiftix tal-prodotti.

Eżempju: 1

query_displayStringObbligatorju

Frażi tat-tiftix murija lill-amministratur.

Eżempju: "example"

request_idStringObbligatorju

Identifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.

Eżempju: "example"

resultsArray <ResultSnapshotData > nullObbligatorju

Riżultati tat-tiftix irreġistrati.

Eżempju:

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

Ċavetta tal-ordni.

Eżempju: "example"

sourceStringObbligatorju

Sors tal-attività rreġistrata.

Restrizzjonijiet

enum: ["results", "autocomplete"]

Eżempju: "results"

Oqsma addizzjonali: Le

Sommarju — Analiżi u regoli tat-tiftix — Risposta

OverviewData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

click_through_rateNumruObbligatorju: Rata tal-klikks għad-data tat-tiftix magħżula.

Eżempju: 0
clicked_searchesNumru sħiħObbligatorju: Numru ta’ tfittxijiet bi klikk.

Eżempju: 1
recentArray <RecentSearchData > Obbligatorju: Informazzjoni dwar tiftix reċenti.

Eżempju: [{"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"}]
searchesNumru sħiħObbligatorju: Numru ta’ tfittxijiet.

Eżempju: 1
zero_result_rateNumruObbligatorju: Proporzjon ta’ tfittxijiet mingħajr riżultati.

Eżempju: 0
zero_resultsNumru sħiħObbligatorju: Numru ta’ tfittxijiet mingħajr riżultati.

Eżempju: 1

Oqsma addizzjonali: Le

Ordni magħżul għar-riżultati

QueryMetricSort · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

String

Restrizzjonijiet

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

Oqsma addizzjonali: Iva

Informazzjoni dwar tiftix reċenti

RecentSearchData · Skema · Skemi tad-data: Analiżi u regoli tat-tiftix

is_zero_resultsBooleanObbligatorju

Jekk it-tiftix ma tax riżultati.

Eżempju: false

locale_codeStringObbligatorju

Kodiċi tal-lingwa.

Eżempju: "en"

occurred_atStringObbligatorju

Data u ħin tal-avveniment.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

query_displayStringObbligatorju

Frażi tat-tiftix murija lill-amministratur.

Eżempju: "example"

query_hashStringObbligatorju

Identifikatur stabbli tal-frażi tat-tiftix raggruppata.

Eżempju: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idStringObbligatorju

Identifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.

Eżempju: "example"

result_countNumru sħiħObbligatorju

Numru ta’ riżultati tat-tiftix.

Eżempju: 1

sourceStringObbligatorju

Sors tal-attività rreġistrata.

Restrizzjonijiet

enum: ["results", "autocomplete"]

Eżempju: "results"

Oqsma addizzjonali: Le

Riżultati tat-tiftix irreġistrati

ResultSnapshotData · Skema · Skemi tad-data: Analiżi u regoli tat-tiftix

clickedBooleanObbligatorju

Jekk ir-riżultat ġiex ikklikkjat.

Eżempju: false

entity_idStringObbligatorju

Identifikatur tal-entità referenzjata.

Eżempju: "example"

entity_typeStringObbligatorju

Tip tal-entità referenzjata.

Restrizzjonijiet

enum: ["product", "category"]

Eżempju: "product"

image_urlString nullObbligatorju

URL tal-istampa.

Eżempju: "https://example.invalid/product.jpg"

numberString nullObbligatorju

Numru tal-ordni jew tat-talba muri lill-bniedem.

Eżempju: "example"

placement_sourceStringObbligatorju

Sors minn fejn saret l-ordni.

Restrizzjonijiet

enum: ["organic", "merchandising"]

Eżempju: "organic"

positionNumru sħiħObbligatorju

Pożizzjoni fil-kollezzjoni ordnata.

Eżempju: 1

skuStringObbligatorju

Kodiċi tal-unità ta’ ġestjoni tal-istokk.

Eżempju: "example"

slugStringObbligatorju

Segment tal-mogħdija URL fil-lingwa magħżula.

Eżempju: "example"

titleStringObbligatorju

Titlu fil-lingwa magħżula.

Eżempju: "example"

Oqsma addizzjonali: Le

Oħloq · Regoli — Analiżi u regoli tat-tiftix — Kontenut tat-talba

RuleCreate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

category_idsArray <String> Mhux obbligatorju

Identifikaturi tal-kategoriji relatati.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBooleanMhux obbligatorju

Jekk dan l-issettjar huwiex attivat.

Valur predefinit: false

market_idsArray <String> Mhux obbligatorju

Identifikaturi tas-swieq magħżula.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeStringMhux obbligatorju

Jekk ir-riżorsa tapplikax għas-swieq kollha jew għal dawk magħżula.

Restrizzjonijiet

enum: ["all", "selected"]

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

minLength: 1maxLength: 160

Eżempju: "Example"

phrasesArray <String> Obbligatorju

Frażijiet użati mir-regola tat-tiftix.

minItems: 1maxItems: 20

Array:minLength: 1maxLength: 255

Eżempju: ["example"]

product_idsArray <String> Mhux obbligatorju

Identifikaturi tal-prodotti relatati.

maxItems: 100

Array:minLength: 1maxLength: 63

Eżempju: ["example"]

Oqsma addizzjonali: Le

Ikseb · Regoli — Analiżi u regoli tat-tiftix — Risposta

RuleDetailData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

category_idsArray <String> Obbligatorju

Identifikaturi tal-kategoriji relatati.

Eżempju: ["example"]

created_atStringObbligatorju

Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

enabledBooleanObbligatorju

Jekk dan l-issettjar huwiex attivat.

Eżempju: true

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (RuleDetailData).

Eżempju: "example"

is_availableBooleanObbligatorju

Jekk l-oġġett huwiex disponibbli f’dan il-kuntest.

Eżempju: true

market_idsArray <String> Obbligatorju

Identifikaturi tas-swieq magħżula.

Eżempju: ["example"]

market_scopeStringObbligatorju

Jekk ir-riżorsa tapplikax għas-swieq kollha jew għal dawk magħżula.

Restrizzjonijiet

enum: ["all", "selected"]

Eżempju: "all"

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Example"

phrase_groupsArray <RulePhraseGroupData > Obbligatorju

Gruppi ta’ frażijiet tar-regola tat-tiftix.

Eżempju: [{"locale":"en","phrases":["example"]}]

product_idsArray <String> Obbligatorju

Identifikaturi tal-prodotti relatati.

Eżempju: ["example"]

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

Gruppi ta’ frażijiet tar-regola tat-tiftix

RulePhraseGroupData · Skema · Skemi tad-data: Analiżi u regoli tat-tiftix

localeStringObbligatorju: Lingwa magħżula għal din it-talba.

Eżempju: "en"
phrasesArray <String> Obbligatorju: Frażijiet użati mir-regola tat-tiftix.

Eżempju: ["example"]

Oqsma addizzjonali: Le

Elenka · Regoli — Analiżi u regoli tat-tiftix — Risposta

RuleSummaryData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

created_atStringObbligatorju

Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

enabledBooleanObbligatorju

Jekk dan l-issettjar huwiex attivat.

Eżempju: true

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (RuleSummaryData).

Eżempju: "example"

is_availableBooleanObbligatorju

Jekk l-oġġett huwiex disponibbli f’dan il-kuntest.

Eżempju: true

market_scopeStringObbligatorju

Jekk ir-riżorsa tapplikax għas-swieq kollha jew għal dawk magħżula.

Restrizzjonijiet

enum: ["all", "selected"]

Eżempju: "all"

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Example"

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

Aġġorna · Regoli — Analiżi u regoli tat-tiftix — Kontenut tat-talba

RuleUpdate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

category_idsArray <String> Mhux obbligatorju

Identifikaturi tal-kategoriji relatati.

maxItems: 100

Array:minLength: 1maxLength: 63

enabledBooleanMhux obbligatorju

Jekk dan l-issettjar huwiex attivat.

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 2147483647

Eżempju: 1

market_idsArray <String> Mhux obbligatorju

Identifikaturi tas-swieq magħżula.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeStringMhux obbligatorju

Jekk ir-riżorsa tapplikax għas-swieq kollha jew għal dawk magħżula.

Restrizzjonijiet

enum: ["all", "selected"]

nameStringMhux obbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

minLength: 1maxLength: 160

Eżempju: "Example"

phrasesArray <String> Mhux obbligatorju

Frażijiet użati mir-regola tat-tiftix.

maxItems: 20

Array:minLength: 1maxLength: 255

product_idsArray <String> Mhux obbligatorju

Identifikaturi tal-prodotti relatati.

maxItems: 100

Array:minLength: 1maxLength: 63

Oqsma addizzjonali: Le

Filtru li jagħżel tfittxijiet bi jew mingħajr okkorrenzi mingħajr riżultati

ZeroResultScope · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

String

Restrizzjonijiet

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

Oqsma addizzjonali: Iva