Empathy Stats API - V2 - Reports
In this section we can see an updated list of every available reports, their descriptions, their required input parameters and the expected output for their newer implementation in the V2:
List of available reports:
- Empathy Stats API V2 - Reports - Distribution
- Empathy Stats API V2 - Reports - Browse Distribution
- Empathy Stats API V2 - Reports - Terms
- Empathy Stats API V2 - Reports - Keywords
- Empathy Stats API V2 - Reports - Category
- Empathy Stats API V2 - Reports - Related
- Empathy Stats API V2 - Reports - Top
- Empathy Stats API V2 - Reports - Miscellaneous
- Empathy Stats API V2 - Reports - Next Queries
- Empathy Stats API V2 - Reports - Non Result Next Queries
- Empathy Stats API V2 - Reports - Trending
- Empathy Stats API V2 - Reports - Opportunities
- Empathy Stats API V2 - Reports - ConfigCount
- Empathy Stats API V2 - Reports - Boost
- Empathy Stats API V2 - Reports - User / Sessions
URI Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
| start_date | int |  | start of date interval* (ISO 8601 format) - UTC |
| end_date | int | | end of date interval* (ISO 8601 format) - UTC |
| filters | list[str] |  | list of filter names to be applied separated by comma |
| filter_n | list[str] | | for each filter on filters, its values separated by comma |
| format | str |  | output format regarding the response, it can be either 'json' or 'csv'. The value by default is 'json'. |
* Note that when we are doing a filter by two dates we got records greater than or equal than the start_date and less than the end_date. For example if we want to get records from the 3rd of May to the 15th of May (both included) we need to send start_date=2017-05-03T00:00:00.000Z and end_date=2017-05-16T00:00:00.000Z.
Report IDs
Report Name | Report ID |
|---|---|
| Hourly Distribution Analysis | HourlyDist |
| Daily Distribution Analysis | DailyDist |
| Hourly Term Distribution Analysis | TermHourlyDist |
| Daily Term Distribution Analysis | TermDailyDist |
| Daily Category Analysis | DailyCategoryDist |
| Opportunities Analysis | Opportunities |
| Top Queries Analysis | TopQueries |
| Top Clicked Analysis | TopClicked |
| Top Categories Analysis | TopCategories |
| Related Click Analysis | RelatedClick |
| Related Wishlist Analysis | RelatedWishlist |
| Related Add2Cart Analysis | RelatedAdd2Cart |
| Term Success Analysis | TermSuccess |
| Keyword Analysis | Keyword |
| Keyword Distribution Analysis | DistKeyword |
| Config Count Analysis | ConfigCount |
| Non Result Next Queries Analysis | NonResultNextQueries |
| Trending Analysis | Trending |
| Pivot Distribution Analysis | PivotDistribution |
Example request for Opportunities Report
filters: lang=es, category=woman
report_params: max_items=10, order=desc
{base_url}/analysis/{site_id}/OpportunitiesReport?start_date=0&end_date=20&filters=lang,category,scope&lang=es&category=woman&scope=default&rows=10