@artsy/cohesion
Version:
Analytics schema
981 lines (979 loc) • 29.9 kB
TypeScript
import { ContextModule } from "../Values/ContextModule";
import { EntityModuleType } from "../Values/EntityModuleType";
import { OwnerType, PageOwnerType } from "../Values/OwnerType";
import { ActionType } from ".";
/**
* Schemas describing Click events
* @packageDocumentation
*/
/**
* A user clicks a grouping of entities on web
*
* Events are separated by entity type
*
*/
/**
* User clicks to add new shipping address when entering the orders
* checkout flow.
*
* This schema describes events sent to Segment from [[clickedAddNewShippingAddress]]
*
* @example
* ```
* {
* action: "clickedAddNewShippingAddress",
* context_module: "OrdersShipping",
* context_page_owner_type: "orders-shipping",
* context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b"
* }
* ```
*/
export interface ClickedAddNewShippingAddress {
action: ActionType.clickedAddNewShippingAddress;
context_module: ContextModule;
context_page_owner_type: string;
context_page_owner_id: string;
}
/**
* A fair partner with an upcoming booth clicks on Add Works from CMS Checklist To-Do fair item.
*
* This schema describes events sent to Segment from [[clickedAddWorksToFair]]
*
* @example
* ```
* {
* action: "clickedAddWorksToFair",
* context_module: "toDoList",
* context_page_owner_type: "home",
* destination_page_owner_type: "partner_shows",
* destination_page_owner_id: "603f847842d0c10007a960a8",
* destination_page_owner_slug: "xavier-hufkens-xavier-hufkens-at-art-brussels-2021",
* destination_path: "partner_shows/xavier-hufkens-xavier-hufkens-at-art-brussels-2021/artworks#show-add-artworks-modal"
* }
* ```
*/
export interface ClickedAddWorksToFair {
action: ActionType.clickedAddWorksToFair;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
destination_page_owner_type: PageOwnerType;
destination_page_owner_id: string;
destination_page_owner_slug: string;
destination_path: string;
}
/**
* A user clicks a grouping of articles on web
*
* This schema describes events sent to Segment from [[clickedEntityGroup]]
*
* @example
* ```
* {
* action: "clickedArticleGroup",
* context_module: "relatedArticles",
* context_page_owner_type: "fair",
* context_page_owner_id: "5e726bd22524980012caafb0",
* context_page_owner_slug: "arteba-special-edition",
* destination_page_owner_type: "article",
* destination_page_owner_id: "542f1ccc7261694847410400",
* destination_page_owner_slug: "acaw-acaw-presenter-charwei-tsai",
* type: "thumbnail"
* }
* ```
*/
export interface ClickedArticleGroup extends ClickedEntityGroup {
action: ActionType.clickedArticleGroup;
}
/**
* A user clicks a grouping of artists on web
*
* This schema describes events sent to Segment from [[clickedEntityGroup]]
*
* @example
* ```
* {
* action: "clickedArtistGroup",
* context_module: "trendingArtistsRail",
* context_page_owner_type: "home",
* destination_page_owner_type: "artist",
* destination_page_owner_id: "5359794d1a1e86c3740001f7",
* destination_page_owner_slug: "anthony-hunter",
* horizontal_slide_position: 1,
* type: "thumbnail"
* }
* ```
*/
export interface ClickedArtistGroup extends ClickedEntityGroup {
action: ActionType.clickedArtistGroup;
}
/**
* A user clicks a grouping of artist series on web.
*
* If the series is boosted by the curation team, set curation_boost to true.
*
* This schema describes events sent to Segment from [[clickedEntityGroup]]
*
* @example
* ```
* {
* action: "clickedArtistSeriesGroup",
* context_module: "moreSeriesByThisArtist",
* context_page_owner_type: "artistSeries",
* context_page_owner_id: "5359794d1a1e86c3740001f7",
* context_page_owner_slug: "alex-katz-departure",
* destination_page_owner_type: "artistSeries",
* destination_page_owner_id: "5359794d1a1e86c3740001f7",
* destination_page_owner_slug: "alex-katz-black-dress",
* curation_boost: true,
* horizontal_slide_position: 1,
* type: "thumbnail"
* }
* ```
*/
export interface ClickedArtistSeriesGroup extends ClickedEntityGroup {
action: ActionType.clickedArtistSeriesGroup;
destination_page_owner_type: OwnerType.artistSeries;
}
/**
* A user clicks a grouping of artworks on web. This includes all artwork groupings (i.e. artwork rails), except the main artwork grid on our core merchandising surfaces.
* For our main artwork grids, we use the event [[clickedMainArtworkGrid]].
*
* This schema describes events sent to Segment from [[clickedEntityGroup]]
*
* @example
* ```
* {
* action: "clickedArtworkGroup",
* context_module: "newWorksByArtistsYouFollowRail",
* context_page_owner_type: "home",
* destination_page_owner_type: "artwork",
* destination_page_owner_id: "5e9a7a238483bf000e2c4c5e",
* destination_page_owner_slug: "romain-jacquet-lagreze-makeshift-garden-hong-kong",
* horizontal_slide_position: 1,
* type: "thumbnail"
* }
* ```
*/
export interface ClickedArtworkGroup extends ClickedEntityGroup {
action: ActionType.clickedArtworkGroup;
}
/**
* A user clicks a grouping of auctions on web
*
* This schema describes events sent to Segment from [[clickedEntityGroup]]
*
* @example
* ```
* {
* action: "clickedAuctionGroup",
* context_module: "auctionsRail",
* context_page_owner_type: "home",
* destination_page_owner_type: "sale",
* destination_page_owner_id: "5e95b37a2fdcb20012a0e082",
* destination_page_owner_slug: "forum-auctions-colour-theory-4",
* horizontal_slide_position: 3,
* type: "thumbnail"
* }
* ```
*/
export interface ClickedAuctionGroup extends ClickedEntityGroup {
action: ActionType.clickedAuctionGroup;
}
/**
* A user clicks a grouping of collections on web
*
* This schema describes events sent to Segment from [[clickedEntityGroup]]
*
* @example
* ```
* {
* action: "clickedCollectionGroup",
* context_module: "collectionRail",
* context_page_owner_type: "home",
* destination_page_owner_type: "collection",
* destination_page_owner_slug: "limited-edition-prints-trending-artists",
* horizontal_slide_position: 2,
* type: "thumbnail"
* }
* ```
*/
export interface ClickedCollectionGroup extends ClickedEntityGroup {
action: ActionType.clickedCollectionGroup;
}
/**
* User clicks on Artsy's buyer protection link during their checkout flow.
*
* This schema describes events sent to Segment from [[clickedBuyerProtection]]
*
* @example
* ```
* {
* action: "clickedBuyerProtection",
* context_module: "OrdersShipping",
* context_page_owner_type: "orders-shipping",
* context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b",
* destination_page_owner_type: "articles",
* destination_page_owner_slug: "360048946973-How-does-Artsy-protect-me"
* }
* ```
*/
export interface ClickedBuyerProtection {
action: ActionType.clickedBuyerProtection;
context_module: ContextModule;
context_page_owner_type: string;
context_page_owner_id: string;
destination_page_owner_type: PageOwnerType;
destination_page_owner_slug: string;
}
/**
* User clicks on Change Payment Method on the orders review page.
*
* This schema describes events sent to Segment from [[clickedChangePaymentMethod]]
*
* @example
* ```
* {
* action: "clickedChangePaymentMethod",
* context_module: "OrdersReview",
* context_page_owner_type: "orders-review",
* context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b",
* }
* ```
*/
export interface ClickedChangePaymentMethod {
action: ActionType.clickedChangePaymentMethod;
context_module: ContextModule;
context_page_owner_type: string;
context_page_owner_id: string;
}
/**
* User clicks on Change Shipping Address on the orders review page.
*
* This schema describes events sent to Segment from [[clickedChangeShippingAddress]]
*
* @example
* ```
* {
* action: "clickedChangeShippingAddress",
* context_module: "OrdersReview",
* context_page_owner_type: "orders-review",
* context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b",
* }
* ```
*/
export interface ClickedChangeShippingAddress {
action: ActionType.clickedChangeShippingAddress;
context_module: ContextModule;
context_page_owner_type: string;
context_page_owner_id: string;
}
/**
* User clicks on Change Shipping Method on the orders review page.
*
* This schema describes events sent to Segment from [[clickedChangePaymentMethod]]
*
* @example
* ```
* {
* action: "clickedChangeShippingMethod",
* context_module: "OrdersReview",
* context_page_owner_type: "orders-review",
* context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b",
* }
* ```
*/
export interface ClickedChangeShippingMethod {
action: ActionType.clickedChangeShippingMethod;
context_module: ContextModule;
context_page_owner_type: string;
context_page_owner_id: string;
}
/**
* User selects delivery option (Shipping or Pick Up) when entering the orders
* checkout flow.
*
* This schema describes events sent to Segment from [[clickedDeliveryMethod]]
*
* @example
* ```
* {
* action: "clickedDeliveryMethod",
* context_module: "OrdersShipping",
* context_page_owner_type: "orders-shipping",
* context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b",
* subject: Pick up
* }
* ```
*/
export interface ClickedDeliveryMethod {
action: ActionType.clickedDeliveryMethod;
context_module: ContextModule;
context_page_owner_type: string;
context_page_owner_id: string;
subject: string;
}
/**
* A user clicks a grouping of fairs on web
*
* This schema describes events sent to Segment from [[clickedEntityGroup]]
*
* @example
* ```
* {
* action: "clickedFairGroup",
* context_module: "fairRail",
* context_page_owner_type: "home",
* destination_page_owner_type: "fair",
* destination_page_owner_id: "5e726bd22524980012caafb0",
* destination_page_owner_slug: "arteba-special-edition",
* horizontal_slide_position: 2,
* module_height: "double",
* type: "thumbnail"
* }
* ```
*/
export interface ClickedFairGroup extends ClickedEntityGroup {
action: ActionType.clickedFairGroup;
}
/**
* A user clicks a grouping of galleries on web
*
* This schema describes events sent to Segment from [[clickedEntityGroup]]
*
* @example
* ```
* {
* action: "clickedGalleryGroup",
* context_module: "featuredGalleries",
* context_page_owner_type: "home",
* destination_page_owner_type: "gallery",
* destination_page_owner_id: "5e726bd22524980012caafb0",
* destination_page_owner_slug: "arteba-special-edition",
* horizontal_slide_position: 2,
* module_height: "double",
* type: "thumbnail"
* }
* ```
*/
export interface ClickedGalleryGroup extends ClickedEntityGroup {
action: ActionType.clickedGalleryGroup;
}
/**
* A user clicks a grouping of shows on web
*
* This schema describes events sent to Segment from [[clickedEntityGroup]]
*
* @example
* ```
* {
* action: "clickedShowGroup",
* context_module: "featuredShows",
* context_page_owner_type: "home",
* destination_page_owner_type: "show",
* destination_page_owner_id: "5e726bd22524980012caafb0",
* destination_page_owner_slug: "arteba-special-edition",
* horizontal_slide_position: 2,
* module_height: "double",
* type: "thumbnail"
* }
* ```
*/
export interface ClickedShowGroup extends ClickedEntityGroup {
action: ActionType.clickedShowGroup;
}
/**
* Shared interface for clicked group actions on web
*/
export interface ClickedEntityGroup {
action: ActionType.clickedArticleGroup | ActionType.clickedArtistGroup | ActionType.clickedArtistSeriesGroup | ActionType.clickedArtworkGroup | ActionType.clickedAuctionGroup | ActionType.clickedCollectionGroup | ActionType.clickedFairGroup | ActionType.clickedGalleryGroup | ActionType.clickedMainArtworkGrid | ActionType.clickedShowGroup;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
context_page_owner_slug?: string;
curation_boost?: boolean;
destination_page_owner_type: PageOwnerType;
destination_page_owner_id?: string;
destination_page_owner_slug?: string;
horizontal_slide_position?: number;
type: EntityModuleType;
}
/**
* A user clicks a fair card
*
* This schema describes events sent to Segment from [[ClickedFairCard]]
*
* @example
* ```
* {
* action: "clickedFairCard",
* context_module: "fairCard",
* context_page_owner_type: "show",
* context_page_owner_id: "5df7daac8225960007129b4f",
* context_page_owner_slug: "mccormick-gallery-mccormick-gallery-at-palm-beach-modern-plus-contemporary-2020",
* destination_page_owner_type: "fair",
* destination_page_owner_id: "5df3e3fa485efe0012c37055",
* destination_page_owner_slug: "palm-beach-modern-plus-contemporary-2020",
* type: "thumbnail"
* }
* ```
*/
export interface ClickedFairCard {
action: ActionType.clickedFairCard;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
context_page_owner_slug?: string;
destination_page_owner_type: PageOwnerType;
destination_page_owner_id: string;
destination_page_owner_slug: string;
type: "thumbnail";
}
/**
* A user clicks on an artwork in the main artwork grid, which is the main product feed we can find on our core merchandising surfaces.
* Currently, this event only fires on our new artwork grids on the following pages: Collect, Collection, Artist works-for-sale, and Search Results.
* Note: This event is separate from [[clickedArtworkGroup]] because it is an important and frequent event. Separating it out will make it easier for analysts to access.
*
* This schema describes events sent to Segment from [[clickedMainArtworkGrid]]
*
* @example
* ```
* {
* action: "clickedMainArtworkGrid",
* context_module: "artworkGrid",
* context_page_owner_type: "artist",
* context_page_owner_id: "4d8b926a4eb68a1b2c0000ae",
* context_page_owner_slug: "damien-hirst",
* destination_page_owner_type: "artwork",
* destination_page_owner_id: "53188b0d8b3b8192bb0005ae",
* destination_page_owner_slug: "damien-hirst-anatomy-of-an-angel",
* type: "thumbnail"
* }
* ```
*/
export interface ClickedMainArtworkGrid {
action: ActionType.clickedMainArtworkGrid;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
context_page_owner_slug?: string;
destination_page_owner_type: PageOwnerType;
destination_page_owner_id: string;
destination_page_owner_slug: string;
type: "thumbnail";
position?: number;
sort?: string;
}
/**
* A user clicks on a navigation tab on web.
*
* This schema describes events sent to Segment from [[clickedMainArtworkGrid]]
*
* @example
* ```
* {
* action: "clickedNavigationTab",
* context_module: "exhibitorsTab",
* context_page_owner_type: "fair",
* context_page_owner_id: "5e726bd22524980012caafb0",
* context_page_owner_slug: "arteba-special-edition",
* destination_path: "/arteba-special-edition/artworks",
* subject: "Artworks"
* }
* ```
*/
export interface ClickedNavigationTab {
action: ActionType.clickedNavigationTab;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
context_page_owner_slug?: string;
destination_path: string;
subject: string;
}
/**
* User clicks in one of the price options on the offer page
*
* This schema describes events sent to Segment from [[clickedOfferOption]]
*
* @example
* ```
* {
* action: "clickedOfferOption",
* flow: "Make Offer",
* context_page_owner_type: "orders-offer",
* context_page_owner_id: "dd0cbbb5-300b-4c49-92a1-fed55b077fa9",
* order_id: "407dd09f-4afd-4aad-a6cc-1d6704dc2b11",
* offer: "20% below the list price",
* amount: 2000,
* currency: "USD"
* }
* ```
*/
export interface ClickedOfferOption {
action: ActionType.clickedOfferOption;
flow: string;
context_page_owner_type: string;
context_page_owner_id: string;
order_id: string;
offer: string;
amount: number;
currency: string;
}
/**
* A Partner clicks on Artwork weight (without packaging) bar in the artwork edit page
* in CMS.
*
* This schema describes events sent to Segment from [[clickedOnArtworkShippingWeight]]
*
* @example
* ```
* {
* action: "clickedOnArtworkShippingWeight",
* context_module: "voltArtworksEdit",
* context_page_owner_type: "artwork",
* context_page_owner_id: "60de173a47476c000fd5c4cc"
* }
* ```
*/
export interface ClickedOnArtworkShippingWeight {
action: ActionType.clickedOnArtworkShippingWeight;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
}
/**
* A Partner clicks on Artwork weight dropdown to choose weight metric in the artwork edit page
* in the CMS.
*
* This schema describes events sent to Segment from [[clickedOnArtworkShippingUnitsDropdown]]
*
* @example
* ```
* {
* action: "clickedOnArtworkShippingUnitsDropdown",
* context_module: "voltArtworksEdit",
* context_page_owner_type: "artwork",
* context_page_owner_id: "60de173a47476c000fd5c4cc"
* subject: "lb"
* }
* ```
*/
export interface ClickedOnArtworkShippingUnitsDropdown {
action: ActionType.clickedOnArtworkShippingUnitsDropdown;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
subject?: string;
}
/**
* A Partner clicks on framed measurements fields in the CMS artworks edit page.
*
* This schema describes events sent to Segment from [[clickedOnFramedMeasurements]]
*
* @example
* ```
* {
* action: "clickedOnFramedMeasurements",
* context_module: "voltArtworksEdit",
* context_page_owner_type: "artwork",
* context_page_owner_id: "60de173a47476c000fd5c4cc"
* }
* ```
*/
export interface ClickedOnFramedMeasurements {
action: ActionType.clickedOnFramedMeasurements;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
}
/**
* A Partner clicks on Artwork frame dimension dropdowns to choose either frame dimensions (H, W, D) or diameter
* and/or frame metric in the artwork edit page in the CMS.
*
* This schema describes events sent to Segment from [[clickedOnFramedMeasurementsDropdown]]
*
* @example
* ```
* {
* action: "clickedOnFramedMeasurementsDropdown",
* context_module: "voltArtworksEdit",
* context_page_owner_type: "artwork",
* context_page_owner_id: "60de173a47476c000fd5c4cc"
* }
* ```
*/
export interface ClickedOnFramedMeasurementsDropdown {
action: ActionType.clickedOnFramedMeasurementsDropdown;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
}
/**
* User clicks on submit order on the orders review page.
*
* This schema describes events sent to Segment from [[clickedOnSubmitOrder]]
*
* @example
* ```
* {
* action: "clickedOnSubmitOrder",
* context_module: "OrdersReview",
* context_page_owner_type: "orders-review",
* context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b",
* }
* ```
*/
export interface ClickedOnSubmitOrder {
action: ActionType.clickedOnSubmitOrder;
context_module: ContextModule;
context_page_owner_type: string;
context_page_owner_id: string;
}
/**
* A user clicks a partner card
*
* This schema describes events sent to Segment from [[ClickedPartnerCard]]
*
* @example
* ```
* {
* action: "clickedPartnerCard",
* context_module: "partnerCard",
* context_page_owner_type: "show",
* context_page_owner_id: "5bb539507a931b299b243dd5",
* context_page_owner_slug: "mccormick-gallery-vidvuds-zviedris-old-cities-and-ancient-walls",
* destination_page_owner_type: "partner",
* destination_page_owner_id: "4e2ed4c42ccd3c000100924f",
* destination_page_owner_slug: "mccormick-gallery",
* type: "thumbnail"
* }
* ```
*/
export interface ClickedPartnerCard {
action: ActionType.clickedPartnerCard;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
context_page_owner_slug?: string;
destination_page_owner_type: PageOwnerType;
destination_page_owner_id: string;
destination_page_owner_slug: string;
type: "thumbnail";
}
/**
* User selects existing shipping address when entering the orders
* checkout flow.
*
* This schema describes events sent to Segment from [[clickedShippingAddress]]
*
* @example
* ```
* {
* action: "clickedShippingAddress",
* context_module: "OrdersShipping",
* context_page_owner_type: "orders-shipping",
* context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b"
* }
* ```
*/
export interface ClickedShippingAddress {
action: ActionType.clickedShippingAddress;
context_module: ContextModule;
context_page_owner_type: string;
context_page_owner_id: string;
}
/**
* User chooses shipping option.
*
* This schema describes events sent to Segment from [[clickedSelectShippingOption]]
*
* @example
* ```
* {
* action: "clickedSelectShippingOption",
* context_module: "OrdersShipping",
* context_page_owner_type: "orders-shipping",
* context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b",
* subject: "UPS Ground"
* }
* ```
*/
export interface ClickedSelectShippingOption {
action: ActionType.clickedSelectShippingOption;
context_module: ContextModule;
context_page_owner_type: string;
context_page_owner_id: string;
subject: string;
}
/**
* A user clicks a show more button on web.
*
* This schema describes events sent to Segment from [[clickedMainArtworkGrid]]
*
* @example
* ```
* {
* action: "clickedShowMore",
* context_module: "exhibitorsTab",
* context_page_owner_type: "fair",
* context_page_owner_id: "5e726bd22524980012caafb0",
* context_page_owner_slug: "arteba-special-edition",
* subject: "Show More"
* }
* ```
*/
export interface ClickedShowMore {
action: ActionType.clickedShowMore;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
context_page_owner_slug?: string;
subject: string;
}
/**
* A user clicks a viewing room card
*
* This schema describes events sent to Segment from [[ClickedViewingRoomCard]]
*
* @example
* ```
* {
* action: "clickedViewingRoomCard",
* context_module: "viewingRoomCard",
* context_page_owner_type: "show",
* context_page_owner_id: "541890237261692168870700",
* context_page_owner_slug: "susan-eley-fine-art-susan-eley-fine-art-at-art-silicon-valley-slash-san-francisco",
* destination_page_owner_type: "viewing-room",
* destination_page_owner_id: "95f7dcfd-1996-45e1-9aab-979c38b2de59",
* destination_page_owner_slug: "susan-eley-fine-art-counterbalance",
* type: "thumbnail"
* }
* ```
*/
export interface ClickedViewingRoomCard {
action: ActionType.clickedViewingRoomCard;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
context_page_owner_slug?: string;
destination_page_owner_type: PageOwnerType;
destination_page_owner_id: string;
destination_page_owner_slug: string;
type: "thumbnail";
}
/**
* A user clicks an app download link.
*
* This schema describes events sent to Segment from [[ClickedAppDownload]]
*
* @example
* ```
* {
* action: "clickedAppDownload",
* context_module: "sellFooter",
* context_page_owner_type: "consign",
* destination_path: "https://apps.apple.com/us/app/artsy-buy-sell-original-art/id703796080",
* subject: "Download the app"
* }
* ```
*/
export interface ClickedAppDownload {
action: ActionType.clickedAppDownload;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
context_page_owner_slug?: string;
destination_path: string;
subject: string;
}
/**
* A partner clicks on Edit Artwork from CMS Checklist To-Do Items.
*
* This schema describes events sent to Segment from [[ClickedEditArtwork]]
*
* @example
* ```
* {
* action: "clickedEditArtwork",
* context_module: "toDoList",
* context_page_owner_type: "home",
* destination_page_owner_type: "artworks",
* destination_page_owner_id: "5808b9a0cd530e658500008a",
* destination_page_owner_slug: "maddalena-ambrosio-untitled"
* destination_path: "/artworks/maddalena-ambrosio-untitled/edit"
* label: "Add images"
* }
* ```
*/
export interface ClickedEditArtwork {
action: ActionType.clickedEditArtwork;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
destination_page_owner_type: PageOwnerType;
destination_page_owner_id: string;
destination_page_owner_slug: string;
destination_path: string;
label: string;
}
/**
* A partner clicks on Snooze button from CMS Checklist To-Do Items.
*
* This schema describes events sent to Segment from [[ClickedSnooze]]
*
* @example
* ```
* {
* action: "clickedSnooze",
* context_module: "toDoList",
* context_page_owner_type: "home"
* }
* ```
*/
export interface ClickedSnooze {
action: ActionType.clickedSnooze;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
}
/**
* A partner clicks on toggle arrow, displaying or hiding checklist items
* from CMS Checklist To-Do Items.
*
* This schema describes events sent to Segment from [[ClickedExpansionToggle]]
*
* @example
* ```
* {
* action: "clickedExpansionToggle",
* context_module: "toDoList",
* context_page_owner_type: "home"
* }
* ```
*/
export interface ClickedExpansionToggle {
action: ActionType.clickedExpansionToggle;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
}
/**
* A partner clicks a load 5 more button from CMS To-Do list
* after completing daily tasks.
*
* This schema describes events sent to Segment from [[ClickedLoadMore]]
*
* @example
* ```
* {
* action: "clickedLoadMore",
* context_module: "toDoList",
* context_page_owner_type: "home"
* subject: "Load 5 More"
* }
* ```
*/
export interface ClickedLoadMore {
action: ActionType.clickedLoadMore;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
subject: string;
}
/**
* A user clicks into the identity verification flow on web
*
* This schema describes events sent to Segment from [[clickedVerifyIdentity]]
*
* @example
* ```
* {
* action: "clickedVerifyIdentity",
* context_module: "yourActiveBids",
* context_page_owner_type: "auctions",
* sale_id: "5fad78273c8451000d0c53b9"
* subject: "Complete registration"
* }
* ```
*/
export interface ClickedVerifyIdentity {
action: ActionType.clickedVerifyIdentity;
context_module: ContextModule;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
context_page_owner_slug?: string;
sale_id: string;
subject: string;
}
/**
* A user clicks the pagination on an artwork grid on web
*
* This schema describes events sent to Segment from [[clickedChangePage]]
*
* @example
* ```
* {
* action: "clickedChangePage",
* context_module: "artworkGrid",
* context_page_owner_type: "artist",
* context_page_owner_id: "4d8b926a4eb68a1b2c0000ae",
* context_page_owner_slug: "damien-hirst",
* page_changed: 2
* page_current: 1
* }
* ```
*/
export interface ClickedChangePage {
action: ActionType.clickedChangePage;
context_module: ContextModule.artworkGrid;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
context_page_owner_slug?: string;
page_changed: number;
page_current: number;
}
/**
* A user clicks a promo space
*
* This schema describes events sent to Segment from [[clickedPromoSpace]]
*
* @example
* ```
* {
* action: "clickedPromoSpace",
* context_module: "banner",
* context_screen_owner_type: "home",
* destination_screen_owner_type: "collection",
* destination_screen_owner_slug: "artists-impacted-museum-shows",
* destination_path: "/collection/artists-impacted-museum-shows",
* subject: "Browse by collection"
* }
* ```
*/
export interface ClickedPromoSpace {
action: ActionType.clickedPromoSpace;
context_module: ContextModule;
context_screen_owner_type: PageOwnerType;
destination_screen_owner_type?: PageOwnerType;
destination_screen_owner_id?: string;
destination_screen_owner_slug?: string;
destination_path: string;
subject: string;
}
/**
* A user clicks create alert button
*
* This schema describes events sent to Segment from [[clickedCreateAlert]]
*
* @example
* ```
* {
* action: "clickedCreateAlert",
* context_page_owner_type: "artist",
* context_page_owner_id: "5359794d1a1e86c3740001f7",
* context_page_owner_slug: "anthony-hunter",
* }
* ```
*/
export interface ClickedCreateAlert {
action: ActionType.clickedCreateAlert;
context_page_owner_type: PageOwnerType;
context_page_owner_id?: string;
context_page_owner_slug?: string;
}