Needs the read scope.
Pages its answer: pass the cursor back for the next page, at most 100 items a page.
Filters: type (eq, in), symbol (eq, in), occurred_at (gte, lte).
Sorts: occurred.
Searches symbol, note, name. An empty page with a cursor means nothing so far: only a null cursor ends a search. A searched page past the count budget comes back without its total and facets, which never means zero.
Call
- Tool:
list_portfolio_events - 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": {
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"eq": {
"type": "string"
},
"in": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"maxItems": 50
}
},
"minProperties": 1,
"additionalProperties": false
}
]
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"eq": {
"type": "string"
},
"in": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"maxItems": 50
}
},
"minProperties": 1,
"additionalProperties": false
}
]
},
"occurred_at": {
"type": "object",
"properties": {
"gte": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"
},
"lte": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"
}
},
"minProperties": 1,
"additionalProperties": false
}
},
"additionalProperties": false
},
"sort": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"occurred"
]
},
"direction": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"additionalProperties": false
},
"search": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"cursor": {
"type": "string",
"maxLength": 8192
},
"count": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"required": [
"product"
],
"additionalProperties": false
}Answer
| Name | Type | Required | Description |
|---|---|---|---|
total |
number |
No | |
items |
array of object |
Yes | |
cursor |
string or null |
Yes |
The answer’s full shape is on its API reference page.