Home
RecipesDeveloper DocsPlatform Versions
HomeLog In
Developer Docs

Create a frame

post
https://dashboard.streetmetrics.io/v3/public/frames
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Data to create a new frame

string
required

Unique reference for the frame

string
enum
required

Type of frame

Allowed:
string
enum
required

Media type of the frame

number
required

Width of the frame in specified metrics

number
required

Height of the frame in specified metrics

number

Elevation of the frame

enum
required

Angle of exposition (cardinal direction or 0 to 360)

string
required

City where the frame is located

string

County where the frame is located

number

Duration of flip for digital frames

string
enum
required

Measurement unit

Allowed:
string

Display name for the frame

string
required

Owner of the frame

string

Geopath ID if available

string

Neighborhood where frame is located

string
required

Postal code of frame location

string
enum

Primary read type

Allowed:
string

Primary road near the frame

string

Street address of the frame

string
enum
required

Type of site

Allowed:
number
required
-90 to 90

Latitude of frame location

number
required
-180 to 180

Longitude of frame location

string

Name of the site

string

Reference ID for the site

string
enum
required

State/Province

number

Total number of slots

string

Time when illumination starts (HH:mm)

string

Time when illumination ends (HH:mm)

string

Custom media information

number | null

Width of exposition

string

WKT polygon string representing the frame area

number
Responses

201

Updated about 1 year ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 year ago