Scéimeanna sonraí: Anailísíocht agus rialacha cuardaigh

Scéimeanna sonraí: Anailísíocht agus rialacha cuardaigh. Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

Scéimeanna sonraí

Meiteashonraí an fhreagra

AnalyticsMeta · Scéim · Scéimeanna sonraí: Anailísíocht agus rialacha cuardaigh

periodAnalyticsPeriodData Riachtanach: Tréimhse tuairiscithe agus a teorainneacha.

Sampla: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idTeaghránRiachtanach: Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

minLength: 1maxLength: 100

Sampla: "example"

Réimsí breise: Níl

Tréimhse tuairiscithe agus a teorainneacha

AnalyticsPeriodData · Scéim · Scéimeanna sonraí: Anailísíocht agus rialacha cuardaigh

as_ofTeaghránRiachtanach: An t-am lena mbaineann na sonraí tuairiscithe.

format: "date-time"

Sampla: "2026-01-02T00:00:00Z"
daysSlánuimhirRiachtanach: Tréimhse tuairiscithe i laethanta.

Sampla: 1
started_atTeaghránRiachtanach: Dáta agus am tosaigh.

format: "date-time"

Sampla: "2026-01-01T00:00:00Z"

Réimsí breise: Níl

Liostaigh · Iarratais chuardaigh — Anailísíocht agus rialacha cuardaigh — Freagra

AnalyticsResponse_list_MetricData__ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

dataEagar <MetricData > Riachtanach: Sampla freagra · AnalyticsResponse_list_MetricData__.

Sampla: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]
metaAnalyticsPageMeta AnalyticsMeta Riachtanach: Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

Faigh · Iarratais chuardaigh — Anailísíocht agus rialacha cuardaigh — Freagra

AnalyticsResponse_list_OccurrenceData__ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

dataEagar <OccurrenceData > Riachtanach: Sampla freagra · AnalyticsResponse_list_OccurrenceData__.

Sampla: [{"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 Riachtanach: Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

Achoimre — Anailísíocht agus rialacha cuardaigh — Freagra

AnalyticsResponse_OverviewData_ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

dataOverviewData Riachtanach: Sampla freagra · OverviewData.

Sampla: {"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 Riachtanach: Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

Liostaigh · Rialacha — Anailísíocht agus rialacha cuardaigh — Freagra

ApiResponse_list_RuleSummaryData__ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

dataEagar <RuleSummaryData > Riachtanach: Sampla freagra · ApiResponse_list_RuleSummaryData__.

Sampla: [{"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 Riachtanach: Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

Faigh · Rialacha — Anailísíocht agus rialacha cuardaigh — Freagra

ApiResponse_RuleDetailData_ · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

dataRuleDetailData Riachtanach: Sampla freagra · RuleDetailData.

Sampla: {"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 Riachtanach: Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

Liostaigh · Iarratais chuardaigh — Anailísíocht agus rialacha cuardaigh — Freagra

MetricData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

clicksSlánuimhirRiachtanach: Líon na gcliceálacha.

Sampla: 1
last_seen_atTeaghránRiachtanach: Am an teagmhais is déanaí.

format: "date-time"

Sampla: "2026-01-01T12:00:00Z"
query_displayTeaghránRiachtanach: Frása cuardaigh a thaispeántar don riarthóir.

Sampla: "example"
query_hashTeaghránRiachtanach: Aitheantóir cobhsaí an fhrása cuardaigh ghrúpáilte.

Sampla: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
searchesSlánuimhirRiachtanach: Líon cuardach.

Sampla: 1
zero_resultsSlánuimhirRiachtanach: Líon cuardach gan toradh.

Sampla: 1

Réimsí breise: Níl

Faigh · Iarratais chuardaigh — Anailísíocht agus rialacha cuardaigh — Freagra

OccurrenceData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

category_idTeaghrán nullRiachtanach

Aitheantóir catagóire.

Sampla: "example"

category_result_countSlánuimhirRiachtanach

Líon torthaí catagóire.

Sampla: 1

currency_codeTeaghránRiachtanach

Cód airgeadra.

Sampla: "PLN"

is_zero_resultsLuach BooleRiachtanach

An raibh an cuardach gan toradh.

Sampla: false

locale_codeTeaghránRiachtanach

Cód teanga.

Sampla: "en"

market_idTeaghránRiachtanach

Aitheantóir margaidh a thugann an críochphointe comhthéacs.

Sampla: "example"

max_priceTeaghrán nullRiachtanach

An praghas is airde sa raon tuairiscithe.

Sampla: "0.00"

min_priceTeaghrán nullRiachtanach

An praghas is ísle sa raon tuairiscithe.

Sampla: "0.00"

occurred_atTeaghránRiachtanach

Dáta agus am an teagmhais.

format: "date-time"

Sampla: "2026-01-01T12:00:00Z"

pageSlánuimhirRiachtanach

Eolas leathanaigh CMS.

Sampla: 1

product_result_countSlánuimhirRiachtanach

Líon torthaí cuardaigh táirge.

Sampla: 1

query_displayTeaghránRiachtanach

Frása cuardaigh a thaispeántar don riarthóir.

Sampla: "example"

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

Sampla: "example"

resultsEagar <ResultSnapshotData > nullRiachtanach

Torthaí cuardaigh taifeadta.

Sampla:

[{"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_keyTeaghránRiachtanach

Eochair sórtála.

Sampla: "example"

sourceTeaghránRiachtanach

Foinse na gníomhaíochta taifeadta.

Srianta

enum: ["results", "autocomplete"]

Sampla: "results"

Réimsí breise: Níl

Achoimre — Anailísíocht agus rialacha cuardaigh — Freagra

OverviewData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

click_through_rateUimhirRiachtanach: Ráta cliceála na sonraí cuardaigh roghnaithe.

Sampla: 0
clicked_searchesSlánuimhirRiachtanach: Líon cuardach ina ndearnadh cliceáil.

Sampla: 1
recentEagar <RecentSearchData > Riachtanach: Eolas faoi chuardaigh le déanaí.

Sampla: [{"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"}]
searchesSlánuimhirRiachtanach: Líon cuardach.

Sampla: 1
zero_result_rateUimhirRiachtanach: Sciar cuardach nár thug toradh ar bith.

Sampla: 0
zero_resultsSlánuimhirRiachtanach: Líon cuardach gan toradh.

Sampla: 1

Réimsí breise: Níl

Ord sórtála roghnaithe do na torthaí

QueryMetricSort · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

Teaghrán

Srianta

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

Réimsí breise: Tá

Eolas faoi chuardaigh le déanaí

RecentSearchData · Scéim · Scéimeanna sonraí: Anailísíocht agus rialacha cuardaigh

is_zero_resultsLuach BooleRiachtanach

An raibh an cuardach gan toradh.

Sampla: false

locale_codeTeaghránRiachtanach

Cód teanga.

Sampla: "en"

occurred_atTeaghránRiachtanach

Dáta agus am an teagmhais.

format: "date-time"

Sampla: "2026-01-01T12:00:00Z"

query_displayTeaghránRiachtanach

Frása cuardaigh a thaispeántar don riarthóir.

Sampla: "example"

query_hashTeaghránRiachtanach

Aitheantóir cobhsaí an fhrása cuardaigh ghrúpáilte.

Sampla: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_idTeaghránRiachtanach

Aitheantóir iarratais; i meiteashonraí freagra aithníonn sé an t-iarratas HTTP.

Sampla: "example"

result_countSlánuimhirRiachtanach

Líon torthaí cuardaigh.

Sampla: 1

sourceTeaghránRiachtanach

Foinse na gníomhaíochta taifeadta.

Srianta

enum: ["results", "autocomplete"]

Sampla: "results"

Réimsí breise: Níl

Torthaí cuardaigh taifeadta

ResultSnapshotData · Scéim · Scéimeanna sonraí: Anailísíocht agus rialacha cuardaigh

clickedLuach BooleRiachtanach

Ar cliceáladh ar an toradh.

Sampla: false

entity_idTeaghránRiachtanach

Aitheantóir na heintitis dá dtagraítear.

Sampla: "example"

entity_typeTeaghránRiachtanach

Cineál na heintitis dá dtagraítear.

Srianta

enum: ["product", "category"]

Sampla: "product"

image_urlTeaghrán nullRiachtanach

URL íomhá.

Sampla: "https://example.invalid/product.jpg"

numberTeaghrán nullRiachtanach

Uimhir ordaithe nó iarratais atá le léamh ag duine.

Sampla: "example"

placement_sourceTeaghránRiachtanach

An fhoinse ónar cuireadh an t-ordú.

Srianta

enum: ["organic", "merchandising"]

Sampla: "organic"

positionSlánuimhirRiachtanach

Suíomh sa bhailiúchán ordaithe.

Sampla: 1

skuTeaghránRiachtanach

Cód aonaid coimeádta stoic.

Sampla: "example"

slugTeaghránRiachtanach

Cuid de chosán URL sa teanga roghnaithe.

Sampla: "example"

titleTeaghránRiachtanach

Teideal sa teanga roghnaithe.

Sampla: "example"

Réimsí breise: Níl

Cruthaigh · Rialacha — Anailísíocht agus rialacha cuardaigh — Corp an iarratais

RuleCreate · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

category_idsEagar <Teaghrán> Roghnach

Aitheantóirí catagóirí gaolmhara.

maxItems: 100

Eagar:minLength: 1maxLength: 63

enabledLuach BooleRoghnach

An bhfuil an socrú seo cumasaithe.

Réamhshocrú: false

market_idsEagar <Teaghrán> Roghnach

Aitheantóirí na margaí roghnaithe.

maxItems: 1000

Eagar:minLength: 1maxLength: 63

market_scopeTeaghránRoghnach

An mbaineann an acmhainn le gach margadh nó le margaí roghnaithe.

Srianta

enum: ["all", "selected"]

nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

minLength: 1maxLength: 160

Sampla: "Example"

phrasesEagar <Teaghrán> Riachtanach

Frásaí a úsáideann an riail chuardaigh.

minItems: 1maxItems: 20

Eagar:minLength: 1maxLength: 255

Sampla: ["example"]

product_idsEagar <Teaghrán> Roghnach

Aitheantóirí táirgí gaolmhara.

maxItems: 100

Eagar:minLength: 1maxLength: 63

Sampla: ["example"]

Réimsí breise: Níl

Faigh · Rialacha — Anailísíocht agus rialacha cuardaigh — Freagra

RuleDetailData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

category_idsEagar <Teaghrán> Riachtanach

Aitheantóirí catagóirí gaolmhara.

Sampla: ["example"]

created_atTeaghránRiachtanach

Am cruthaithe.

format: "date-time"

Sampla: "2026-01-01T12:00:00Z"

enabledLuach BooleRiachtanach

An bhfuil an socrú seo cumasaithe.

Sampla: true

idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. (RuleDetailData).

Sampla: "example"

is_availableLuach BooleRiachtanach

An bhfuil an mhír ar fáil sa chomhthéacs seo.

Sampla: true

market_idsEagar <Teaghrán> Riachtanach

Aitheantóirí na margaí roghnaithe.

Sampla: ["example"]

market_scopeTeaghránRiachtanach

An mbaineann an acmhainn le gach margadh nó le margaí roghnaithe.

Srianta

enum: ["all", "selected"]

Sampla: "all"

nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Example"

phrase_groupsEagar <RulePhraseGroupData > Riachtanach

Grúpaí frásaí rialach cuardaigh.

Sampla: [{"locale":"en","phrases":["example"]}]

product_idsEagar <Teaghrán> Riachtanach

Aitheantóirí táirgí gaolmhara.

Sampla: ["example"]

updated_atTeaghránRiachtanach

Am an nuashonraithe is déanaí.

format: "date-time"

Sampla: "2026-01-01T12:00:00Z"

versionSlánuimhirRiachtanach

Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

Sampla: 1

Réimsí breise: Níl

Grúpaí frásaí rialach cuardaigh

RulePhraseGroupData · Scéim · Scéimeanna sonraí: Anailísíocht agus rialacha cuardaigh

localeTeaghránRiachtanach: Teanga roghnaithe don iarratas seo.

Sampla: "en"
phrasesEagar <Teaghrán> Riachtanach: Frásaí a úsáideann an riail chuardaigh.

Sampla: ["example"]

Réimsí breise: Níl

Liostaigh · Rialacha — Anailísíocht agus rialacha cuardaigh — Freagra

RuleSummaryData · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

created_atTeaghránRiachtanach

Am cruthaithe.

format: "date-time"

Sampla: "2026-01-01T12:00:00Z"

enabledLuach BooleRiachtanach

An bhfuil an socrú seo cumasaithe.

Sampla: true

idTeaghránRiachtanach

Aitheantóir acmhainne; coinnigh mar a tugadh ar ais é. (RuleSummaryData).

Sampla: "example"

is_availableLuach BooleRiachtanach

An bhfuil an mhír ar fáil sa chomhthéacs seo.

Sampla: true

market_scopeTeaghránRiachtanach

An mbaineann an acmhainn le gach margadh nó le margaí roghnaithe.

Srianta

enum: ["all", "selected"]

Sampla: "all"

nameTeaghránRiachtanach

Ainm acmhainne sa chomhthéacs cuí.

Sampla: "Example"

updated_atTeaghránRiachtanach

Am an nuashonraithe is déanaí.

format: "date-time"

Sampla: "2026-01-01T12:00:00Z"

versionSlánuimhirRiachtanach

Leagan acmhainne a úsáidtear le haghaidh rialú comhreatha.

Sampla: 1

Réimsí breise: Níl

Nuashonraigh · Rialacha — Anailísíocht agus rialacha cuardaigh — Corp an iarratais

RuleUpdate · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

category_idsEagar <Teaghrán> Roghnach

Aitheantóirí catagóirí gaolmhara.

maxItems: 100

Eagar:minLength: 1maxLength: 63

enabledLuach BooleRoghnach

An bhfuil an socrú seo cumasaithe.

expected_versionSlánuimhirRiachtanach

Leagan a léadh roimh scríobh; diúltaítear don nuashonrú mura n-oireann sé.

minimum: 1maximum: 2147483647

Sampla: 1

market_idsEagar <Teaghrán> Roghnach

Aitheantóirí na margaí roghnaithe.

maxItems: 1000

Eagar:minLength: 1maxLength: 63

market_scopeTeaghránRoghnach

An mbaineann an acmhainn le gach margadh nó le margaí roghnaithe.

Srianta

enum: ["all", "selected"]

nameTeaghránRoghnach

Ainm acmhainne sa chomhthéacs cuí.

minLength: 1maxLength: 160

Sampla: "Example"

phrasesEagar <Teaghrán> Roghnach

Frásaí a úsáideann an riail chuardaigh.

maxItems: 20

Eagar:minLength: 1maxLength: 255

product_idsEagar <Teaghrán> Roghnach

Aitheantóirí táirgí gaolmhara.

maxItems: 100

Eagar:minLength: 1maxLength: 63

Réimsí breise: Níl

Scagaire a roghnaíonn cuardaigh le teagmhais gan toradh nó gan iad

ZeroResultScope · Réimsí, cineálacha agus srianta na sonraí a ghlacann nó a sheolann an API ar ais.

Teaghrán

Srianta

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

Réimsí breise: Tá