Skip to main content
GET
/
api
/
v1
/
merchants
/
{merchant_id}
/
analytics
/
overview
Get Analytics Overview Endpoint
curl --request GET \
  --url https://api.example.com/api/v1/merchants/{merchant_id}/analytics/overview \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/api/v1/merchants/{merchant_id}/analytics/overview"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/merchants/{merchant_id}/analytics/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/merchants/{merchant_id}/analytics/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/v1/merchants/{merchant_id}/analytics/overview"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/merchants/{merchant_id}/analytics/overview")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/merchants/{merchant_id}/analytics/overview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "totals": {
    "period": {
      "start": "2023-12-25",
      "end": "2023-12-25"
    },
    "total_revenue": {
      "value": 0,
      "currency": "",
      "delta_pct": 123
    },
    "total_views": {
      "value": 0,
      "delta_pct": 123
    },
    "total_clicks": {
      "value": 0,
      "delta_pct": 123
    },
    "avg_ctr": {
      "value": 0,
      "delta_pts": 123
    },
    "units_sold": {
      "value": 0,
      "delta_pct": 123
    },
    "avg_str": {
      "value": 0,
      "delta_pts": 123
    },
    "add_to_carts": {
      "value": 0
    },
    "dead_stock": {
      "value": 0
    },
    "avg_stock_coverage_days": 123,
    "rpm": {
      "value": 0,
      "currency": ""
    },
    "velocity": {
      "value": 0
    },
    "auto_lift": {
      "pinned_ctr": 0,
      "auto_ctr": 0
    },
    "top_product": {
      "main_product_id": "<string>",
      "title": "<string>",
      "image_url": "<string>",
      "revenue": 123
    }
  },
  "top_collections": [],
  "declining_collections": [],
  "pinned_vs_auto": {
    "healthy": 0,
    "warning": 0,
    "critical": 0,
    "no_pins": 0
  },
  "collections_considered": 0
}
{
"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.

Path Parameters

merchant_id
string
required

Query Parameters

locale
string | null

Response

Successful Response

Merchant-wide analytics for the hub page.

totals reuses the collection summary aggregate over the entire catalog (every product with metrics, pinned split empty — auto_lift is meaningless there and should be ignored). collections_considered is how many collections the rollups cover (capped at _MAX_COLLECTIONS).

totals
CollectionMetricsSummary · object
required
top_collections
OverviewCollection · object[]
declining_collections
OverviewCollection · object[]
pinned_vs_auto
PinnedVsAutoRollup · object

How many collections fall into each pinned-vs-auto health bucket (same thresholds as the collections table's status column). no_pins counts collections with nothing pinned (or no data), where there is nothing to compare.

collections_considered
integer
default:0