Get details of a spot

Published on Aug 7, 2026

Get

/v{version}/Spots/{spotId}

Security

API Key: api_key

Header parameter nameX-ApiKey

Api Key

API Key: session_id

Header parameter nameX-Session-Id

Session Id

Path parameters

spotId

integer (int32) Required

Unique ID of the spot

version

stringRequired

The requested API version

Responses

200

OK

Expand All

object

Spot details

ActiveVersion

object (V1.Models.SpotDetails.SpotVersionDetails)

Spot version details

Duration

integer (int32)

Duration of the spot version in seconds

DurationMs

integer (int32)

Duration in milliseconds

FileName

string

File name of the spot version

FileUrl

string

File URL

FileVersion

integer (int32)

File version of the spot version

Height

integer (int32)

Height of the spot version in pixels

IsEncrypted

boolean

If true, the spot version is encrypted. Default: false.

Thumbnail

string

Thumbnail states

Valid values[ "NA", "OK", "Outdated" ]

UserCreateDate

string (date-time)

Creation date of the spot version in local player time

Version

integer (int32)

Version of the spot version

VersionId

integer (int32)

Unique ID of the spot version

Width

integer (int32)

Width of the spot version in pixels

AllowArchiving

boolean

If true, the spot allows archiving. Default: false.

AllowVariants

boolean

If true, the spot allows the creation of variants. Default: false.

Categories

Array of object (V1.Models.Spot.SpotCategory)

Categories of the spot

object

Spot's category

Id

integer (int32)

Unique ID of the category

IsDummy

boolean

If true, the category is a dummy category. Default: false.

IsNegated

boolean

If true, the category is a negated category. Default: false.

Created

string (date-time)

Creation date in UTC

Description

string

Description of the spot

DraftVersion

object (V1.Models.SpotDetails.SpotVersionDetails)

Spot version details

Duration

integer (int32)

Duration of the spot version in seconds

DurationMs

integer (int32)

Duration in milliseconds

FileName

string

File name of the spot version

FileUrl

string

File URL

FileVersion

integer (int32)

File version of the spot version

Height

integer (int32)

Height of the spot version in pixels

IsEncrypted

boolean

If true, the spot version is encrypted. Default: false.

Thumbnail

string

Thumbnail states

Valid values[ "NA", "OK", "Outdated" ]

UserCreateDate

string (date-time)

Creation date of the spot version in local player time

Version

integer (int32)

Version of the spot version

VersionId

integer (int32)

Unique ID of the spot version

Width

integer (int32)

Width of the spot version in pixels

Id

integer (int32)

Unique ID of the spot

IsArchived

boolean

If true, the spot is archived. Default: false.

IsTemplate

boolean

If true, the spot is a template. Default: false.

Keywords

string

Keywords of the spot

LocationId

integer (int32)

Unique ID of the location

MediaType

string

Media types

Valid values[ "Unknown", "Video", "Flash", "Picture", "PowerPoint", "Pdf", "Shockwave", "Xml", "Mp3", "Html", "EPaper", "Draft", "Zip", "AndroidPackage", "AndroidSkin", "OverlayTrigger", "Qml" ]

Modified

string (date-time)

Modification date in UTC

Name

string

Name of the spot

ParentId

integer (int32)

Unique ID of the parent spot

PlayerId

integer (int32)

Unique ID of the Player assigned to spot

SpotGroupId

integer (int32)

Unique ID of the spot group

Tags

Array of object (V1.Models.Spot.SpotTag)

Tags of the spot

object

Spot's tag

Created

string (date-time)

Creation date in UTC

Id

integer (int32)

Unique ID of the tag

Modified

string (date-time)

Modification date in UTC

Name

string

Name of the tag

ParentId

integer (int32)

Unique ID of the tag

Permissions

object

Permissions of the tag

Read

boolean

Write

boolean

Type

string

Tag types

Valid values[ "Standard", "LiveTag", "SyncTag", "ConflictTag", "StartOfCommunication" ]

Type

string

Spot types

Valid values[ "Default", "Composer", "Trigger", "Ticker", "Url", "OverlayTrigger", "XmlDataSpot", "Audio", "Stream", "Zip", "WebsiteSpot", "HtmlComposerSpot", "WizardSpot", "Font", "WizardSpotMedia", "DashboardWidget", "DashboardWidgetMedia", "Qml", "ComposerPlayer", "RoomManager", "ConvertedSpot", "AscInterface", "AscPlayer" ]

ValidFrom

string (date-time)

The spot starts being visible to the player at this date and time.

Example2023-01-25T09:08:03.747Z

ValidTo

string (date-time)

The spot is visible to the player until this date and time.

Example2023-01-25T09:08:03.747Z

VariantCount

integer (int32)

Count of variants

400

Bad request

Expand All

object

ValidationErrors

object

property*

Array of string additionalProperties

string

401

Unauthorized

Expand All

object

Id

string

Message

string

Type

string

Values

object

property*

object additionalProperties

403

Forbidden

Expand All

object

Id

string

Message

string

Type

string

Values

object

property*

object additionalProperties

404

Not Found

Expand All

object

Id

string

Message

string

Type

string

Values

object

property*

object additionalProperties

409

Conflict

Expand All

object

Id

string

Message

string

Type

string

Values

object

property*

object additionalProperties

500

Unexpected error

Expand All

object

Id

string

Message

string

Type

string

Values

object

property*

object additionalProperties