Gallery activity overview for a single event.
| Property | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| averageOrderAmount read-only |
Revenue divided by order count. |
||||||||||
| cartsSeries read-only |
Currently-open carts bucketed by the day each cart was created (brand timezone). Same date window as ordersSeries for 7/30, ending today. For
|
||||||||||
| currencyCode read-only |
Brand currency code for the money fields. |
||||||||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||||||||
| openCartTotal read-only |
Sum of open cart grand totals for this gallery, as a decimal string. |
||||||||||
| orderCount read-only |
Orders for this gallery, excluding canceled and deleted orders. |
||||||||||
| ordersSeries read-only |
Orders bucketed by day (brand timezone). For 7/30, zero-filled across that window, which ends today. For
|
||||||||||
| range read-only |
Order series window that was applied. |
||||||||||
| revenue read-only |
Sum of order grand totals for this gallery, as a decimal string. |
||||||||||
| topPhotos read-only |
|
||||||||||
| type |
The type of object represented. |
||||||||||
| visitorCounts read-only |
|
||||||||||
| visitorTotal read-only |
Number of visitors recorded for this gallery. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "Gallery activity overview for a single event.",
"properties": {
"averageOrderAmount": {
"description": "Revenue divided by order count. `0.00` when there are no orders.",
"readOnly": true,
"type": "string"
},
"cartsSeries": {
"description": "Currently-open carts bucketed by the day each cart was created (brand timezone). Same date window as ordersSeries for 7/30, ending today. For `all`, zero-filled from the earliest open-cart creation day through the latest, independent of the orders window, with no empty tail through today. A same-day spike is padded to at least 30 days ending on that last cart day. With no open carts, the series is the last 30 days through today. Carts created before a 7/30 window are bucketed onto the first day so the series aligns with openCartTotal.\n",
"items": {
"properties": {
"cartCount": {
"type": "integer"
},
"date": {
"format": "date",
"type": "string"
},
"total": {
"description": "Open cart grand totals for carts created on this day, as a decimal string.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"currencyCode": {
"description": "Brand currency code for the money fields.",
"readOnly": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"openCartTotal": {
"description": "Sum of open cart grand totals for this gallery, as a decimal string.",
"readOnly": true,
"type": "string"
},
"orderCount": {
"description": "Orders for this gallery, excluding canceled and deleted orders.",
"readOnly": true,
"type": "integer"
},
"ordersSeries": {
"description": "Orders bucketed by day (brand timezone). For 7/30, zero-filled across that window, which ends today. For `all`, zero-filled from the first order day through the last order day, with no empty tail through today. A same-day spike is padded to at least 30 days ending on that last order day. With no orders, the series is the last 30 days through today.\n",
"items": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"orderCount": {
"type": "integer"
},
"revenue": {
"description": "Order grand totals for this day, as a decimal string.",
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"range": {
"description": "Order series window that was applied.",
"enum": [
"7",
"30",
"all"
],
"readOnly": true,
"type": "string"
},
"revenue": {
"description": "Sum of order grand totals for this gallery, as a decimal string.",
"readOnly": true,
"type": "string"
},
"topPhotos": {
"properties": {
"downloaded": {
"items": {
"properties": {
"count": {
"type": "integer"
},
"displayUrl": {
"properties": {
"extraLarge2": {
"type": "string"
},
"extraLarge3": {
"type": "string"
},
"large": {
"type": "string"
},
"medium": {
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"favorited": {
"items": {
"properties": {
"count": {
"type": "integer"
},
"displayUrl": {
"properties": {
"extraLarge2": {
"type": "string"
},
"extraLarge3": {
"type": "string"
},
"large": {
"type": "string"
},
"medium": {
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"readOnly": true,
"type": "object"
},
"type": {
"description": "The type of object represented.",
"enum": [
"event-activity-summary"
],
"type": "string"
},
"visitorCounts": {
"properties": {
"cartItems": {
"type": "integer"
},
"favorites": {
"type": "integer"
},
"noOrders": {
"type": "integer"
},
"orders": {
"type": "integer"
}
},
"readOnly": true,
"type": "object"
},
"visitorTotal": {
"description": "Number of visitors recorded for this gallery.",
"readOnly": true,
"type": "integer"
}
},
"title": "Event Activity Summary",
"type": "object"
}