@artsy/cohesion
Version:
Analytics schema
79 lines (78 loc) • 2.08 kB
TypeScript
import { ContextModule } from "../Values/ContextModule";
import { CustomService } from "../Values/CustomService";
import { OwnerType } from "../Values/OwnerType";
import { ActionType } from ".";
/**
* Schemas describing share events
* @packageDocumentation
*/
/**
* A user shares a page on Artsy
*
* This schema describes events sent to Segment from [[Share]]
*
* @example
* ```
* {
* action: "share",
* context_module: "artworkImage",
* context_owner_type: "artwork",
* context_owner_id: "55ed8ca57261693d930000b8"
* service: "instagram_stories"
* }
* ```
*/
export interface Share {
action: ActionType.share;
context_module: ContextModule;
context_owner_type: OwnerType;
context_owner_id: string;
context_owner_slug?: string;
service: CustomService | string;
}
/**
* A user clicks the share button on the collection (artwork list) page
*
* This schema describes events sent to Segment from [[ClickedShareButton]]
*
* @example
* ```
* {
* action: "clickedShareButton",
* context_module: "saves" ,
* context_owner_type: "saves",
* context_owner_id: "55ed8ca57261693d930000b8",
* context_owner_slug: "wishlist",
* }
* ```
*/
export interface ClickedShareButton {
action: ActionType.clickedShareButton;
context_module: ContextModule;
context_owner_type: OwnerType;
context_owner_id: string;
context_owner_slug?: string;
}
/**
* A user clicks the open in new tab button on the collection (artwork list) page
*
* This schema describes events sent to Segment from [[ClickedOpenInNewTabButton]]
*
* @example
* ```
* {
* action: "clickedOpenInNewTabButton",
* context_module: "saves" ,
* context_owner_type: "saves",
* context_owner_id: "55ed8ca57261693d930000b8",
* context_owner_slug: "wishlist",
* }
* ```
*/
export interface ClickedOpenInNewTabButton {
action: ActionType.clickedOpenInNewTabButton;
context_module: ContextModule;
context_owner_type: OwnerType;
context_owner_id: string;
context_owner_slug?: string;
}