Overlay

Retrieves the collection of Overlay resources.

Retrieves the collection of Overlay resources.

get/overlays

Request

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

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

paginationboolean

Enable or disable pagination

createdAt[before]string
createdAt[strictly_before]string
createdAt[after]string
createdAt[strictly_after]string
updatedAt[before]string
updatedAt[strictly_before]string
updatedAt[after]string
updatedAt[strictly_after]string
order[createdAt]'asc' | 'desc'
order[updatedAt]'asc' | 'desc'

Response

Overlay collection

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.