A valid request URL is required to generate request examples{
"currency": "<string>",
"kpis": {
"revenue": {
"value": 123,
"prev_value": 123
},
"units": {
"value": 123,
"prev_value": 123
},
"conversion": {
"value": 123,
"prev_value": 123
},
"plp_views": {
"value": 123,
"prev_value": 123
},
"plp_clicks": {
"value": 123,
"prev_value": 123
},
"add_to_carts": {
"value": 123,
"prev_value": 123
},
"score": {
"value": 123,
"prev_value": 123
},
"position": {
"value": 123,
"prev_value": 123
}
},
"series": {
"dates": [
"<string>"
],
"revenue": [
123
],
"units": [
123
],
"add_to_carts": [
123
],
"position": [
123
],
"position_by_collection": {},
"score": [
123
],
"plp_views": [
123
],
"plp_views_by_collection": {},
"plp_clicks": [
123
],
"plp_clicks_by_collection": {}
},
"collections": [
{
"collection_id": "<string>",
"name": "<string>",
"image_url": "<string>",
"position": 123,
"n_products": 123,
"clicks": 123,
"views": 123,
"ctr": 123,
"pinned": true,
"live": true
}
],
"revenue_rank": {
"rank": 123,
"products": 123,
"beats": 123,
"buckets": [
123
],
"product_bucket": 123,
"bucket_edges": [
123
],
"daily": [
123
]
},
"partial_metrics": {},
"score_reference": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}One product's sales and grid performance over a date range
Revenue, units, conversion, grid views/clicks, add-to-carts and the product score for [from_date, to_date], each with the previous period’s value; daily series; the collections the product sits in with its position and clicks; and its revenue rank. Read-only. At most 365 days. Amounts are in the shop currency.
A valid request URL is required to generate request examples{
"currency": "<string>",
"kpis": {
"revenue": {
"value": 123,
"prev_value": 123
},
"units": {
"value": 123,
"prev_value": 123
},
"conversion": {
"value": 123,
"prev_value": 123
},
"plp_views": {
"value": 123,
"prev_value": 123
},
"plp_clicks": {
"value": 123,
"prev_value": 123
},
"add_to_carts": {
"value": 123,
"prev_value": 123
},
"score": {
"value": 123,
"prev_value": 123
},
"position": {
"value": 123,
"prev_value": 123
}
},
"series": {
"dates": [
"<string>"
],
"revenue": [
123
],
"units": [
123
],
"add_to_carts": [
123
],
"position": [
123
],
"position_by_collection": {},
"score": [
123
],
"plp_views": [
123
],
"plp_views_by_collection": {},
"plp_clicks": [
123
],
"plp_clicks_by_collection": {}
},
"collections": [
{
"collection_id": "<string>",
"name": "<string>",
"image_url": "<string>",
"position": 123,
"n_products": 123,
"clicks": 123,
"views": 123,
"ctr": 123,
"pinned": true,
"live": true
}
],
"revenue_rank": {
"rank": 123,
"products": 123,
"beats": 123,
"buckets": [
123
],
"product_bucket": 123,
"bucket_edges": [
123
],
"daily": [
123
]
},
"partial_metrics": {},
"score_reference": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.
Path Parameters
Shopify product id (numeric string).
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
First day, inclusive.
Last day, inclusive.
A positive value replaces the catalogue's top score as the score scale (used when fetching a comparison period).
Restrict to one market (or market group); omit for all markets.
Response
The analytics.
Shop currency every amount is in.
Show child attributes
Show child attributes
Daily values aligned with dates.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Where the product's revenue ranks in the catalogue.
Show child attributes
Show child attributes
Metric name → why it is incomplete (e.g. a data source was unavailable).
Show child attributes
Show child attributes
Was this page helpful?