Insight

griddy / nfl / models / entities / insight**

insight

Attributes

InsightPosition module-attribute

InsightPosition = Literal[
    "QB", "RB", "WR", "TE", "OL", "DL", "LB", "DB", "K", "P"
]

Player position

SecondTeamType module-attribute

SecondTeamType = Literal['offense', 'defense']

Context of the second team (typically \"defense\" for opponent)

Classes

InsightTypedDict

Bases: TypedDict

              flowchart TD
              griddy.nfl.models.entities.insight.InsightTypedDict[InsightTypedDict]

              

              click griddy.nfl.models.entities.insight.InsightTypedDict href "" "griddy.nfl.models.entities.insight.InsightTypedDict"
            

Attributes

created_at instance-attribute

created_at: datetime

Content creation timestamp

created_by instance-attribute

created_by: str

Content creator identifier

date_ instance-attribute

date_: date

Content publication date

id instance-attribute

id: str

Unique content identifier

nfl_id instance-attribute

nfl_id: int

NFL player identifier

player_name instance-attribute

player_name: str

Player's full name

position instance-attribute

position: InsightPosition

Player position

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: SeasonTypeEnum

Type of NFL season

tags instance-attribute

tags: List[str]

Content classification tags

team_abbr instance-attribute

team_abbr: str

Player's team abbreviation

team_id instance-attribute

team_id: str

Player's team identifier

title instance-attribute

title: str

Main insight headline or title

updated_at instance-attribute

updated_at: datetime

Last update timestamp

updated_by instance-attribute

updated_by: str

Last editor identifier

week instance-attribute

week: int

Week number (if applicable)

esb_id instance-attribute

esb_id: NotRequired[str]

ESB player identifier

evergreen instance-attribute

evergreen: NotRequired[bool]

Whether content is evergreen (timeless) or time-sensitive

game_id instance-attribute

game_id: NotRequired[Nullable[int]]

Game identifier (10-digit format YYYYMMDDNN)

gsis_id instance-attribute

gsis_id: NotRequired[str]

GSIS player identifier

headshot instance-attribute

headshot: NotRequired[str]

URL to player headshot image (contains formatInstructions placeholder)

image_url instance-attribute

image_url: NotRequired[Nullable[str]]

Associated image or chart URL (optional)

jersey_number instance-attribute

jersey_number: NotRequired[int]

Player's jersey number

second_team_abbr instance-attribute

second_team_abbr: NotRequired[Nullable[str]]

Opponent or related team abbreviation

second_team_id instance-attribute

second_team_id: NotRequired[Nullable[str]]

Opponent or related team identifier

second_team_type instance-attribute

second_team_type: NotRequired[Nullable[SecondTeamType]]

Context of the second team (typically \"defense\" for opponent)

smart_id instance-attribute

smart_id: NotRequired[str]

Smart player identifier

sub_note1 instance-attribute

sub_note1: NotRequired[str]

Detailed insight content and analysis

Insight

Bases: BaseModel

              flowchart TD
              griddy.nfl.models.entities.insight.Insight[Insight]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.insight.Insight
                


              click griddy.nfl.models.entities.insight.Insight href "" "griddy.nfl.models.entities.insight.Insight"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            

Attributes

created_at instance-attribute

created_at: Annotated[datetime, Field(alias='createdAt')]

Content creation timestamp

created_by instance-attribute

created_by: Annotated[str, Field(alias='createdBy')]

Content creator identifier

date_ instance-attribute

date_: Annotated[date, Field(alias='date')]

Content publication date

id instance-attribute

id: str

Unique content identifier

nfl_id class-attribute instance-attribute

nfl_id: Annotated[Optional[int], Field(alias="nflId")] = (
    None
)

NFL player identifier

player_name class-attribute instance-attribute

player_name: Annotated[
    Optional[str], Field(alias="playerName")
] = None

Player's full name

position class-attribute instance-attribute

position: Optional[InsightPosition] = None

Player position

season instance-attribute

season: int

Season year

season_type instance-attribute

season_type: Annotated[
    SeasonTypeEnum, Field(alias="seasonType")
]

Type of NFL season

tags instance-attribute

tags: List[str]

Content classification tags

team_abbr instance-attribute

team_abbr: Annotated[str, Field(alias='teamAbbr')]

Player's team abbreviation

team_id instance-attribute

team_id: Annotated[str, Field(alias='teamId')]

Player's team identifier

title instance-attribute

title: str

Main insight headline or title

updated_at instance-attribute

updated_at: Annotated[datetime, Field(alias='updatedAt')]

Last update timestamp

updated_by instance-attribute

updated_by: Annotated[str, Field(alias='updatedBy')]

Last editor identifier

week instance-attribute

week: int

Week number (if applicable)

esb_id class-attribute instance-attribute

esb_id: Annotated[Optional[str], Field(alias="esbId")] = (
    None
)

ESB player identifier

evergreen class-attribute instance-attribute

evergreen: Optional[bool] = False

Whether content is evergreen (timeless) or time-sensitive

game_id class-attribute instance-attribute

game_id: Annotated[
    OptionalNullable[int], Field(alias="gameId")
] = UNSET

Game identifier (10-digit format YYYYMMDDNN)

gsis_id class-attribute instance-attribute

gsis_id: Annotated[Optional[str], Field(alias="gsisId")] = (
    None
)

GSIS player identifier

headshot class-attribute instance-attribute

headshot: Optional[str] = None

URL to player headshot image (contains formatInstructions placeholder)

image_url class-attribute instance-attribute

image_url: Annotated[
    OptionalNullable[str], Field(alias="imageUrl")
] = UNSET

Associated image or chart URL (optional)

jersey_number class-attribute instance-attribute

jersey_number: Annotated[
    Optional[int], Field(alias="jerseyNumber")
] = None

Player's jersey number

second_team_abbr class-attribute instance-attribute

second_team_abbr: Annotated[
    OptionalNullable[str], Field(alias="secondTeamAbbr")
] = UNSET

Opponent or related team abbreviation

second_team_id class-attribute instance-attribute

second_team_id: Annotated[
    OptionalNullable[str], Field(alias="secondTeamId")
] = UNSET

Opponent or related team identifier

second_team_type class-attribute instance-attribute

second_team_type: Annotated[
    OptionalNullable[SecondTeamType],
    Field(alias="secondTeamType"),
] = UNSET

Context of the second team (typically \"defense\" for opponent)

smart_id class-attribute instance-attribute

smart_id: Annotated[
    Optional[str], Field(alias="smartId")
] = None

Smart player identifier

sub_note1 class-attribute instance-attribute

sub_note1: Annotated[
    Optional[str], Field(alias="subNote1")
] = None

Detailed insight content and analysis