Skip to content

Read product traffic stats

Reads a product's views, visitors, checkouts started and orders over a period, by channel.

Needs the product:read scope.

Call

  • Tool: product_traffic_stats
  • Scope: product:read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
product object Yes
from string No
to string No
bucket "day" or "week" or "month" No
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "from": {
      "type": "string",
      "format": "date"
    },
    "to": {
      "type": "string",
      "format": "date"
    },
    "bucket": {
      "type": "string",
      "enum": [
        "day",
        "week",
        "month"
      ]
    }
  },
  "required": [
    "product"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
time_zone string Yes
from string Yes
to string Yes
previous_range object Yes
bucket string Yes
rolled_through string or null Yes The latest store-local day the totals are rolled up through, null before the first; later days count nothing yet.
covered_from string or null Yes The earliest store-local day the totals hold, null before the first; earlier days count nothing.
product_views object Yes Products shown to customers; the merchant’s own visits and other callers who are no customer are left out.
checkouts_started object Yes Carts started, each counted for the product of its first line alone.
orders object Yes Orders through the store’s own checkout (never a renewal, nor one recorded through the API or by hand) on the days the totals cover, a test purchase included.
rates object Yes Rates over the steps above, which count apart, so one may reach past 1.
estimated boolean Yes Views or carts counted from sampled data, so the figures are estimates.
visitors object Yes The product’s daily unique visitors, summed over the days.
by_channel array of object Yes The product’s views and visitors by the channel they came through.
series array of object Yes

The answer’s full shape is on its API reference page.

Errors

A refused call is a tool error. Its structuredContent holds a code and its context, except for client-fault. This tool may answer:

  • invalid: an argument is malformed; context.path names it.
  • invalid at ["store"]: store is missing while the connection reaches more than one store, or names a store it doesn’t reach.
  • not_found: nothing matches a reference given.
  • not_permitted: this connection may not make this call. When context.reason is limit, too many calls: retry_after says when to try again.
  • internal or unavailable: the call failed inside Sherpo. A read marked transient may be retried.
  • client-fault: the server failed around the call. reached_core says whether it reached Sherpo; the call may be made again.
  • HTTP 403 with insufficient_scope: the connection lacks the scope this tool needs.
  • HTTP 401 with invalid_token: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.

Any other code may come back too, such as a conflict when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See Errors for every code and its context.

Type to search…

↑↓ navigate↵ selectEsc close