User

1
2
3
4
5
{
    "Name": "Mopedo.Database.User",
    "Kind": "EntityResource",
    "Methods": ["GET", "POST", "PATCH", "PUT", "DELETE", "REPORT", "HEAD"]
}

A User entity represents a person, in the form of a matched or unmatched web browser. Users are created in the DSP whenever a new user id is introduced via a bid request or when user matching.

Whenever a UserExtension entity is created containing a UserId property with the same value as an existing User’s UserId, the UserExtension entity will be assigned to the Extension property of that User.

Users can be matched by means of user matching.

Format

Properties marked in bold are required.

Property name Type Description
UserId string Mopedo-assigned unique user id
Extension UserExtension Additional client-defined data associated with the User
CreatedAt datetime See CreatedAt
UsedAt datetime See UsedAt
Matched bool See Matched
MatchedAt datetime See MatchedAt
UsedCount integer See UsedCount
UsedRank integer See UsedRank
AdWinCount integer See AdWinCount
AdClickCount integer See AdClickCount
CampaignWinCount integer See CampaignWinCount
CampaignClickCount integer See CampaignClickCount
WinCount integer Obsolete: Use AdWinCount instead
ClickCount integer Obsolete: Use AdWinCount instead

User.Feed

1
2
3
4
5
{
    "Name": "Mopedo.Database.User.Feed",
    "Kind": "TerminalResource",
    "Methods": ["GET"]
}

The User.Feed resource is a terminal resource that posts representations of User entities in real time as they are added to the DSP application.

Terminal properties

Property name Type Default value Description
IncludeExtension boolean false Should the Extension property be included in entities in the feed?
Status string "PAUSED" The current status of the console, can be "PAUSED" or "OPEN"
ShowWelcomeText boolean true Should the terminal print a welcome message on launch?

Entity format

The format of entities that are sent over the feed is different from the format of the entity resource.

Property name Type Description
UserId string Mopedo-assigned unique user id
CreatedAt datetime See CreatedAt
Matched bool See Matched
Extension UserExtension Additional client-defined data associated with the User