Getting started
This report returns the performance of each keyword used on queries or the keyword specified. the “success” of each search term for the selected date range drilledown by the filter specified.
Created by Lara Menéndez · last update July 25, 2019
This report returns the performance of each keyword used on queries or the keyword specified. the “success” of each search term for the selected date range drilledown by the filter specified.
To retrieve data from this report, define the request using all the available params and filters detailed in the box.
First, ensure you get your token.
GET https://api.empathybroker.com/stats/v2/analysis/{Instance_ID}/DistKeyword
Query Parameters
PARAMETER | TYPE |
---|---|
start_date | Int (ISO 8601 format) |
end_date | Int (ISO 8601 format) |
filters | list[str] |
type | int |
keyword | str |
Bearer Token Get your token
Example request:
https://api.empathybroker.com/stats/v2/analysis/ebdemo/DistKeyword?start_date=2019-07-10&end_date=2019-07-13&filters=lang,scope&lang=es_ES&scope=desktop&terms=camiseta
Once the request is performed, the following KPIs are retrieved shaped in json format:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
{
"data": {
"query_count": 77661,
"click_count": 40042,
"wishlist_count": 0,
"add2cart_count": 9001,
"checkout_count": 0,
"conversion_count": 0,
"success_count": 31283,
"click_count_pct": 51.56,
"wishlist_count_pct": 0,
"add2cart_count_pct": 11.59,
"checkout_count_pct": 0,
"conversion_count_pct": 0,
"success_count_pct": 40.28,
"no_results_count": 2907,
"no_results_count_pct": 3.74,
"term_count": 0,
"term_avg": 0,
"apicall_count": 0,
"findability": 40.28,
"queries_data": [
{
"datetime": "2019-07-10T00:00:00Z",
"value": 33578,
"pct": 100
},
{
"datetime": "2019-07-11T00:00:00Z",
"value": 21460,
"pct": 100
},
{
"datetime": "2019-07-12T00:00:00Z",
"value": 22623,
"pct": 100
}
],
"clicks_data": [
{
"datetime": "2019-07-10T00:00:00Z",
"value": 17016,
"pct": 50.68
},
{
"datetime": "2019-07-11T00:00:00Z",
"value": 11618,
"pct": 54.14
},
{
"datetime": "2019-07-12T00:00:00Z",
"value": 11408,
"pct": 50.43
}
],
"wishlist_data": [
{
"datetime": "2019-07-10T00:00:00Z",
"value": 0,
"pct": 0
},
{
"datetime": "2019-07-11T00:00:00Z",
"value": 0,
"pct": 0
},
{
"datetime": "2019-07-12T00:00:00Z",
"value": 0,
"pct": 0
}
],
"add2cart_data": [
{
"datetime": "2019-07-10T00:00:00Z",
"value": 3780,
"pct": 11.26
},
{
"datetime": "2019-07-11T00:00:00Z",
"value": 2616,
"pct": 12.19
},
{
"datetime": "2019-07-12T00:00:00Z",
"value": 2605,
"pct": 11.51
}
],
"checkout_data": [
{
"datetime": "2019-07-10T00:00:00Z",
"value": 0,
"pct": 0
},
{
"datetime": "2019-07-11T00:00:00Z",
"value": 0,
"pct": 0
},
{
"datetime": "2019-07-12T00:00:00Z",
"value": 0,
"pct": 0
}
],
"conversion_data": [
{
"datetime": "2019-07-10T00:00:00Z",
"value": 0,
"pct": 0
},
{
"datetime": "2019-07-11T00:00:00Z",
"value": 0,
"pct": 0
},
{
"datetime": "2019-07-12T00:00:00Z",
"value": 0,
"pct": 0
}
],
"no_results_data": [
{
"datetime": "2019-07-10T00:00:00Z",
"value": 2483,
"pct": 7.39
},
{
"datetime": "2019-07-11T00:00:00Z",
"value": 259,
"pct": 1.21
},
{
"datetime": "2019-07-12T00:00:00Z",
"value": 165,
"pct": 0.73
}
],
"findability_data": [
{
"datetime": "2019-07-10T00:00:00Z",
"value": 13470,
"pct": 40.12
},
{
"datetime": "2019-07-11T00:00:00Z",
"value": 8740,
"pct": 40.73
},
{
"datetime": "2019-07-12T00:00:00Z",
"value": 9073,
"pct": 40.11
}
]
},
"params": {
"site_id": "ebdemo",
"start_date": 1562716800000,
"end_date": 1562976000000,
"filters": [],
"keyword": "camiseta",
"type": 0,
"bucket": "day"
}
}