Analytics
Search analytics reports.
نقطة وصول واحدة. أسماء نقاط الوصول وأوصافها مأخوذة من ملف OpenAPI، لذلك تظهر بالإنجليزية.
GET
/v1/stats/{report}Search analytics reports
يحتاج إلى مفتاح أو جلسة في لوحة التحكم
Add `format=csv` for a CSV download of the same rows (columns = the report's row fields).
المعاملات
| الاسم | الموضع | النوع | إلزامي | الوصف |
|---|---|---|---|---|
report | path | "overview" | "top_queries" | "zero_results" | "low_ctr" | "ctr_by_position" | "conversions" | "by_language" | "by_device" | "assistant" | نعم | |
from | query | string (date) | null | لا | |
to | query | string (date) | null | لا | |
lang | query | string | لا | default "all" · pattern ^(all|[a-z]{2})$ |
device | query | "all" | "desktop" | "mobile" | "tablet" | لا | default "all" |
limit | query | integer | لا | default 50 · min 1 · max 200 |
format | query | "json" | "csv" | لا | default "json" |
الردود
- 200Successful Response
OverviewStats | TopQueriesStats | ZeroResultsStats | LowCtrStats | CtrByPositionStats | ConversionsStats | ByLanguageStats | ByDeviceStats | AssistantStats
أشكال البيانات في هذه الصفحة
OverviewStats
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
date_from | string (date) | نعم | |
date_to | string (date) | نعم | |
totals | StatsTotals | لا | |
report | "overview" | نعم | |
rows | OverviewRow[] | لا |
StatsTotals
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
searches | integer | لا | default 0 |
suggests | integer | لا | Never billed.default 0 |
clicks | integer | لا | default 0 |
ctr | number | لا | default 0 |
zero_result_rate | number | لا | default 0 |
add_to_carts | integer | لا | default 0 |
orders | integer | لا | default 0 |
conversion_rate | number | لا | Searches followed by an order / searches.default 0 |
OverviewRow
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
day | string (date) | نعم | |
searches | integer | نعم | |
suggests | integer | نعم | |
zero_results | integer | نعم | |
clicks | integer | نعم | |
ctr | number | نعم | |
add_to_carts | integer | نعم | |
orders | integer | نعم |
TopQueriesStats
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
date_from | string (date) | نعم | |
date_to | string (date) | نعم | |
totals | StatsTotals | لا | |
report | "top_queries" | نعم | |
rows | TopQueryRow[] | لا |
TopQueryRow
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
query | string | نعم | Normalized query text. |
searches | integer | نعم | |
clicks | integer | نعم | |
ctr | number | نعم | |
zero_result_rate | number | نعم | |
avg_click_position | number | null | لا |
ZeroResultsStats
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
date_from | string (date) | نعم | |
date_to | string (date) | نعم | |
totals | StatsTotals | لا | |
report | "zero_results" | نعم | |
rows | ZeroResultRow[] | لا |
ZeroResultRow
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
query | string | نعم | |
searches | integer | نعم | |
last_seen | string (date) | نعم | |
suggestion | string | null | لا | A synonym suggestion id or did-you-mean text, if any. |
LowCtrStats
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
date_from | string (date) | نعم | |
date_to | string (date) | نعم | |
totals | StatsTotals | لا | |
report | "low_ctr" | نعم | |
rows | LowCtrRow[] | لا |
LowCtrRow
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
query | string | نعم | |
searches | integer | نعم | |
clicks | integer | نعم | |
ctr | number | نعم |
CtrByPositionStats
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
date_from | string (date) | نعم | |
date_to | string (date) | نعم | |
totals | StatsTotals | لا | |
report | "ctr_by_position" | نعم | |
rows | CtrByPositionRow[] | لا |
CtrByPositionRow
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
position | integer | نعم | min 1 |
impressions | integer | نعم | |
clicks | integer | نعم | |
ctr | number | نعم |
ConversionsStats
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
date_from | string (date) | نعم | |
date_to | string (date) | نعم | |
totals | StatsTotals | لا | |
report | "conversions" | نعم | |
rows | ConversionRow[] | لا |
ConversionRow
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
query | string | نعم | |
searches | integer | نعم | |
clicks | integer | نعم | |
add_to_carts | integer | نعم | |
orders | integer | نعم | |
conversion_rate | number | نعم | |
revenue | string | نعم | In `currency`, from order events. |
currency | string | نعم |
ByLanguageStats
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
date_from | string (date) | نعم | |
date_to | string (date) | نعم | |
totals | StatsTotals | لا | |
report | "by_language" | نعم | |
rows | SegmentRow[] | لا |
SegmentRow
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
segment | string | نعم | by_language: a locale code; by_device: desktop | mobile | tablet | unknown. |
searches | integer | نعم | |
share | number | نعم | This segment's share of all searches. |
clicks | integer | نعم | |
ctr | number | نعم | |
zero_result_rate | number | نعم | |
conversion_rate | number | نعم |
ByDeviceStats
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
date_from | string (date) | نعم | |
date_to | string (date) | نعم | |
totals | StatsTotals | لا | |
report | "by_device" | نعم | |
rows | SegmentRow[] | لا |
AssistantStats
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
date_from | string (date) | نعم | |
date_to | string (date) | نعم | |
totals | StatsTotals | لا | |
report | "assistant" | نعم | |
rows | AssistantRow[] | لا |
AssistantRow
| الاسم | النوع | إلزامي | الوصف |
|---|---|---|---|
day | string (date) | نعم | |
conversations | integer | نعم | |
messages | integer | نعم | |
products_shown | integer | نعم | |
product_clicks | integer | نعم | |
handovers | integer | نعم | |
conversion_proxy | number | نعم | Conversations with a product click / conversations. |
cost_usd | string | نعم |