Overlay

Retrieves a Overlay resource.

Retrieves a Overlay resource.

get/overlays/{id}

Request

  • Base URL: https://api.spash.com
  • URL: https://api.spash.com/overlays/{id}
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

idstring required

Overlay identifier

Response

Overlay resource

idinteger
type'client' | 'partner' | 'ngtv'
widthnumber
heightnumber
marginXnumber
marginYnumber
position'top_left' | 'top_right' | 'bottom_left' | 'bottom_right'
pathstring
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "type": "client",
  "width": 10,
  "height": 10,
  "marginX": 2,
  "marginY": 2,
  "createdAt": "CURRENT_TIMESTAMP",
  "updatedAt": "CURRENT_TIMESTAMP"
}

Changes

No recorded changes to this operation across all 1 revision of this API.