Retrieve a screen - Mezmo Docs

GET

config

screen

{id}

Retrieve a screen

curl --request GET \
  --url https://api.mezmo.com/v1/config/screen/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.mezmo.com/v1/config/screen/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mezmo.com/v1/config/screen/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mezmo.com/v1/config/screen/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mezmo.com/v1/config/screen/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "title": "<string>",
  "rotate90Degrees": true,
  "account": "<string>",
  "categories": [
    "<string>"
  ],
  "widgets": [
    {
      "id": "<string>",
      "field": "<string>",
      "position": {
        "start": [
          "<unknown>"
        ],
        "end": [
          "<unknown>"
        ]
      },
      "match": "<string>",
      "filter": "<string>",
      "label": "<string>",
      "leftLabel": "<string>",
      "rightLabel": "<string>",
      "showBarChart": true,
      "groupBy": "<string>",
      "min": 123,
      "max": 123,
      "units": "<string>"
    }
  ]
}

{
  "error": "Unable to find screen with this id on this account",
  "code": "NotFound",
  "status": "error"
}

Authorizations

Authorization

string

header

required

The primary authentication method for the Mezmo API.

Pass the key in the Authorization header in the format Token <ACCESS TOKEN>. For example:

curl -H 'Authorization: Token <ACCESS TOKEN>'

This key is used for all APIs with the exception of ingest.

Path Parameters

string

required

Response

A fully detailed screen resource for the matching id.

string

required

read-only

The identifier of this screen.

title

string

required

The title of this screen.

ratio

enum<string>

required

The width to height aspect ratio of this screen.

Available options:

3:2,

4:3,

5:4,

16:9,

16:10,

21:9

rotate90Degrees

boolean

required

Whether the screen is rotated 90 degrees. Setting to true effectively swaps the width to height ratio.

background

enum<string>

required

The background color to use when viewing the screen.

Available options:

dark,

light

account

string

read-only

The account this screen belongs to.

categories

string[]

A list of string categories the screen belongs to.

widgets

object[]

Show child attributes

⌘I

Retrieve a screen

curl --request GET \
  --url https://api.mezmo.com/v1/config/screen/{id} \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.mezmo.com/v1/config/screen/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mezmo.com/v1/config/screen/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mezmo.com/v1/config/screen/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mezmo.com/v1/config/screen/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "title": "<string>",
  "rotate90Degrees": true,
  "account": "<string>",
  "categories": [
    "<string>"
  ],
  "widgets": [
    {
      "id": "<string>",
      "field": "<string>",
      "position": {
        "start": [
          "<unknown>"
        ],
        "end": [
          "<unknown>"
        ]
      },
      "match": "<string>",
      "filter": "<string>",
      "label": "<string>",
      "leftLabel": "<string>",
      "rightLabel": "<string>",
      "showBarChart": true,
      "groupBy": "<string>",
      "min": 123,
      "max": 123,
      "units": "<string>"
    }
  ]
}

{
  "error": "Unable to find screen with this id on this account",
  "code": "NotFound",
  "status": "error"
}