Dashboard Analytics API

The API returns four main sections of dashboard data:

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://unify.smsgateway.center/SMSApi/dashboard/read",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "userid=YourUsername&password=YourPassword&output=json",
  CURLOPT_HTTPHEADER => array(
    "cache-control: no-cache",
    "content-type: application/x-www-form-urlencoded"
  ),
));

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

curl_close($curl);

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

curl --location 'https://unify.smsgateway.center/SMSApi/dashboard/read' \
--form 'userid="YourUsername"' \
--form 'password="YourPassword"' \
--form 'startDate="2025-12-01"' \
--form 'endDate="2025-12-04"' \
--form 'output="json"'

{
  "response": {
    "api": "dashboard",
    "action": "read",
    "status": "success",
    "msg": "success",
    "code": 200,
    "count": 4,
    "dashboard": {
      "topBar": {
        "firstBoxCount": "Credit",
        "balance": "50000 Credits",
        "balanceRaw": 50000,
        "balanceCurrency": "",
        "balanceCredits": 50000,
        "lastPurchaseAmount": 10000,
        "lastPurchaseDate": "2025-11-25 14:30:00",
        "groups": 15,
        "contacts": 1250,
        "creditType": 1
      },
      "sentSummary": {
        "data": [
          {
            "date": "2025-12-01",
            "dateFormatted": "Dec 01",
            "submitted": 5000,
            "delivered": 4850,
            "failed": 100,
            "pending": 50
          },
          {
            "date": "2025-12-02",
            "dateFormatted": "Dec 02",
            "submitted": 3500,
            "delivered": 3400,
            "failed": 80,
            "pending": 20
          },
          {
            "date": "2025-12-03",
            "dateFormatted": "Dec 03",
            "submitted": 4200,
            "delivered": 4100,
            "failed": 90,
            "pending": 10
          },
          {
            "date": "2025-12-04",
            "dateFormatted": "Dec 04",
            "submitted": 2800,
            "delivered": 2750,
            "failed": 40,
            "pending": 10
          }
        ],
        "totalSubmitted": 15500,
        "averagePerDay": 3875,
        "startDate": "2025-12-01",
        "endDate": "2025-12-04",
        "days": 4
      },
      "donutInfo": {
        "data": [
          {
            "label": "Submitted",
            "value": 15500,
            "labelColor": "#fb9678"
          },
          {
            "label": "Delivered",
            "value": 15100,
            "labelColor": "#01c0c8"
          },
          {
            "label": "Failed",
            "value": 310,
            "labelColor": "#DE1F95"
          },
          {
            "label": "Pending",
            "value": 90,
            "labelColor": "#0B62A4"
          },
          {
            "label": "Rejected",
            "value": 0,
            "labelColor": "#4f5467"
          }
        ],
        "startDate": "2025-12-01",
        "endDate": "2025-12-04"
      },
      "chartColors": {
        "submitted": "#fb9678",
        "delivered": "#01c0c8",
        "failed": "#DE1F95",
        "pending": "#0B62A4",
        "rejected": "#4f5467"
      }
    }
  }
}

{
  "response": {
    "api": "dashboard",
    "action": "read",
    "status": "success",
    "msg": "success",
    "code": 200,
    "count": 4,
    "dashboard": {
      "topBar": {
        "firstBoxCount": "Wallet",
        "balance": "$250.50",
        "balanceRaw": 250.5,
        "balanceCurrency": "USD",
        "balanceCredits": 50100,
        "lastPurchaseAmount": 100,
        "lastPurchaseDate": "2025-11-30 10:15:00",
        "groups": 8,
        "contacts": 650,
        "creditType": 2
      },
      "sentSummary": { ... },
      "donutInfo": { ... },
      "chartColors": { ... }
    }
  }
}

{
  "response": {
    "api": "dashboard",
    "action": "read",
    "status": "success",
    "msg": "success",
    "code": 200,
    "count": 4,
    "dashboard": {
      "topBar": {
        "firstBoxCount": "45",
        "balance": "$1500.00",
        "balanceRaw": 1500,
        "balanceCurrency": "USD",
        "balanceCredits": 300000,
        "lastPurchaseAmount": 500,
        "lastPurchaseDate": "2025-12-01 09:00:00",
        "groups": 25,
        "contacts": 5000,
        "creditType": 2
      },
      "sentSummary": { ... },
      "donutInfo": { ... },
      "chartColors": { ... }
    }
  }
}

Note: For reseller accounts, firstBoxCount shows the total number of users under the reseller instead of "Credit" or "Wallet".

// React Native / JavaScript example
async function loadDashboard() {
  const formData = new FormData();
  formData.append('userid', 'YourUsername');
  formData.append('password', 'YourPassword');
  formData.append('output', 'json');

  try {
    const response = await fetch('https://unify.smsgateway.center/SMSApi/dashboard/read', {
      method: 'POST',
      body: formData
    });

    const data = await response.json();
    
    if (data.response.status === 'success') {
      const dashboard = data.response.dashboard;
      
      // Display top bar
      console.log(`Balance: ${dashboard.topBar.balance}`);
      console.log(`Groups: ${dashboard.topBar.groups}`);
      console.log(`Contacts: ${dashboard.topBar.contacts}`);
      
      // Display sent summary
      console.log(`Total Sent: ${dashboard.sentSummary.totalSubmitted}`);
      console.log(`Average/Day: ${dashboard.sentSummary.averagePerDay}`);
      
      // Display donut chart data
      dashboard.donutInfo.data.forEach(item => {
        console.log(`${item.label}: ${item.value}`);
      });
      
      return dashboard;
    }
  } catch (error) {
    console.error('Error loading dashboard:', error);
  }
}

loadDashboard();

import requests
from datetime import datetime, timedelta

def get_dashboard_analytics(days_back=7):
    end_date = datetime.now()
    start_date = end_date - timedelta(days=days_back)
    
    url = 'https://unify.smsgateway.center/SMSApi/dashboard/read'
    data = {
        'userid': 'YourUsername',
        'password': 'YourPassword',
        'startDate': start_date.strftime('%Y-%m-%d'),
        'endDate': end_date.strftime('%Y-%m-%d'),
        'output': 'json'
    }
    
    response = requests.post(url, data=data)
    result = response.json()
    
    if result['response']['status'] == 'success':
        dashboard = result['response']['dashboard']
        
        print(f"Analytics for {days_back} days:")
        print(f"Total Submitted: {dashboard['sentSummary']['totalSubmitted']}")
        print(f"Average Per Day: {dashboard['sentSummary']['averagePerDay']}")
        
        # Daily breakdown
        print("\nDaily Statistics:")
        for day in dashboard['sentSummary']['data']:
            print(f"{day['dateFormatted']}: {day['submitted']} sent, {day['delivered']} delivered")
        
        return dashboard
    else:
        print(f"Error: {result['response']['msg']}")

# Get last 7 days analytics
get_dashboard_analytics(7)

<?php
function getDashboardDonutData() {
    $url = "https://unify.smsgateway.center/SMSApi/dashboard/read";
    
    $postData = array(
        'userid' => 'YourUsername',
        'password' => 'YourPassword',
        'output' => 'json'
    );
    
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData));
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    
    $response = curl_exec($ch);
    curl_close($ch);
    
    $data = json_decode($response, true);
    
    if ($data['response']['status'] === 'success') {
        $donutInfo = $data['response']['dashboard']['donutInfo'];
        
        // Prepare data for chart library
        $chartData = array(
            'labels' => array(),
            'values' => array(),
            'colors' => array()
        );
        
        foreach ($donutInfo['data'] as $item) {
            $chartData['labels'][] = $item['label'];
            $chartData['values'][] = $item['value'];
            $chartData['colors'][] = $item['labelColor'];
        }
        
        return $chartData;
    }
    
    return null;
}

// Usage
$donutData = getDashboardDonutData();
echo json_encode($donutData);

# Get current month analytics
START_DATE=$(date +"%Y-%m-01")
END_DATE=$(date +"%Y-%m-%d")

curl --location 'https://unify.smsgateway.center/SMSApi/dashboard/read' \
--form "userid=\"YourUsername\"" \
--form "password=\"YourPassword\"" \
--form "startDate=\"$START_DATE\"" \
--form "endDate=\"$END_DATE\"" \
--form "output=\"json\"" | jq '.response.dashboard'