Retrieve ranked ecommerce products

get

https://{youraccountname}.api-us1.com/api/3/ai/ecom/productRankings

Products ranked by revenue, units sold or order frequency over a date window, counting only completed and recovered orders (abandoned and pending carts are excluded), aggregated across orders by the product external id within each connection, so the same product sold through two connections is two entries. Page through the ranking with limit and offset; total_products_found is the size of the whole ranking, not of the page.

Query Params

startDate

date

First day of the window, as YYYY-MM-DD, counted from 00:00:00. Send it together with endDate or not at all. When both are omitted the window is the last 30 days.

endDate

date

Last day of the window, as YYYY-MM-DD, counted through 23:59:59. Send it together with startDate or not at all, and never before startDate. When both are omitted the window ends today.

connectionId

string

Restrict the result to one ecommerce connection (store) by its id, as listed by GET /connections. A positive integer. When omitted the result covers every connection.

rankBy

string

enum

Defaults to revenue

What to rank by: revenue, quantity (units sold) or frequency (number of orders containing the product). Defaults to revenue.

Allowed:

limit

integer

1 to 100

Defaults to 10

Maximum products to return, from 1 to 100. Defaults to 10.

offset

integer

≥ 0

Defaults to 0

Products to skip before the first returned, for paging. Defaults to 0.

Responses

200One page of the product ranking.

422A query parameter failed validation: a date that is not YYYY-MM-DD, only one of startDate and endDate, an endDate before startDate, or a connectionId that is not a positive integer, a rankBy other than revenue, quantity or frequency, a limit outside 1 to 100, or a negative offset.

500The summary could not be computed.