Click statistic by calling api

Description

Api sử dụng để lấy ra thông tin thống kê hành vi người dùng access vào các sản phẩm(item)

Main api

  • /api/{api_name}?typeId={type_id}&objectId={object_id}&siteId={site_id}&year={year}&month={month}&day={day}&hour={hour}&minute={minute}

Parameters

api_name
  • Description: Tên api

  • Type: String

  • Required: Yes

  • Valid:
    • “hours” Lấy thống kê trong 2h vừa qua, kể từ thời điểm muốn lấy mẫu
    • “day” Lấy thống kê trong ngày hôm nay, kể từ thời điểm muốn lấy mẫu tới 0h
    • “month” Lấy thống kê trong tháng vừa quả, kể từ ngày hiện tại muốn lấy mẫu tới ngày 01 đầu tháng
type_id
  • Description: kiểu biểu đồ
  • Type: String
  • Required: Yes
  • Valid: “item”, “category”
object_id
  • Description: Định danh đối tượng muốn lấy phụ thuộc vào trường type_id
  • Type: String
  • Required: Yes
site_id
  • Description: Định danh Id của website
  • Type: String
  • Required: Yes
year
  • Description: Định nghĩa tham số thời gian ‘năm’ muốn lấy dữ liệu
  • Type: String
  • Required: No. Nếu ko cung cấp thì hệ thống sẽ lấy tham số thời gian ‘năm’ của hệ thống
month
  • Description: Định nghĩa tham số thời gian ‘tháng’ muốn lấy dữ liệu
  • Type: String
  • Required: No. Nếu ko cung cấp thì hệ thống sẽ lấy tham số thời gian ‘tháng’ của hệ thống
day
  • Description: Định nghĩa tham số thời gian ‘ngày’ muốn lấy dữ liệu
  • Type: String
  • Required: No. Nếu ko cung cấp thì hệ thống sẽ lấy tham số thời gian ‘ngày’ của hệ thống
hour
  • Description: Định nghĩa tham số thời gian ‘giờ’ muốn lấy dữ liệu
  • Type: String
  • Required: No. Nếu ko cung cấp thì hệ thống sẽ lấy tham số thời gian ‘giờ’ của hệ thống
minute
  • Description: Định nghĩa tham số thời gian ‘phút’ muốn lấy dữ liệu
  • Type: String
  • Required: No. Nếu ko cung cấp thì hệ thống sẽ lấy tham số thời gian ‘phút’ của hệ thống

Response

JSon object

itemId
  • Description: Định danh đối tượng lấy thống kê
  • Type: String
siteId
  • Description: Định danh website lấy thống kê
  • Type: String
data
  • Description: Dữ liệu trả về dưới dạng json
  • Type: String

Example

/api/hours?typeId=category&objectId=gia-dung&siteId=enbac.com&year=2014&month=7&day=3&hour=16&minute=5

Range api

API cung cấp dữ liệu trong một khoảng thời gian động. Đơn vị để lấy dữ liệu là ngày. Áp dụng cho cả item lẫn category

  • /api/rangeDay?typeId={type_id}&objectId={object_id}&siteId={site_id}&fromYear={from_year}&fromMonth={from_month}&fromDay={from_day}&toYear={to_year}&toMonth={to_month}&toDay={to_day}

Parameters

type_id
  • Description: kiểu biểu đồ
  • Type: String
  • Required: Yes
  • Valid: “item”, “category”
object_id
  • Description: Định danh đối tượng muốn lấy phụ thuộc vào trường type_id
  • Type: String
  • Required: Yes
site_id
  • Description: Định danh Id của website
  • Type: String
  • Required: Yes
from_year
  • Description: Định nghĩa tham số thời gian ‘năm’ bắt đầu muốn lấy dữ liệu
  • Type: String
  • Required: No. Nếu ko cung cấp thì hệ thống sẽ lấy tham số thời gian ‘năm’ của hệ thống
from_month
  • Description: Định nghĩa tham số thời gian ‘tháng’ bắt đầu muốn lấy dữ liệu
  • Type: String
  • Required: No. Nếu ko cung cấp thì hệ thống sẽ lấy tham số thời gian ‘tháng’ của hệ thống
from_day
  • Description: Định nghĩa tham số thời gian ‘ngày’ bắt đầu muốn lấy dữ liệu
  • Type: String
  • Required: No. Nếu ko cung cấp thì hệ thống sẽ lấy tham số thời gian ‘ngày’ của hệ thống
to_year
  • Description: Định nghĩa tham số thời gian ‘năm’ kết thúc muốn lấy dữ liệu
  • Type: String
  • Required: No. Nếu ko cung cấp thì hệ thống sẽ lấy tham số thời gian ‘năm’ của hệ thống
to_month
  • Description: Định nghĩa tham số thời gian ‘tháng’ kết thúc muốn lấy dữ liệu
  • Type: String
  • Required: No. Nếu ko cung cấp thì hệ thống sẽ lấy tham số thời gian ‘tháng’ của hệ thống
to_day
  • Description: Định nghĩa tham số thời gian ‘ngày’ kết thúc muốn lấy dữ liệu
  • Type: String
  • Required: No. Nếu ko cung cấp thì hệ thống sẽ lấy tham số thời gian ‘ngày’ của hệ thống

Response

JSon object TBD

Example

/api/rangeDay?typeId=item&objectId=2036867&siteId=enbac.com&fromYear=2014&fromMonth=6&fromDay=2&toYear=2014&toMonth=8&toDay=20 /api/rangeDay?typeId=category&objectId=51&siteId=enbac.com&fromYear=2014&fromMonth=6&fromDay=2&toYear=2014&toMonth=8&toDay=20

Biểu đồ cho chủ shop

Biểu đồ tổng hợp trong ngày, theo danh sách item

  • /api/day?typeId=itemGroup&objectId={object_id_list}&siteId={site_id}&year={year}&month={month}&day={day}&hour={hour}&minute={minute}

Parameters

object_id_list
  • Description: Danh sách các item_id của chủ shop
  • Type: String
  • Required: Yes

site_id, year, month, day, hour, minute Tham khảo Main api

Response

JSon object TBD

Example

/api/day?typeId=itemGroup&objectId=23813,23814&siteId=enbac.com&year=2014&month=07&day=05&hour=12&minute=2

Biểu đồ gộp các item và tổng click/impression cho từng item trong ngày

Biểu đồ tổng hợp trong ngày,

  • /api/day?typeId={type_id}&objectId={object_id_list}&siteId={site_id}&year={year}&month={month}&day={day}

Parameters

type_id
  • Description: Kiểu dữ liệu muốn về

  • Type: String

  • Required: Yes

  • Valid:
    • itemSum: Dữ liệu trả về là danh sách số liệu cho các item, với mỗi item là số click/impresion trong ngày tương ứng
    • itemGroup: Dữ liệu trả về là biểu đồ thống kê tổng số click/impression của các item theo từng giờ của ngày tương ứng
object_id_list
  • Description: Danh sách các item_id cần thống kê
  • Type: String
  • Required: Yes

site_id, year, month, day Tham khảo Main api

Response

JSon object TBD

Example

/api/day?typeId=itemSum&objectId=2044518,1282510&siteId=enbac.com&year=2014&month=07&day=05

Biểu đồ thống kê tổng item được focus( select từ ít nhất một lần) tương ứng với một site trong một tuần gần đây nhất

  • /api/week?typeId=itemCount&siteId={site_id}&year={year}&month={month}&day={day}

Parameters

site_id, year, month, day Tham khảo Main api

Response

JSon object TBD

Example

/api/week?typeId=itemCount&siteId=enbac.com&year=2013&month=07&day=16

Danh sách top category có lượng item được focus nhiều nhất trong ngày

  • /api/day?typeId=CategoriesSpecCount&siteId={site_id}&year={year}&month={month}&day={day}&limit={limit}

Parameters

limit
  • Description: Giới hạn số lượng category trả về
  • Type: String of integer
  • Required: Noe, Trong trường hợp ko cung cấp thì hệ thống sẽ lấy mặc định giá trị là 10

site_id, year, month, day Tham khảo Main api

Response

JSon object TBD

Example

/api/day?typeId=CategoriesSpecCount&siteId=enbac.com&year=2014&month=07&day=6&limit=10