Class: CollectionMetadata

Classes_API~CollectionMetadata(objMetadata)

Represents the metadata of a PSS Fleet Data Collection.

Constructor

new CollectionMetadata(objMetadata)

constructor - Creates an instance of CollectionMetadata based on the given data.

Parameters:
Name Type Description
objMetadata object

An object retrieved by parsing JSON data from the PSS Fleet Data API.

Properties
Name Type Description
timestamp string

The timestamp of the Date at which the data was collected. In ISO-8601 format without the 'T' separator or timezone information. UTC timezone is assumed.
duration float

The time it took to collect the data.
fleet_count integer

The number of PssAlliances (fleets) included in this Collection.
user_count integer

The number of PssUsers (players) included in this Collection.
tourney_running boolean

Determines, if a monthly Tournament was running when collecting this data.
data_version integer

The schema version used when collecting the data.
schema_version integer

The schema version that the PSS Fleet Data API server used when sending the data.
max_tournament_battle_attempts integer

The maximum number of daily battle attempts in the monthly Tournament.
collection_id integer

The ID of the Collection.
Source:

Members

collectedAt :Date

collectedAt - The Date at which the data was collected. UTC timezone.

Type:
  • Date
Source:

collectionId :integer

collectionId - The ID of this Collection.

Type:
  • integer
Source:

dataVersion :integer

dataVersion - The schema version used when collecting the data.

Type:
  • integer
Source:

duration :float

duration - The time it took to collect the data.

Type:
  • float
Source:

fleetCount :integer

fleetCount - The number of PssAlliances (fleets) included in this Collection.

Type:
  • integer
Source:

maxTournamentBattleAttempts :integer

maxTournamentBattleAttempts - The maximum number of daily battle attempts in the monthly Tournament.

Type:
  • integer
Source:

schemaVersion :integer

schemaVersion - The schema version that the PSS Fleet Data API server used when sending the data.

Type:
  • integer
Source:

timestamp :string

timestamp - The timestamp of the Date at which the data was collected. In ISO-8601 format without the 'T' separator or timezone information. UTC timezone is assumed.

Type:
  • string
Source:

tournamentRunning :boolean

tournamentRunning - Determines, if a monthly Tournament was running when collecting this data.

Type:
  • boolean
Source:

userCount :integer

userCount - The number of PssUsers (players) included in this Collection.

Type:
  • integer
Source: