Model readers

Permissions

User Group	Create?	Read?	Update?	Delete?
admin	x	x	x	x
owner	x	x	x	x
user		x

Fields

Name	Type	Link	Maps To	Default	Indexed?	Unique?
__v	Number
_deleted	Boolean			false	x
_id	ObjectID			[Function]
_owner_id	ObjectID	User	_owner		x
_updated_by_id	ObjectID	User	_updated_by		x
app_user	Boolean			false	x
authors	Array of String			[Function]
browser	String				x
browser_version	String
campaign	String
cc_expiry_date	Date
cc_last4_digits	String
cellphone	String
city	String
country	String
createdAt	Date
device	String				x
display_name	String
email	String				x	x
email_client	String				x
email_state	String				x
external_id	Number				x	x
favourite_author	String				x
favourite_section	String				x
first_login	Date
first_name	String
first_payment	Date				x
frequency	Number
frequency_quantile_rank	Number
frequency_score	Number				x
height	Number
home_locations	Array			[Function]
label_data	Mixed
label_id	Array of ObjectID			[Function]
label_update	Date
last_login	Date
last_name	String
last_payment	Date				x
last_update	Date
latitude	Number
longitude	Number
medium	String
member	Boolean			false	x
monetary_value	Number
monetary_value_score	Number				x
monthly_contribution	Number			0	x
newsletters	Array of String			[Function]
operating_system	String
os_version	String				x
paying_customer	Boolean			false	x
payment_method	String				x
platform	String
recency	Date
recency_quantile_rank	Number
recency_score	Number				x
region	String
sections	Array of String			[Function]
segment_id	Array of ObjectID			[Function]
segment_update	Date
segment_update_v2	Date
segmentation_id	Array of ObjectID			[Function]
sent_insider_welcome_email	Date				x
source	String
subscription_cancellation_reason	String				x
subscription_cancellation_request_date	Date				x
subscription_end	Date				x
subscription_next_payment	Date				x
subscription_period	String				x
subscription_product	String				x
subscription_start	Date				x
subscription_status	String				x
subscription_total	Number			0	x
total_lifetime_value	Number
total_lifetime_value_score	Number				x
uas	Mixed
updatedAt	Date
user_registered	Date			[Function]	x
user_registered_on_wordpress	Date
volume	Number
volume_quantile_rank	Number
volume_score	Number				x
whitebeardcustomer_id	ObjectID	whitebeard_customer			x
width	Number
wordpress_id	Number				x	x
wordpressuser_id	ObjectID	wordpressuser			x

Field Details

__v

{
  "path": "__v",
  "instance": "Number",
  "options": {},
  "validators": []
}

_deleted

{
  "path": "_deleted",
  "instance": "Boolean",
  "options": {
    "default": false,
    "index": true
  },
  "validators": [],
  "defaultValue": false
}

_id

{
  "path": "_id",
  "instance": "ObjectID",
  "options": {
    "auto": true,
    "type": "ObjectId"
  },
  "validators": [],
  "defaultValue": "[Function]"
}

_owner_id

{
  "path": "_owner_id",
  "instance": "ObjectID",
  "options": {
    "link": "User",
    "map_to": "_owner",
    "index": true
  },
  "validators": []
}

_updated_by_id

{
  "path": "_updated_by_id",
  "instance": "ObjectID",
  "options": {
    "link": "User",
    "map_to": "_updated_by",
    "index": true
  },
  "validators": []
}

app_user

{
  "path": "app_user",
  "instance": "Boolean",
  "options": {
    "index": true,
    "default": false
  },
  "validators": [],
  "defaultValue": false
}

authors

{
  "path": "authors",
  "instance": "Array",
  "options": {
    "type": [
      {
        "index": true
      }
    ]
  },
  "validators": [],
  "defaultValue": "[Function]",
  "arrayType": "String"
}

browser

{
  "path": "browser",
  "instance": "String",
  "options": {
    "index": true
  },
  "validators": []
}

browser_version

{
  "path": "browser_version",
  "instance": "String",
  "options": {},
  "validators": []
}

campaign

{
  "path": "campaign",
  "instance": "String",
  "options": {},
  "validators": []
}

cc_expiry_date

{
  "path": "cc_expiry_date",
  "instance": "Date",
  "options": {},
  "validators": []
}

cc_last4_digits

{
  "path": "cc_last4_digits",
  "instance": "String",
  "options": {},
  "validators": []
}

cellphone

{
  "path": "cellphone",
  "instance": "String",
  "options": {
    "trim": true
  },
  "validators": []
}

city

{
  "path": "city",
  "instance": "String",
  "options": {},
  "validators": []
}

country

{
  "path": "country",
  "instance": "String",
  "options": {},
  "validators": []
}

createdAt

{
  "path": "createdAt",
  "instance": "Date",
  "options": {
    "immutable": true
  },
  "validators": []
}

device

{
  "path": "device",
  "instance": "String",
  "options": {
    "index": true
  },
  "validators": []
}

display_name

{
  "path": "display_name",
  "instance": "String",
  "options": {},
  "validators": []
}

email

{
  "path": "email",
  "instance": "String",
  "options": {
    "index": true,
    "unique": true,
    "lowercase": true,
    "trim": true,
    "sparse": true
  },
  "validators": []
}

email_client

{
  "path": "email_client",
  "instance": "String",
  "options": {
    "index": true
  },
  "validators": []
}

email_state

{
  "path": "email_state",
  "instance": "String",
  "options": {
    "index": true
  },
  "validators": []
}

external_id

{
  "path": "external_id",
  "instance": "Number",
  "options": {
    "index": true,
    "unique": true
  },
  "validators": []
}

favourite_author

{
  "path": "favourite_author",
  "instance": "String",
  "options": {
    "index": true
  },
  "validators": []
}

favourite_section

{
  "path": "favourite_section",
  "instance": "String",
  "options": {
    "index": true
  },
  "validators": []
}

first_login

{
  "path": "first_login",
  "instance": "Date",
  "options": {},
  "validators": []
}

first_name

{
  "path": "first_name",
  "instance": "String",
  "options": {
    "trim": true
  },
  "validators": []
}

first_payment

{
  "path": "first_payment",
  "instance": "Date",
  "options": {
    "index": true
  },
  "validators": []
}

frequency

{
  "path": "frequency",
  "instance": "Number",
  "options": {},
  "validators": []
}

frequency_quantile_rank

{
  "path": "frequency_quantile_rank",
  "instance": "Number",
  "options": {},
  "validators": []
}

frequency_score

{
  "path": "frequency_score",
  "instance": "Number",
  "options": {
    "index": true
  },
  "validators": []
}

height

{
  "path": "height",
  "instance": "Number",
  "options": {},
  "validators": []
}

home_locations

{
  "path": "home_locations",
  "instance": "Array",
  "options": {
    "type": [
      {
        "obj": {
          "_deleted": {
            "default": false,
            "index": true
          },
          "_owner_id": {
            "link": "User",
            "map_to": "_owner",
            "index": true
          },
          "_updated_by_id": {
            "link": "User",
            "map_to": "_updated_by",
            "index": true
          }
        },
        "paths": {
          "_deleted": {
            "path": "_deleted",
            "instance": "Boolean",
            "validators": [],
            "getters": [],
            "setters": [],
            "_presplitPath": [
              "_deleted"
            ],
            "options": {
              "default": false,
              "index": true
            },
            "_index": true,
            "defaultValue": false,
            "$isUnderneathDocArray": true
          },
          "_owner_id": {
            "path": "_owner_id",
            "instance": "ObjectID",
            "validators": [],
            "getters": [],
            "setters": [],
            "_presplitPath": [
              "_owner_id"
            ],
            "options": {
              "link": "User",
              "map_to": "_owner",
              "index": true
            },
            "_index": true,
            "$isUnderneathDocArray": true
          },
          "_updated_by_id": {
            "path": "_updated_by_id",
            "instance": "ObjectID",
            "validators": [],
            "getters": [],
            "setters": [],
            "_presplitPath": [
              "_updated_by_id"
            ],
            "options": {
              "link": "User",
              "map_to": "_updated_by",
              "index": true
            },
            "_index": true,
            "$isUnderneathDocArray": true
          },
          "country": {
            "enumValues": [],
            "regExp": null,
            "path": "country",
            "instance": "String",
            "validators": [],
            "getters": [],
            "setters": [],
            "_presplitPath": [
              "country"
            ],
            "options": {},
            "_index": null,
            "$isUnderneathDocArray": true
          },
          "region": {
            "enumValues": [],
            "regExp": null,
            "path": "region",
            "instance": "String",
            "validators": [],
            "getters": [],
            "setters": [],
            "_presplitPath": [
              "region"
            ],
            "options": {},
            "_index": null,
            "$isUnderneathDocArray": true
          },
          "city": {
            "enumValues": [],
            "regExp": null,
            "path": "city",
            "instance": "String",
            "validators": [],
            "getters": [],
            "setters": [],
            "_presplitPath": [
              "city"
            ],
            "options": {},
            "_index": null,
            "$isUnderneathDocArray": true
          },
          "weight": {
            "path": "weight",
            "instance": "Number",
            "validators": [],
            "getters": [],
            "setters": [],
            "_presplitPath": [
              "weight"
            ],
            "options": {},
            "_index": null,
            "$isUnderneathDocArray": true
          },
          "_id": {
            "path": "_id",
            "instance": "ObjectID",
            "validators": [],
            "getters": [],
            "setters": [
              null
            ],
            "_presplitPath": [
              "_id"
            ],
            "options": {
              "auto": true,
              "type": "ObjectId"
            },
            "_index": null,
            "$isUnderneathDocArray": true
          },
          "createdAt": {
            "path": "createdAt",
            "instance": "Date",
            "validators": [],
            "getters": [],
            "setters": [
              null,
              null
            ],
            "_presplitPath": [
              "createdAt"
            ],
            "options": {
              "immutable": true
            },
            "_index": null,
            "$immutable": true,
            "$isUnderneathDocArray": true
          },
          "updatedAt": {
            "path": "updatedAt",
            "instance": "Date",
            "validators": [],
            "getters": [],
            "setters": [],
            "_presplitPath": [
              "updatedAt"
            ],
            "options": {},
            "_index": null,
            "$isUnderneathDocArray": true
          }
        },
        "aliases": {},
        "subpaths": {},
        "virtuals": {
          "_owner": {
            "path": "_owner",
            "getters": [],
            "setters": [
              null
            ],
            "options": {
              "ref": "User",
              "localField": "_owner_id",
              "foreignField": "_id",
              "justOne": true,
              "options": {}
            }
          },
          "_updated_by": {
            "path": "_updated_by",
            "getters": [],
            "setters": [
              null
            ],
            "options": {
              "ref": "User",
              "localField": "_updated_by_id",
              "foreignField": "_id",
              "justOne": true,
              "options": {}
            }
          },
          "id": {
            "path": "id",
            "getters": [
              null
            ],
            "setters": [],
            "options": {}
          }
        },
        "singleNestedPaths": {},
        "nested": {},
        "inherits": {},
        "callQueue": [],
        "_indexes": [
          [
            {
              "createdAt": -1
            },
            {}
          ],
          [
            {
              "updatedAt": -1
            },
            {}
          ],
          [
            {
              "country": 1,
              "region": 1,
              "city": 1,
              "weight": 1
            },
            {}
          ]
        ],
        "methods": {},
        "methodOptions": {},
        "statics": {},
        "tree": {
          "_deleted": {
            "default": false,
            "index": true
          },
          "_owner_id": {
            "link": "User",
            "map_to": "_owner",
            "index": true
          },
          "_updated_by_id": {
            "link": "User",
            "map_to": "_updated_by",
            "index": true
          },
          "_id": {
            "auto": true,
            "type": "ObjectId"
          },
          "createdAt": {
            "immutable": true
          },
          "_owner": {
            "path": "_owner",
            "getters": [],
            "setters": [
              null
            ],
            "options": {
              "ref": "User",
              "localField": "_owner_id",
              "foreignField": "_id",
              "justOne": true,
              "options": {}
            }
          },
          "_updated_by": {
            "path": "_updated_by",
            "getters": [],
            "setters": [
              null
            ],
            "options": {
              "ref": "User",
              "localField": "_updated_by_id",
              "foreignField": "_id",
              "justOne": true,
              "options": {}
            }
          },
          "id": {
            "path": "id",
            "getters": [
              null
            ],
            "setters": [],
            "options": {}
          }
        },
        "query": {},
        "childSchemas": [],
        "plugins": [
          {
            "opts": {
              "deduplicate": true
            }
          },
          {
            "opts": {
              "deduplicate": true
            }
          },
          {
            "opts": {
              "deduplicate": true
            }
          },
          {
            "opts": {
              "deduplicate": true
            }
          },
          {
            "opts": {
              "deduplicate": true
            }
          }
        ],
        "$id": 11,
        "mapPaths": [],
        "s": {
          "hooks": {
            "_pres": {},
            "_posts": {}
          }
        },
        "_userProvidedOptions": {
          "timestamps": true,
          "toJSON": {
            "virtuals": true
          },
          "toObject": {
            "virtuals": true
          },
          "_perms": {
            "admin": "",
            "owner": "",
            "user": "",
            "all": ""
          }
        },
        "options": {
          "timestamps": true,
          "toJSON": {
            "virtuals": true
          },
          "toObject": {
            "virtuals": true
          },
          "typeKey": "type",
          "id": true,
          "_id": true,
          "validateBeforeSave": true,
          "read": null,
          "shardKey": null,
          "discriminatorKey": "__t",
          "autoIndex": null,
          "minimize": true,
          "optimisticConcurrency": false,
          "versionKey": "__v",
          "capped": false,
          "bufferCommands": true,
          "strictQuery": true,
          "strict": true,
          "_perms": {
            "admin": "",
            "owner": "",
            "user": "",
            "all": ""
          }
        },
        "$timestamps": {
          "createdAt": "createdAt",
          "updatedAt": "updatedAt"
        },
        "opts": {
          "timestamps": true,
          "toJSON": {
            "virtuals": true
          },
          "toObject": {
            "virtuals": true
          }
        },
        "definition": {
          "_deleted": {
            "default": false,
            "index": true
          },
          "_owner_id": {
            "link": "User",
            "map_to": "_owner",
            "index": true
          },
          "_updated_by_id": {
            "link": "User",
            "map_to": "_updated_by",
            "index": true
          }
        },
        "$globalPluginsApplied": true
      }
    ]
  },
  "validators": [],
  "defaultValue": "[Function]"
}

label_data

{
  "path": "label_data",
  "instance": "Mixed",
  "options": {},
  "validators": []
}

label_id

{
  "path": "label_id",
  "instance": "Array",
  "options": {
    "type": [
      {
        "link": "Label",
        "map_to": "label"
      }
    ]
  },
  "validators": [],
  "defaultValue": "[Function]",
  "arrayType": "ObjectID"
}

label_update

{
  "path": "label_update",
  "instance": "Date",
  "options": {},
  "validators": []
}

last_login

{
  "path": "last_login",
  "instance": "Date",
  "options": {},
  "validators": []
}

last_name

{
  "path": "last_name",
  "instance": "String",
  "options": {
    "trim": true
  },
  "validators": []
}

last_payment

{
  "path": "last_payment",
  "instance": "Date",
  "options": {
    "index": true
  },
  "validators": []
}

last_update

{
  "path": "last_update",
  "instance": "Date",
  "options": {},
  "validators": []
}

latitude

{
  "path": "latitude",
  "instance": "Number",
  "options": {},
  "validators": []
}

longitude

{
  "path": "longitude",
  "instance": "Number",
  "options": {},
  "validators": []
}

medium

{
  "path": "medium",
  "instance": "String",
  "options": {},
  "validators": []
}

member

{
  "path": "member",
  "instance": "Boolean",
  "options": {
    "index": true,
    "default": false
  },
  "validators": [],
  "defaultValue": false
}

monetary_value

{
  "path": "monetary_value",
  "instance": "Number",
  "options": {},
  "validators": []
}

monetary_value_score

{
  "path": "monetary_value_score",
  "instance": "Number",
  "options": {
    "index": true
  },
  "validators": []
}

monthly_contribution

{
  "path": "monthly_contribution",
  "instance": "Number",
  "options": {
    "index": true,
    "default": 0
  },
  "validators": [],
  "defaultValue": 0
}

newsletters

{
  "path": "newsletters",
  "instance": "Array",
  "options": {
    "type": [
      null
    ]
  },
  "validators": [],
  "defaultValue": "[Function]",
  "arrayType": "String"
}

operating_system

{
  "path": "operating_system",
  "instance": "String",
  "options": {},
  "validators": []
}

os_version

{
  "path": "os_version",
  "instance": "String",
  "options": {
    "index": true
  },
  "validators": []
}

paying_customer

{
  "path": "paying_customer",
  "instance": "Boolean",
  "options": {
    "index": true,
    "default": false
  },
  "validators": [],
  "defaultValue": false
}

payment_method

{
  "path": "payment_method",
  "instance": "String",
  "options": {
    "index": true
  },
  "validators": []
}

platform

{
  "path": "platform",
  "instance": "String",
  "options": {},
  "validators": []
}

recency

{
  "path": "recency",
  "instance": "Date",
  "options": {},
  "validators": []
}

recency_quantile_rank

{
  "path": "recency_quantile_rank",
  "instance": "Number",
  "options": {},
  "validators": []
}

recency_score

{
  "path": "recency_score",
  "instance": "Number",
  "options": {
    "index": true
  },
  "validators": []
}

region

{
  "path": "region",
  "instance": "String",
  "options": {},
  "validators": []
}

sections

{
  "path": "sections",
  "instance": "Array",
  "options": {
    "type": [
      {
        "index": true
      }
    ]
  },
  "validators": [],
  "defaultValue": "[Function]",
  "arrayType": "String"
}

segment_id

{
  "path": "segment_id",
  "instance": "Array",
  "options": {
    "type": [
      {
        "link": "segment",
        "map_to": "segment_v2"
      }
    ]
  },
  "validators": [],
  "defaultValue": "[Function]",
  "arrayType": "ObjectID"
}

segment_update

{
  "path": "segment_update",
  "instance": "Date",
  "options": {},
  "validators": []
}

segment_update_v2

{
  "path": "segment_update_v2",
  "instance": "Date",
  "options": {},
  "validators": []
}

segmentation_id

{
  "path": "segmentation_id",
  "instance": "Array",
  "options": {
    "type": [
      {
        "link": "segmentation",
        "map_to": "segment"
      }
    ]
  },
  "validators": [],
  "defaultValue": "[Function]",
  "arrayType": "ObjectID"
}

sent_insider_welcome_email

{
  "path": "sent_insider_welcome_email",
  "instance": "Date",
  "options": {
    "index": true
  },
  "validators": []
}

source

{
  "path": "source",
  "instance": "String",
  "options": {},
  "validators": []
}

subscription_cancellation_reason

{
  "path": "subscription_cancellation_reason",
  "instance": "String",
  "options": {
    "index": true
  },
  "validators": []
}

subscription_cancellation_request_date

{
  "path": "subscription_cancellation_request_date",
  "instance": "Date",
  "options": {
    "index": true
  },
  "validators": []
}

subscription_end

{
  "path": "subscription_end",
  "instance": "Date",
  "options": {
    "index": true
  },
  "validators": []
}

subscription_next_payment

{
  "path": "subscription_next_payment",
  "instance": "Date",
  "options": {
    "index": true
  },
  "validators": []
}

subscription_period

{
  "path": "subscription_period",
  "instance": "String",
  "options": {
    "index": true
  },
  "validators": []
}

subscription_product

{
  "path": "subscription_product",
  "instance": "String",
  "options": {
    "index": true
  },
  "validators": []
}

subscription_start

{
  "path": "subscription_start",
  "instance": "Date",
  "options": {
    "index": true
  },
  "validators": []
}

subscription_status

{
  "path": "subscription_status",
  "instance": "String",
  "options": {
    "index": true
  },
  "validators": []
}

subscription_total

{
  "path": "subscription_total",
  "instance": "Number",
  "options": {
    "index": true,
    "default": 0
  },
  "validators": [],
  "defaultValue": 0
}

total_lifetime_value

{
  "path": "total_lifetime_value",
  "instance": "Number",
  "options": {},
  "validators": []
}

total_lifetime_value_score

{
  "path": "total_lifetime_value_score",
  "instance": "Number",
  "options": {
    "index": true
  },
  "validators": []
}

uas

{
  "path": "uas",
  "instance": "Mixed",
  "options": {},
  "validators": []
}

updatedAt

{
  "path": "updatedAt",
  "instance": "Date",
  "options": {},
  "validators": []
}

user_registered

{
  "path": "user_registered",
  "instance": "Date",
  "options": {
    "index": true
  },
  "validators": [],
  "defaultValue": "[Function]"
}

user_registered_on_wordpress

{
  "path": "user_registered_on_wordpress",
  "instance": "Date",
  "options": {},
  "validators": []
}

volume

{
  "path": "volume",
  "instance": "Number",
  "options": {},
  "validators": []
}

volume_quantile_rank

{
  "path": "volume_quantile_rank",
  "instance": "Number",
  "options": {},
  "validators": []
}

volume_score

{
  "path": "volume_score",
  "instance": "Number",
  "options": {
    "index": true
  },
  "validators": []
}

whitebeardcustomer_id

{
  "path": "whitebeardcustomer_id",
  "instance": "ObjectID",
  "options": {
    "link": "whitebeard_customer",
    "index": true
  },
  "validators": []
}

width

{
  "path": "width",
  "instance": "Number",
  "options": {},
  "validators": []
}

wordpress_id

{
  "path": "wordpress_id",
  "instance": "Number",
  "options": {
    "index": true,
    "unique": true
  },
  "validators": []
}

wordpressuser_id

{
  "path": "wordpressuser_id",
  "instance": "ObjectID",
  "options": {
    "link": "wordpressuser",
    "index": true
  },
  "validators": []
}