Patch a frame by ID

patch

https://dashboard.streetmetrics.io/v3/public/frames/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

number

required

Body Params

frameRef

string

Unique reference for the frame

frameType

string

enum

Type of frame

Allowed:

frameMedia

string

enum

Media type of the frame

frameWidth

number

Width of the frame in specified metrics

frameHeight

number

Height of the frame in specified metrics

frameElevation

number

Elevation of the frame

expositionAngle

enum

Angle of exposition (cardinal direction or 0 to 360)

city

string

City where the frame is located

county

string

County where the frame is located

flipDuration

number

Duration of flip for digital frames

frameMetrics

string

enum

Measurement unit

Allowed:

frameName

string

Display name for the frame

frameOwner

string

Owner of the frame

geopathId

string

Geopath ID if available

neighborhood

string

Neighborhood where frame is located

postalCode

string

Postal code of frame location

primaryRead

string

enum

Primary read type

Allowed:

primaryRoad

string

Primary road near the frame

siteAddress

string

Street address of the frame

siteType

string

enum

Type of site

Allowed:

siteLat

number

-90 to 90

Latitude of frame location

siteLon

number

-180 to 180

Longitude of frame location

siteName

string

Name of the site

siteRef

string

Reference ID for the site

stateProvince

string

enum

State/Province

totalSlots

number

Total number of slots

illuminationStart

string

Time when illumination starts (HH:mm)

illuminationEnd

string

Time when illumination ends (HH:mm)

mediaCustom

string

Custom media information

expositionWidth

number | null

Width of exposition

polygon

string

WKT polygon string representing the frame area

inventoryType

string

enum

Inventory type

Allowed:

inventorySubtype

string

Inventory subtype (single value; stored as a one-element array)

ownerInventorySubtype

string

Owner inventory subtype

inventoryClass

string

enum

Inventory class (auto-set to Place-Based for place media)

Allowed:

marketId

number

Manually-set market ID; overrides the geojson market lookup when the site falls outside any market polygon

Responses

Language

Loading…

Response

Choose an example:

application/json

200Frame patched successfully

401Unauthorized

429Too Many Requests

500Internal Server Error