Sky Ledge Docs
  • Welcome
  • Getting Started
    • Creating Your Account
    • Sky Ledge API - Quick start
    • Developer Guide
      • Creating A Control Room
      • Creating Event Types
      • Creating Events (aka Alerts or Notifications)
      • Creating Asset Types
      • Linking Asset Types to a Control Room
      • Creating Assets
      • Creating and Tracking a Metric
      • Future Updates
  • Fundamentals
    • Launchpad
    • Control Rooms
    • Assets
    • Events
    • Places
    • Cycles
    • Widgets
  • API Docs
  • Client Libraries
    • NodeJs
  • Community
    • Where to find us
  • Knowledge Base
    • Articles
      • What is a LaunchPad
      • What is a Control Room
      • How to use the maps controls and layers options
      • Map marker explained
      • Navigating your profile
      • What is an Event
      • What is an Event Type
      • Exploring the event stream
      • Event Stream Filtering
      • What is an Asset
      • What are asset types
      • Understanding Focus Mode
      • Navigating Asset List Mode
      • Table column selection
      • Asset metrics
      • What is a place
      • Searching and Creating a Place
      • Getting Started with Place Notifications
      • Places and how to use the gatehouse report
      • How to use the Event Report (Top-down Investigations Module)
      • What is a Task
      • How to process a task
      • Task Notifications
      • How to invite a work colleague
      • How to submit an awesome ticket
      • Understanding Your Weekly Email Reports
      • Knowledge Base Template
    • What's New
    • Archived - What's News
Powered by GitBook
On this page
  • Recap: What’s a Control Room?
  • Creating your first Control Room - Using the interface
  • Creating your first Control Room - Using the API
  1. Getting Started
  2. Developer Guide

Creating A Control Room

Recap: What’s a Control Room?

Control Rooms are “containers of insights”.

Control Rooms can be created to organise insights geographically (e.g. Hero Potion control rooms for different regions, New York, Boston, San Fran).

They can also be used to organise insights by themes or types of insights (for example, different Control Rooms for the regulator, marketing team and logistics).

And of course, you can mix and match (for example, have control rooms for the logistics team in NY, a different one for the logistics team in San Fran and perhaps another Control Room that displays logistics insights across all cities).

Creating your first Control Room - Using the interface

Creating a Control Room is a super easy, four step process:

  1. Sign in to your launchpad

  2. Create Control Room

  3. Give it a name, we've called ours “Heroes Flying Potion - Real-time Monitoring”

  4. Create Control Room

Click here for a detailed visual walk through.

Creating your first Control Room - Using the API

It’s entirely possible that Control Rooms need to be provisioned using APIs. For example, an automatic process that creates a control room for each pharmacy that purchases from HP Inc. This way each pharmacy can see information about shipping status as well as create and see insights about its customers.

Creating the Control Room

POST api.skyledge.com/controlrooms

// raw JSON body for api request
{  
   "name":"Heroes Flying Potion - Real-time Monitoring",
   "description":"Real-time monitoring of Flying Potions"
}
curl --location --request POST 'https://api.skyledge.com/controlrooms' \
--header 'X-Authorization: API_KEY' \
--header 'Content-Type: application/json' \
--data-raw {  
   "name":"Heroes Flying Potion - Real-time Monitoring",
   "description":"Real-time monitoring of Flying Potions"
}
import {
  Configuration,
  ControlRoomsApi,
  CreateControlRoomRequest,
} from '@skyledge/sdk';

const configuration = new Configuration({
  apiKey: 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX',
  basePath: 'https://api.skyledge.com',
});

const data: Partial<CreateControlRoomRequest> = {  
   "name":"Heroes Flying Potion - Real-time Monitoring",
   "description":"Real-time monitoring of Flying Potions"
}

const controlRoomApi = new ControlRoomsApi(configuration);

const newControlRoom = await controlRoomApi.createControlRoom(data);

console.log(newControlRoom.status);
import requests
import json

url = "https://api.skyledge.com/controlrooms"

payload = json.dumps({  
   "name":"Heroes Flying Potion - Real-time Monitoring",
   "description":"Real-time monitoring of Flying Potions"
})
headers = {
  'X-Authorization': 'API_KEY',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
PreviousDeveloper GuideNextCreating Event Types

Last updated 2 years ago