WidgetDash

Quick Start

Up and running in minutes.

1. Create an account

# Create an account and get your API keys
curl -X POST https://api.widgetdash.app/api/v1/users \
  -H "Content-Type: application/json" \
  -d '{"name": "your-name"}'

2. Push data (use your write key)

curl -X PUT https://api.widgetdash.app/api/v1/data/my-source \
  -H "Authorization: Bearer YOUR_WRITE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "My Service",
    "icon": "chart.bar.fill",
    "category": "monitoring",
    "metrics": [
      {"label": "Users Online", "value": "42", "type": "number", "color": "green"},
      {"label": "Status", "value": "Healthy", "type": "status", "color": "green"}
    ]
  }'

3. Read data (use your read key)

curl https://api.widgetdash.app/api/v1/widget \
  -H "Authorization: Bearer YOUR_READ_KEY"

API Reference

All available endpoints. Full interactive docs here.

Method	Endpoint	Auth	Description
POST	`/api/v1/users`	None	Create account, get API keys
GET	`/api/v1/users/me`	Read	Get account info
PUT	`/api/v1/data/{source_key}`	Write	Push data from collector
GET	`/api/v1/widget`	Read	Get all widget data
GET	`/api/v1/data/{source_key}`	Read	Get specific source data
POST	`/api/v1/sources`	Write	Register data source
GET	`/api/v1/sources`	Read	List data sources
DELETE	`/api/v1/sources/{source_key}`	Write	Delete data source
GET	`/health`	None	Health check
GET	`/api/v1/version`	None	Version info

Writing a Collector

A collector is any script or program that periodically pushes data to WidgetDash.

How collectors work

A collector is any script that runs on a schedule (cron, systemd timer, loop, etc.)
It fetches data from your service via API, database query, CLI, or any other method
It formats the data as WidgetDash metrics
It PUTs the payload to the WidgetDash API using your write key
Collectors can be written in any language: Python, Node.js, Go, Bash, and more

Tip: Only push when data actually changes. Hash your payload and compare to the previous push to avoid unnecessary writes.

Example: Python collector

import httpx, os, time

API_KEY = os.environ["WIDGET_API_KEY"]
SERVER = "https://api.widgetdash.app"

while True:
    # Fetch your data (replace with your own logic)
    users_online = get_users_count()

    httpx.put(f"{SERVER}/api/v1/data/my-app",
        headers={"Authorization": f"Bearer {API_KEY}"},
        json={
            "display_name": "My App",
            "icon": "person.3.fill",
            "category": "app",
            "metrics": [
                {"label": "Online", "value": str(users_online), "type": "number", "color": "green"}
            ]
        })
    time.sleep(60)

Terms of Service

Last updated: March 2026

Acceptance of Terms

By accessing or using the WidgetDash service ("Service"), you agree to be bound by these Terms of Service ("Terms"). If you do not agree to these Terms, you may not use the Service.

Service Description

WidgetDash is provided as a free, open platform for pushing and retrieving widget data via an API. There are no guarantees of uptime, availability, or continued operation of the Service.

User Responsibilities

Users are solely responsible for their own data, collector scripts, and API usage.
Users must not use the Service for any illegal, unauthorized, or abusive purposes.
Users must not attempt to interfere with or disrupt the Service or its infrastructure.
Users must not use the Service to store or transmit malicious content.

Data

Users retain ownership of all data they push to the Service. The Service stores only what users explicitly submit via the API. Data may be deleted without notice at the sole discretion of the service provider.

No Warranty

THE SERVICE IS PROVIDED "AS IS" AND "AS AVAILABLE" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. THE SERVICE PROVIDER DOES NOT WARRANT THAT THE SERVICE WILL BE UNINTERRUPTED, SECURE, OR ERROR-FREE.

Limitation of Liability

IN NO EVENT SHALL THE SERVICE PROVIDER, ITS OPERATORS, CONTRIBUTORS, OR AFFILIATES BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO LOSS OF PROFITS, DATA, USE, GOODWILL, OR OTHER INTANGIBLE LOSSES, RESULTING FROM (A) YOUR ACCESS TO OR USE OF OR INABILITY TO ACCESS OR USE THE SERVICE; (B) ANY CONDUCT OR CONTENT OF ANY THIRD PARTY ON THE SERVICE; (C) ANY CONTENT OBTAINED FROM THE SERVICE; (D) UNAUTHORIZED ACCESS, USE, OR ALTERATION OF YOUR TRANSMISSIONS OR CONTENT; (E) DATA LOSS OR CORRUPTION; (F) SECURITY BREACHES OR VULNERABILITIES. THE TOTAL LIABILITY OF THE SERVICE PROVIDER SHALL NOT EXCEED THE AMOUNT PAID BY YOU FOR USE OF THE SERVICE, WHICH IS ZERO FOR A FREE SERVICE.

Indemnification

You agree to indemnify, defend, and hold harmless the service provider, its operators, contributors, and affiliates from and against any and all claims, damages, obligations, losses, liabilities, costs, and expenses (including attorney's fees) arising from your use of the Service, your violation of these Terms, or your violation of any rights of a third party.

Modification of Terms

The service provider reserves the right to modify these Terms at any time without prior notice. Continued use of the Service after modifications constitutes acceptance of the revised Terms.

Termination

The service provider may terminate or suspend your access to the Service at any time, for any reason, with or without cause, and with or without notice. Upon termination, your right to use the Service ceases immediately.

Governing Law

These Terms shall be governed by and construed in accordance with applicable law, without regard to conflict of law principles.

Severability

If any provision of these Terms is held to be unenforceable or invalid, the remaining provisions shall continue in full force and effect.

No Service Level Agreement

This is a free service with no service level agreement (SLA). There are no guarantees regarding uptime, response time, throughput, or data durability.

Rate Limits

The Service may impose rate limits on API usage at any time. Excessive or abusive use may result in throttling, temporary suspension, or permanent termination of access.

API Key Security

Users are solely responsible for keeping their API keys secure and confidential. The service provider is not liable for any unauthorized access, data loss, or damages resulting from compromised, leaked, or shared API keys.

Privacy Policy

Last updated: March 2026

Data Collection

We store only the data you explicitly push via the API. This includes: the user name you provide during registration, data source names, and the metric values you submit. No additional data is collected.

No Personal Data

We do not collect personal information beyond what you voluntarily provide during registration (a name of your choosing). You are not required to use your real name.

No Tracking

We do not use cookies, analytics services, tracking pixels, or any other tracking mechanisms. This website and the API do not track your browsing behavior.

No Third Parties

We do not share, sell, rent, or distribute your data to any third parties under any circumstances.

Data Retention

Your data is stored for as long as your account exists. You can delete your data sources at any time via the API. Account deletion permanently removes all associated data.

Data Security

We employ industry-standard security practices to protect your data, but we cannot guarantee absolute security. No method of electronic storage or transmission over the Internet is 100% secure. Use the Service at your own risk.

No Backups Guarantee

We do not guarantee data backups, data recovery, or data redundancy. You are responsible for maintaining your own copies of any important data.

Contact

For privacy concerns or questions about your data, contact the service administrator.

Disclaimer

Please read carefully before using the Service.

WidgetDash is a personal/hobby project provided entirely for free, with no commercial backing or support team.
There are no guarantees of availability, reliability, security, performance, or data integrity.
You use this Service entirely at your own risk.
The service provider assumes no responsibility whatsoever for any damages, losses, or liabilities arising from your use of or inability to use the Service.
This Service is not intended for mission-critical, medical, financial, safety-critical, or any application where failure could result in harm, injury, or significant loss.
The Service may be modified, suspended, or discontinued at any time without prior notice.
No representations or warranties of any kind are made regarding the accuracy, completeness, or reliability of any data stored or served by the platform.

See It in Action

How It Works

Create Account

Push Data

See It

Architecture

Quick Start

1. Create an account

2. Push data (use your write key)

3. Read data (use your read key)

API Reference

Metric Types

number

text

status

progress

Available Colors

Writing a Collector

How collectors work

Example: Python collector

Quick Setup

Create Account

Scan QR Code

Done

Generate your setup QR code

Deep Link Setup

iOS Widget

Download

Connect

Add Widget

Terms of Service

Acceptance of Terms

Service Description

User Responsibilities

Data

No Warranty

Limitation of Liability

Indemnification

Modification of Terms

Termination

Governing Law

Severability

No Service Level Agreement

Rate Limits

API Key Security

Privacy Policy

Data Collection

No Personal Data

No Tracking

No Third Parties

Data Retention

Data Security

No Backups Guarantee

Contact

Disclaimer