Response Objects Reference

The root element of all responses is the Response element. The element has a success and a server timestamp attribute which is the server time of the response as UNIX time. It also has a metadataHash attribute which is the latest metadata hash code (see the metadata section for more info). Finally, the root element may contain an appVersion attribute containing the current version number of the application specified in the request.

The root element contains a UserInfo element and, if the call is successful, the appropriate container element of the actual response data. If the call is unsuccessful the root element contains the ErrorResponse container element.

The UserInfo element contains information of the authenticated user.

If the resource doesn't require authentication, or no authentication is provided the UserInfo element only contains the free remaining searches (and an optional Error string if authentication was required).

The UserInfo element should be checked to confirm that authentication was successful (loggedIn="true") and to report the number of remaining searches.

The ErrorResponse root element contains error information and is returned when the call is unsuccessful.

The ErrorResponse contains an Error element. The value is the description of the error in English and the id attribute contains the error code. The error code can be used to localize the error string.

The metadata response object contains metadata information about the API. It wraps the following objects:

• FilterDefinition: Container of ConstraintDefinition objects
• Regions: Container of Region objects
• Networks: Container of Network objects
• Currencies: Container of Currency objects
• PlayerStatisticsDefinitions: Container of PlayerStatisticDefinition and PlayerStatisticalDataSetDefinition objects
• TournamentStatisticsDefinitions: Container of TournamentStatisticDefinition and TournamentStatisticalDataSetDefinition objects
• DefaultPlayerClasses: Container of PlayerClass definitions

The MetadataResponse is wrapped inside a standard Response object, which contains UserInfo and the metadata payload.

This is effectively a container of ConstraintDefinition objects.

Represents a description of a filter constraint. It has an "id" and a "type" attribute. If the type is "Multiselect" or "Selection" it also contains Option elements that define the possible values for the selection.

This is effectively a container of Region objects.

Represents poker network regions. Contains code, name and optional image attributes.

This is effectively a container of Network objects.

Represents a poker network. It contains the following attributes:

name: the human-readable network name.

code: a two-letter code of the network.

region: the network's region.

closed: true if the network is closed, false otherwise.

There are also the following coverage/availability Boolean attributes.

hudCoverage, scheduledCoverage, sitngoCoverage, tournamentSelector, tournamentOpener.

The network element also contains the following elements:

FullCoverageStartDate: the date when full coverage started.

FullCoverageTrackingRate: the percentage of the tracking rate of the full coverage.

UpdateInterval: how often the coverage data is updated in minutes.

EarliestGameTrackDate: the date of the earliest tracked game.

TrackedGamesCount: the number of tracked games.

CoverageStage: The coverage stage. "Full" means the network is fully covered.

If the network has skins these are included as simple elements.

This is effectively a container of Currency objects.

Represents one of the currently supported currency. The attributes "symbol" and "iso" contain the currency symbol and iso code respectively. The value contains the exchange rate value.

This is effectively a container of PlayerStatisticDefinition and StatisticalDataSetDefinition objects.

Defines a player statistic. The id attribute contains the identifier included in player responses, the name is the human-readable name of the statistic and the type defines the value type.

Defines a player statistical data set. The id attribute contains the identifier included in player responses, while the xAxisTitle and xAxisType define the name and type of the x axis for the z axis. If the dataset is three-dimensional it will also contain zAxisTitle and zAxisType. It also contains Series elements that define the id, type, and title of included data series.

Similar to PlayerStatisticsDefinitions, this is effectively a container of TournamentStatisticDefinition and TournamentStatisticalDataSetDefinition objects.

Defines a tournament statistic. The id attribute contains the identifier included in tournament responses, the name is the human-readable name of the statistic and the type defines the value type.

Defines a tournament statistical data set. The id attribute contains the identifier included in player responses, while the xAxisTitle and xAxisType define the name and type of the x axis. If the dataset is three-dimensional it will also contain zAxisTitle and zAxisType for the z axis. It also contains Series elements that define the id, type, and title of included data series.

This is a container of the default PlayerClass definitions. These can be overridden by users.

Represents a named set of rules that identify a particular player as a member of that class. The object contains the name, priority and iconUri attributes, as well as the categories assigned to the player class. The name is the identifier in other elements.

The player class rule represents a range of values for specific player statistics. A player's relevant statistic must fall within the defined range for the rule to be satisfied. All rules within a player class must be satisfied for the player to be considered a member of the player class.

Also note that the player classes are relevant and depend upon any applied search filters. So, for example, a particular player may be a "Fish" in scheduled tournaments and a "Shark" in $10-20 sit & go tournaments.

This is effectively a container of SavedFilter objects.

Represents a filter saved by the user. It has an "name" and a "type" attribute. The type attribute determines if the filter is a player filter or a tournament selector filter or both. The value of the element is the filter string.

This is a container of the user defined PlayerClass definitions.

This is a view to player's data. It is defined by the filter and player network/name. It contains the Filter and Player objects. The latter contains sparsely populated data depending on the request.

The filter object represents the filter applied to the request. It is effectively a container of Constraint objects that define individual filter constraints.

The Constraint object represents individual filter constraints. The id attribute maps directly to a ConstraintDefinition object in the metadata. Depending on the type it contains the value(s) of the constraint in appropriate sub-elements.

The PlayerResponse object is a container that wraps player-related data. It contains one or more PlayerView objects, each representing a view of player data defined by the filter and player network/name.

Most player resources return a PlayerResponse object sparsely populated according to the request. The PlayerResponse is wrapped inside a standard Response object, which contains UserInfo and the player data payload.

The PlayerResponse object contains:
- PlayerView: A view to player's data, containing Filter and Player objects

The player object contains sparsely populated data depending on the request. It always contains a name and a network attribute that uniquely identifies the player. It may also optionally contain the following objects:

Icon: If the player has associated icons.

Statistics: if statistics were requested and the player is not blocked.

recentTournaments: A list of the most recent tournaments, or

completedTournaments: A list of the current tournaments.

activeTournaments: A list of the current tournaments.

The player may also be a consolidated player group in which case the element name is PlayerGroup. A player group doesn't have a network attribute and contains one or more Player objects. These player objects may only contain Icon objects, the statistics and recent tournaments for those players are consolidated at the top level player group object.

The statistics object is effectively a container of Statistic and StatisticalDataSet objects. It contains two attributes: "optedIn" and "displayCurrency". The "optedIn" attribute contains a Boolean value and is "true" if the player has opted in. The display currency contains the currency used in statistic values.

The Statistic object represents a single statistical value. It contains an id attribute that refers to the StatisticDefinition from the metadata. The value depends on the type.

The StatisticalDataSet object represents a set of values that can be represented as a graph. It contains an id attribute that refers to the StatisticalDataSetDefinition from the metadata. It also contains Data elements which define data points in the graph. The Y values map directly to the metadata definition.

The PlayerSuggestions object is a container for player suggestions. It is returned in the SearchSuggestionsResponse for the suggestions resource. The player suggestions object contains Player objects with only the name, network and Icon objects populated.

The PlayerInsightsResponse object contains predictions of a player's future performance and recommendations on how to increase profitability. This response is returned by the insights resource.

The PlayerInsightsResponse contains insights and recommendations that may include:
- Performance predictions based on historical data
- Recommendations for increasing profitability
- Currency-specific recommendations (when currency parameter is provided)
- Day-of-week specific recommendations (when timezoneOffset parameter is provided)

The PlayerInsightsResponse is wrapped inside a standard Response object, which contains UserInfo and the insights payload.

Tournaments have their own statistics and statistical datasets. The definitions of these statistics are included in the metadata under "TournamentStatisticsDefinitions".

Tournament entry objects contain information about the participants of the tournament as Player objects. The player objects contained in tournament entries only contain basic player information like username, icons without statistics.

For completed tournaments, the position of the player in the tournament and profit are also included.

The metadata response object contains leaderboard definitions as a hierarchy or individual leaderboards with their players depending on the request.

The metadata response object contains leaderboard definitions as a hierarchy or individual leaderboards with their players depending on the request.

A response containing success or failure messages. Used by message-related endpoints.
The MessagesResponse is wrapped inside a standard Response object.

The PlayerGroupResponse object contains player group data. It may be sparsely populated depending on the request (e.g. list of groups, or a single group with members).
The PlayerGroupResponse is wrapped inside a standard Response object.

A generic tournament response object containing tournament data. The structure varies by endpoint.
The TournamentResponse is wrapped inside a standard Response object.

A response containing data for tournaments that are currently registering.
The RegisteringTournamentResponse is wrapped inside a standard Response object.

A response containing completed tournament data.
The CompletedTournamentResponse is wrapped inside a standard Response object.

A response containing minimal (bare) tournament information, typically when requesting multiple tournaments by ID.
The BareTournamentResponse is wrapped inside a standard Response object.

A response containing running chip counts for tournament players. Contains RunningChipsTournament elements with state (SUBMITTED, ERROR, or COMPLETED).
The RunningChipsResponse is wrapped inside a standard Response object.

A response containing leaderboard display data—either a hierarchy of leaderboards or individual leaderboards with their players.
The LeaderboardDisplayResponse is wrapped inside a standard Response object.

A response containing network coverage information.
The NetworkCoverageResponse is wrapped inside a standard Response object.

A response containing the authenticated user's preferences.
The UserPreferencesResponse is wrapped inside a standard Response object.

A response containing the user's blog URL or the result of setting/deleting it.
The BlogUrlResponse is wrapped inside a standard Response object.

A response containing user-specific metadata.
The UserMetadataResponse is wrapped inside a standard Response object.

A response containing the user's payment information.
The UserPaymentsResponse is wrapped inside a standard Response object.

A response containing the user's saved filters (UserFilters container with SavedFilter objects).
The UserFiltersResponse is wrapped inside a standard Response object.

A response containing the user's player class definitions.
The UserPlayerClassesResponse is wrapped inside a standard Response object.

A response containing reseller information for the user.
The ResellerInfoResponse is wrapped inside a standard Response object.

A response containing the user's notes on players (bulk or per-player).
The UserNotesResponse is wrapped inside a standard Response object.

A response containing manager-related data for the authenticated user.
The ManagerResponse is wrapped inside a standard Response object.

A response containing the user's search usage history, broken down by date, network and action.
The UserUsageHistoryResponse is wrapped inside a standard Response object.

A response containing market share report data for networks or regions.
The MarketShareResponse is wrapped inside a standard Response object.

A response containing hourly market share data (HourlyMarketShare elements with structure, stake, region, rake, network, hour, game, etc.).
The HourlyMarketShareResponse is wrapped inside a standard Response object.

A response containing daily scheduled tournament report data for a network or region.
The DailyScheduledTournamentResponse is wrapped inside a standard Response object.

A response containing the user's private leaderboard data.
The UserPrivateLeaderboardResponse is wrapped inside a standard Response object.

A response containing stable (player group) related data.
The StableResponse is wrapped inside a standard Response object.

A response containing tracking outage notification data.
The OutageNotificationResponse is wrapped inside a standard Response object.