Getting started
This report returns the relevant KPIs for a specific category and its distribution for the date range selected.
STEP-BY-STEP GUIDE to gather data from any report using the Empathy Stats API
Created by Lara Menéndez · last update July 25, 2019
This report returns the relevant KPIs for a specific category and its distribution for the date range selected.
STEP-BY-STEP GUIDE to gather data from any report using the Empathy Stats API
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}/DailyCategoryDist
Query Parameters
PARAMETER | TYPE |
---|---|
start_date | Int (ISO 8601 format) |
end_date | Int (ISO 8601 format) |
filters | list[str] |
type | int |
terms | str |
Bearer Token Get your token
Example request:
https://api.empathybroker.com/stats/v2/analysis/ebdemo/DailyCategoryDist?start_date=2019-07-10&end_date=2019-07-13&category_id=1030204572
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
{
"data": {
"query_count": 0,
"click_count": 601677,
"wishlist_count": 0,
"add2cart_count": 57741,
"checkout_count": 0,
"conversion_count": 0,
"success_count": 580406,
"click_count_pct": 100,
"wishlist_count_pct": 100,
"add2cart_count_pct": 100,
"checkout_count_pct": 100,
"conversion_count_pct": 0,
"success_count_pct": 100,
"no_results_count": 0,
"no_results_count_pct": 100,
"term_count": 0,
"term_avg": 0,
"apicall_count": 0,
"findability": 100,
"clicks_data": [
{
"datetime": "2019-07-10T00:00:00Z",
"value": 207156,
"pct": 100
},
{
"datetime": "2019-07-11T00:00:00Z",
"value": 205792,
"pct": 100
},
{
"datetime": "2019-07-12T00:00:00Z",
"value": 188729,
"pct": 100
}
],
"success_data": [
{
"datetime": "2019-07-10T00:00:00Z",
"value": 199667,
"pct": 100
},
{
"datetime": "2019-07-11T00:00:00Z",
"value": 198438,
"pct": 100
},
{
"datetime": "2019-07-12T00:00:00Z",
"value": 182301,
"pct": 100
}
],
"add2cart_data": [
{
"datetime": "2019-07-10T00:00:00Z",
"value": 21080,
"pct": 100
},
{
"datetime": "2019-07-11T00:00:00Z",
"value": 19873,
"pct": 100
},
{
"datetime": "2019-07-12T00:00:00Z",
"value": 16788,
"pct": 100
}
],
"checkout_data": [
{
"datetime": "2019-07-10T00:00:00Z",
"value": 0,
"pct": 100
},
{
"datetime": "2019-07-11T00:00:00Z",
"value": 0,
"pct": 100
},
{
"datetime": "2019-07-12T00:00:00Z",
"value": 0,
"pct": 100
}
]
},
"params": {
"site_id": "ebdemo",
"start_date": 1562716800000,
"end_date": 1562976000000,
"filters": [],
"category_id": "1030204572",
"bucket_size": "day",
"browsing": false
}
}