শুরু করুন

পেজিনেশন ও ফিল্টার

তালিকাগুলো (/tvs, /files ও /playlists) পেজে ভাগ করা থাকে। আইটেমগুলো আসে data-তে এবং পেজের তথ্য আসে meta-তে।

নাম	ধরন	বিবরণ
`page`	`integer`	পেজ, 1 থেকে শুরু। ডিফল্ট: 1।
`per_page`	`integer`	প্রতি পেজে আইটেম, 1 থেকে 100 পর্যন্ত। ডিফল্ট: 50।

`meta`-এর ফিল্ড

page integer: বর্তমান পেজ।
per_page integer: প্রতি পেজে আইটেম।
total integer: সব পেজ মিলিয়ে পাওয়া মোট আইটেম।
total_pages integer: মোট পেজ।

সব আনতে page=1 থেকে শুরু করে total_pages পর্যন্ত এগিয়ে যান। শেষ পেজের পরের পেজে data খালি আসে।

ফিল্টার

ফিল্টারগুলো একটির সঙ্গে আরেকটি এবং পেজিনেশনের সঙ্গে মিলিয়ে ব্যবহার করা যায়। meta-এর total ফিল্টারগুলো হিসাবে নিয়েই গণনা করা হয়।

নাম	ধরন	বিবরণ
`organization`	`string`	কোনো প্রতিষ্ঠানের uid, শুধু সেই প্রতিষ্ঠানের আইটেম আনার জন্য (দেখুন `/organizations`)।
`q`	`string`	নামের অংশ, সর্বোচ্চ 100টি অক্ষর।
`type`	`string`	ফাইলের ধরন, যেমন `image` বা `video`। শুধু `/files`-এ।
`archived`	`integer`	শুধু আর্কাইভ করা ফাইলের জন্য `1`, অথবা শুধু আর্কাইভ না করা ফাইলের জন্য `0`। শুধু `/files`-এ।

ক্রম

টিভি ও প্লেলিস্ট আসে বর্ণানুক্রমে; ফাইল আসে নতুন থেকে পুরোনো ক্রমে।

অনুরোধcURLPHPJavaScript

curl "https://api.on-cloud.live/v1/tvs?per_page=2" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/tvs?per_page=2');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/tvs?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();

রেসপন্স200

{
  "data": [
    {
      "uid": "d3d9446802a44259755d38e6d163e820",
      "name": "Caixa 2",
      "description": "",
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      },
      "playlist": null,
      "status": "offline",
      "last_seen_at": "2026-11-01T18:04:51-03:00",
      "activated_at": "2025-03-12T09:41:05-03:00",
      "app_version": "3.12.83",
      "os": "android",
      "device": {
        "brand": "Philco",
        "model": "PTV32G70"
      },
      "timezone": "America/Sao_Paulo"
    },
    {
      "uid": "c98cb8f9cc62887d1f6cf5693df9219c",
      "name": "Recepção",
      "description": "TV da entrada",
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      },
      "playlist": {
        "uid": "e4da3b7fbbce2345d7772b0674a318d5",
        "name": "Lista principal"
      },
      "status": "online",
      "last_seen_at": "2026-11-03T14:32:10-03:00",
      "activated_at": "2025-03-12T09:41:05-03:00",
      "app_version": "3.12.84",
      "os": "android",
      "device": {
        "brand": "TCL",
        "model": "43P635"
      },
      "timezone": "America/Sao_Paulo"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 3,
    "total_pages": 2
  }
}

অবৈধ প্যারামিটার400

GET /v1/tvs?per_page=500

{
  "error": {
    "code": "invalid_parameter",
    "message": "per_page must be a number between 1 and 100."
  }
}

পেজিনেশন ও ফিল্টার

meta-এর ফিল্ড

ফিল্টার

ক্রম

`meta`-এর ফিল্ড