Enums¶

Overview¶

Enums (Enumerations) in ESO Logs Python provide type-safe constants for various API parameters. They represent fixed sets of allowed values defined by the ESO Logs GraphQL schema, ensuring that your code uses valid options and catches errors at development time rather than runtime.

Advanced GraphQL Features

Some enums in the GraphQL schema are only used by nested fields that aren't exposed through the Python client's convenience methods. See Direct GraphQL Access for how to use these advanced features.

Why Use Enums?¶

Type Safety: Your IDE and type checker will catch invalid values before you run your code
Autocomplete: Get intelligent suggestions as you type, showing all valid options
Self-Documenting: Enum names clearly indicate what values are acceptable
Validation: The API will reject invalid values, but using enums prevents these errors entirely

Basic Usage¶

from esologs import Client, EventDataType, HostilityType
from esologs.auth import get_access_token

async def analyze_combat():
    token = get_access_token()
    client = Client(
        url="https://www.esologs.com/api/v2/client",
        headers={"Authorization": f"Bearer {token}"}
    )

    # Using enums for type-safe queries
    events = await client.get_report_events(
        code="abc123",
        data_type=EventDataType.DamageDone,  # ✅ Type-safe with autocomplete
        hostility_type=HostilityType.Enemies  # ✅ IDE will show available options
    )

    # String values also work but lose benefits
    events2 = await client.get_report_events(
        code="abc123",
        data_type="DamageDone",  # ⚠️ Works but no validation/autocomplete
    )

Importing Enums¶

All enums are available from the main package:

from esologs import (
    EventDataType,
    TableDataType,
    GraphDataType,
    CharacterRankingMetricType,
    HostilityType,
    RoleType,
    KillType,
    # ... and more
)

Available Enums¶

CharacterRankingMetricType¶

Metrics available for character rankings and leaderboards.

Values:

bosscdps - Boss conduit DPS
bossdps - Boss damage per second
bossndps - Boss normalized DPS
bossrdps - Boss rDPS (raid-contributing DPS)
default - Default metric
dps - Damage per second
hps - Healing per second
krsi - Kill speed index
playerscore - Overall performance score
playerspeed - Clear time performance
cdps - Conduit DPS
ndps - Normalized DPS
rdps - Raid-contributing DPS
tankhps - Tank healing per second
wdps - Weighted DPS
healercombineddps - Healer combined DPS
healercombinedbossdps - Healer combined boss DPS
healercombinedcdps - Healer combined conduit DPS
healercombinedbosscdps - Healer combined boss conduit DPS
healercombinedndps - Healer combined normalized DPS
healercombinedbossndps - Healer combined boss normalized DPS
healercombinedrdps - Healer combined rDPS
healercombinedbossrdps - Healer combined boss rDPS
tankcombineddps - Tank combined DPS
tankcombinedbossdps - Tank combined boss DPS
tankcombinedcdps - Tank combined conduit DPS
tankcombinedbosscdps - Tank combined boss conduit DPS
tankcombinedndps - Tank combined normalized DPS
tankcombinedbossndps - Tank combined boss normalized DPS
tankcombinedrdps - Tank combined rDPS
tankcombinedbossrdps - Tank combined boss rDPS

Used by:

EventDataType¶

Types of events that can be filtered when retrieving report events.

Values:

All - All event types
Buffs - Buff application events
Casts - Ability cast events
CombatantInfo - Combatant information
DamageDone - Damage dealt events
DamageTaken - Damage received events
Deaths - Death events
Debuffs - Debuff application events
Dispels - Dispel events
Healing - Healing events
Interrupts - Interrupt events
Resources - Resource changes (magicka, stamina)
Summons - Pet/summon events
Threat - Threat/aggro events

Used by:

get_report_events

ExternalBuffRankFilter¶

Filter for rankings based on external buff usage.

Values:

Any - Any external buff usage
Exclude - Exclude rankings with external buffs
Require - Only show rankings with external buffs

Used by:

Note: This enum is defined in the GraphQL schema for use with Encounter.characterRankings, which is not exposed as a top-level query method in the ESO Logs API. The Python client provides 100% coverage of available API methods.

FightRankingMetricType¶

Metrics available for fight-specific rankings.

Values:

default - Default ranking metric
execution - Execution score
feats - Feats of strength
score - Overall score
speed - Clear speed
progress - Progress metric

Used by:

get_report_rankings

GraphDataType¶

Types of data available for time-series graphs.

Values:

Summary - Summary data
Buffs - Buff uptime over time
Casts - Cast timeline
DamageDone - Damage output graph
DamageTaken - Damage taken graph
Deaths - Death timeline
Debuffs - Debuff uptime over time
Dispels - Dispel timeline
Healing - Healing output graph
Interrupts - Interrupt timeline
Resources - Resource levels over time
Summons - Summon timeline
Survivability - Survivability metrics
Threat - Threat over time

Used by:

get_report_graph

GuildRank¶

Guild member rank levels.

Values:

NonMember - Not a guild member
Applicant - Guild applicant
Recruit - New guild member
Member - Standard member
Officer - Guild officer
GuildMaster - Guild leader

Used by:

get_guild_members

HardModeLevelRankFilter¶

Filter for rankings based on hard mode completion.

Values:

Any - Any difficulty level
Highest - Highest difficulty only
NormalMode - Normal mode (base difficulty)
Level0 - Hard mode level 0
Level1 - Hard mode level 1
Level2 - Hard mode level 2
Level3 - Hard mode level 3
Level4 - Hard mode level 4

Used by:

Note: This enum is defined in the GraphQL schema for use with Encounter.characterRankings, which is not exposed as a top-level query method in the ESO Logs API. The Python client provides 100% coverage of available API methods.

HostilityType¶

Filter events by hostility relationship.

Values:

Friendlies - Friendly targets (allies, self)
Enemies - Hostile targets

Used by:

KillType¶

Filter data by encounter outcome.

Values:

All - All fight data
Encounters - All encounter attempts
Kills - Successful kills only
Trash - Trash fights only
Wipes - Failed attempts only

Used by:

LeaderboardRank¶

Leaderboard ranking tiers.

Values:

Any - Any rank
LogsOnly - Logs only (no rank restrictions)

Used by:

Note: This enum is defined in the GraphQL schema for use with Encounter.characterRankings, which is not exposed as a top-level query method in the ESO Logs API. The Python client provides 100% coverage of available API methods.

RankingCompareType¶

How to compare rankings.

Values:

Rankings - Compare by rank position
Parses - Compare by performance percentile

Used by:

RankingTimeframeType¶

Time period for rankings.

Values:

Today - Today's rankings
Historical - All-time historical

Used by:

ReportRankingMetricType¶

Metrics for report-level rankings.

Values:

bossdps - Boss damage per second
bossrdps - Boss rDPS
default - Default metric
dps - Damage per second
hps - Healing per second
krsi - Kill speed index
playerscore - Player score
rdps - Raid-contributing DPS
tankhps - Tank healing per second

Used by:

RoleType¶

Character role classifications.

Values:

Any - Any role
DPS - Damage dealer role
Healer - Healer role
Tank - Tank role

Used by:

SubscriptionStatus¶

User subscription status levels.

Values:

Silver - Silver subscription
Gold - Gold subscription
Platinum - Platinum subscription
LegacySilver - Legacy silver status
LegacyGold - Legacy gold status
LegacyPlatinum - Legacy platinum status
AlchemicalSociety - Alchemical Society membership

Used by:

Note: This enum is defined in the GraphQL schema but is not used by any fields accessible through the ESO Logs API. The Python client provides 100% coverage of available API methods.

TableDataType¶

Types of data available in tabular format.

Values:

Summary - Summary statistics
Buffs - Buff uptime statistics
Casts - Cast counts and timings
DamageDone - Damage dealt breakdown
DamageTaken - Damage taken analysis
Deaths - Death log
Debuffs - Debuff uptime statistics
Dispels - Dispel counts
Healing - Healing breakdown
Interrupts - Interrupt counts
Resources - Resource generation/usage
Summons - Summon statistics
Survivability - Survivability statistics
Threat - Threat generation

Used by:

get_report_table

ViewType¶

Perspective for viewing data.

Values:

Default - Default view
Ability - Group by ability
Source - Group by source
Target - Group by target

Used by:

Best Practices¶

1. Always Import What You Need¶

# Good - explicit imports
from esologs import EventDataType, HostilityType

# Avoid - importing everything
from esologs import *

2. Use Enums for Type Safety¶

# Good - type-safe with IDE support
events = await client.get_report_events(
    code="abc",
    data_type=EventDataType.DamageDone
)

# Less ideal - no compile-time checking
events = await client.get_report_events(
    code="abc",
    data_type="DamageDone"
)

3. Leverage Your IDE¶

Modern IDEs will show available enum values as you type:

# Type "EventDataType." and your IDE shows:
# - EventDataType.All
# - EventDataType.Buffs
# - EventDataType.Casts
# ... etc

4. Enum Values Are Strings¶

All enum values are strings, so you can use them anywhere a string is expected:

# This works
print(f"Fetching {EventDataType.DamageDone} events...")
# Output: "Fetching DamageDone events..."

# Comparison works
if data_type == EventDataType.DamageDone:
    print("Processing damage events")