Skip to content

List portfolio snapshots

Pages a portfolio's daily snapshots.

Needs the read scope.

Pages its answer: pass the cursor back for the next page, at most 400 items a page.

Filters: date (gte, lte).

Sorts: date.

Call

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

Arguments

Name Type Required Description
product object Yes
preview string No A token a seller made for the product’s page or one of its entries, which opens an unpublished product’s portfolio, gated as ever.
query object No
{
  "type": "object",
  "properties": {
    "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
        }
      ]
    },
    "preview": {
      "description": "A token a seller made for the product's page or one of its entries, which opens an unpublished product's portfolio, gated as ever.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "query": {
      "type": "object",
      "properties": {
        "filter": {
          "type": "object",
          "properties": {
            "date": {
              "type": "object",
              "properties": {
                "gte": {
                  "type": "string"
                },
                "lte": {
                  "type": "string"
                }
              },
              "minProperties": 1,
              "additionalProperties": false
            }
          },
          "additionalProperties": false
        },
        "sort": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "enum": [
                "date"
              ]
            },
            "direction": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ]
            }
          },
          "additionalProperties": false
        },
        "limit": {
          "type": "integer",
          "minimum": 1,
          "maximum": 400
        },
        "cursor": {
          "type": "string",
          "maxLength": 8192
        },
        "count": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "product"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
items array of object Yes
cursor string or null Yes
total number No
facets object No

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

Type to search…

↑↓ navigate↵ selectEsc close