Link Search Menu Expand Document
WiFi Pineapple Mark 7 Developer Docs

Dashboard

Table of Contents

  1. Introduction
  2. Types
  3. Endpoints

Introduction

Dashboard resources and helpers.

Types 

export interface DashboardCardData {
    clientsConnected: string;
    previousClients: string;
    diskUsage: DiskUsageInterface;
    mostPopularTraffic: TrafficInterface;
    reconScansRan: number;
    ssidsSeen: SSIDsSeenInterface;
    systemStatus: SystemStatusInterface;
    totalBandwidthUsed: number;
}


interface DiskUsageInterface {
    rootUsage: string;
}


interface TrafficInterface {
    first: string;
    second: string;
    third: string;
}


interface SSIDsSeenInterface {
    totalSSIDs: string;
    currentSSIDs: string;
}


interface SystemStatusInterface {
    cpuUsage: number;
    memoryUsage: number;
    temperature: number;
}

Endpoints

Response

If successful, RETURNS:

{
    "systemStatus": SystemStatus,
    "diskUsage": DiskUsage,
    "clientsConnected": string,
    "previousClients": string,
    "ssidsSeen": SSIDsSeen
}

If unsuccessful: See REST Error Responses

Response

If successful, returns latest news:

{
    "news": NewsItem[]
}

If unsuccessful: See REST Error Responses