Skip to main content
GET
/
product-funnel-metrics
/
metrics
Error
A valid request URL is required to generate request examples
[
  {
    "merchant": "<string>",
    "main_product_id": "<string>",
    "clicks": 123,
    "prev_clicks": 123,
    "add_to_carts": 123,
    "prev_add_to_carts": 123,
    "orders": 123,
    "prev_orders": 123,
    "click_through_rate": 123,
    "add_to_cart_rate": 123,
    "order_through_rate": 123,
    "d_score": 123,
    "prev_d_score": 123,
    "normalized_d_score": 123,
    "normalized_prev_d_score": 123,
    "product": {
      "main_product_id": "<string>",
      "title": "<string>",
      "handle": "<string>",
      "images": [
        {
          "id": "<string>",
          "url": "<string>",
          "width": 123,
          "height": 123,
          "alt": "<string>"
        }
      ],
      "tags": [
        "<string>"
      ],
      "price": 123,
      "in_stock": true,
      "quantity": 123,
      "badges": [
        {
          "type": "on_sale",
          "sale_percentage": 123
        }
      ],
      "n_sold_current_period": 123,
      "n_sold_last_7_days": 123,
      "clicks_current_period": 123,
      "skus": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "published_at": "2023-11-07T05:31:56Z",
      "variants": [
        {
          "id": "<string>",
          "image_url": "<string>",
          "selected_options": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ]
        }
      ]
    },
    "collections": [
      {
        "collection_id": "<string>",
        "position": 123,
        "title": "<string>",
        "n_products": 123,
        "image_urls": [
          "<string>"
        ],
        "product_images": [
          "<string>"
        ]
      }
    ]
  }
]
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

from_date
string<date>
required
to_date
string<date>
required
offset
integer
default:0
order
enum<string>
default:DESC
Available options:
DESC,
ASC
order_by
enum<string>
default:d_score
Available options:
d_score,
clicks,
add_to_carts,
orders
page_size
integer
default:100
merchant_id
string
required

Response

Successful Response

merchant
string
required
main_product_id
string
required
clicks
integer
required
prev_clicks
integer
required
add_to_carts
integer
required
prev_add_to_carts
integer
required
orders
integer
required
prev_orders
integer
required
click_through_rate
number
required
add_to_cart_rate
number
required
order_through_rate
number
required
d_score
number
required
prev_d_score
number
required
normalized_d_score
number
required
normalized_prev_d_score
number
required
product
LiteProductDto · object
required
collections
CollectionInfo · object[]
required