Commerce Reporting
Overview
The Stackla Tracking Pixel offers a series of API endpoints which can be leveraged by customers to plugin Commerce Reporting into third party Reporting, Analytics and Business Intelligence tools.
These APIs are available for all Customers who have access to the Stackla REST API within their tier and who have had the Tracking Pixel enabled.
Details for each of the respective API endpoints are listed below.
Event Summaries Report
Lists all high level details for one or more Tracking Pixel events on a specific Stack for the defined time period.
Resource URL
https://api.stackla.com/api/stpreportingevents
Resource Details
Request Parameters
Response Schema
[
{
"event": "string",
"total_unique_products": "string",
"total_unique_sessions": "string",
"total_number_of_events": "string",
"total_value": {}
}
]
Total Order Values Report
Lists Total Order Values for all Orders that have been processed and recorded via the Stackla Tracking Pixel.
Resource URL
https://api.stackla.com/api/stpreportingordervalues
Resource Details
Request Parameters
Field | Type | Value | Definition | widget_id | string | Comma Separated list of Widgets |
---|---|---|---|
tile_id | string | Comma Separated list of UGC Tiles | |
aggregated_at_from | string | From UNIX timestamp. If there is no ‘aggregate_at_from’ parameter API will fallback to last 30 days | |
aggregated_at_to | string | To UNIX timestamp. If there is no ‘aggregate_at_to’ parameter API will fallback to current date |
Response Schema
[
{
"total_unique_cart_sessions": "string",
"total_cart_events": "string",
"total_cart_value": {}
}
]
Top Performers Report
Lists the Top Performing Products, Widgets or Tiles for a particular Stack over a set time period.
Resource URL
https://api.stackla.com/api/stpreportingperformers
Resource Details
Request Parameters
Field | Type | Value | Definition |
---|---|---|---|
type | string | product widget tile |
Required field. |
id | string | Entity (type) ID | |
aggregated_at_from | string | From UNIX timestamp. If there is no ‘aggregate_at_from’ parameter API will fallback to last 30 days | |
aggregated_at_to | string | To UNIX timestamp. If there is no ‘aggregate_at_to’ parameter API will fallback to current date |
Response Schema
[
{
"total_unique_sessions": "string",
"total_events": "string",
"total_value": {}
}
]
Transactions Report
Lists all recorded transactions by the Tracking Pixel for an individual Stack. Results are consolidated per hour.
Resource URL
https://api.stackla.com/api/stpreportingtransactions
Resource Details
Request Parameters
Response Schema
[
{
"event": "string",
"total_unique_products": "string",
"unique_sessions": "string",
"aggregate_value": "string",
"total_events": 0,
"product_id": 0,
"widget_id": "string",
"tile_id": "string",
"currency": "string"
}
]