Skip to main content

Send Website Events via RESTful API

This article explains how to send website events to Aqurate via RESTful API

Website Events (website_events)

⚠️ Please note that page_type and event have specific valid entries.

Field name

Details

Type

Required

timestamp

The time and date of the observation. The format is ISO 8601 in UTC.

Timestamp

Yes

session_id

The unique identifier of the session.

String

Yes

cookie_id

The unique identifier of the cookie.

String

Yes

user_id

The unique identifier of the user.

String

product_id

The unique identifier of the item.

String

Yes

page_type

(to be paired with the event field)

The type of page on which the event happens. Valid entries: "detail_page", "checkout", null.

String

Yes

event

(to be paired with the page_type field)

The type of event. Please check the example input for valid entries. Valid entries: "page_view", "add_to_cart", "add_to_wishlist", "purchase", "link_click".

String

Yes

The following combinations of page_type - event are accepted:

  • "detail_page" - "page_view"

  • "detail_page" - "add_to_wishlist"

  • "detail_page" - "add_to_cart"

  • "checkout" - "add_to_wishlist"

  • "checkout" - "add_to_cart"

  • "checkout" - "purchase"

  • null - "link_click"

Did this answer your question?