API Endpoint - PixelSuite API

Overview

Returns a paginated list of video advertising content with thumbnail previews and duration information. Videos include layout information for proper display orientation.

Request

Endpoint

HTTP Request

GET https://api.pixelsuite.com.au/v1/adverts/videos

Query Parameters

Parameter	Type	Required	Default	Description
`page`	integer	No	1	Page number
`limit`	integer	No	50	Results per page (max: 100)
`search`	string	No	-	Search by title

Example Request

cURL

curl -X GET "https://api.pixelsuite.com.au/v1/adverts/videos?search=promo" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON

{
  "success": true,
  "data": {
    "videoAdverts": [
      {
        "ID": 88,
        "title": "Product Launch Video",
        "description": "New product promotional video",
        "length": 30.0,
        "layout": "landscape",
        "revision": 1,
        "dateCreated": "2026-01-10 09:00:00",
        "file": {
          "ID": 1001,
          "key": "videos/product-launch.mp4",
          "displayName": "Product Launch Video",
          "mimeType": "video/mp4",
          "fileSize": 15728640,
          "dateCreated": "2026-01-10 09:00:00"
        },
        "thumbnail": {
          "ID": 1002,
          "key": "videos/thumbnails/product-launch-thumb.jpg",
          "displayName": "Product Launch Thumbnail",
          "mimeType": "image/jpeg",
          "fileSize": 81920,
          "dateCreated": "2026-01-10 09:00:00"
        }
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 15,
      "totalPages": 1,
      "hasMore": false
    }
  }
}

Response Fields

Field	Type	Description
`ID`	integer	Video advert ID
`title`	string	Video title
`length`	float	Duration in seconds
`layout`	string	Video orientation (landscape/portrait)
`file`	object	Video file S3 information
`thumbnail`	object	Thumbnail image S3 information

Code Examples

PHP

<?php
$apiKey = 'YOUR_API_KEY';
$url = 'https://api.pixelsuite.com.au/v1/adverts/videos';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer {$apiKey}"]);

$response = curl_exec($ch);
$data = json_decode($response, true);

if ($data['success']) {
    foreach ($data['data']['videoAdverts'] as $video) {
        echo "{$video['title']} ({$video['layout']}) - {$video['length']}s\n";
        echo "File: {$video['file']['key']}\n\n";
    }
}

curl_close($ch);

JavaScript

const apiKey = 'YOUR_API_KEY';

fetch('https://api.pixelsuite.com.au/v1/adverts/videos', {
  headers: { 'Authorization': `Bearer ${apiKey}` }
})
.then(res => res.json())
.then(data => {
  if (data.success) {
    data.data.videoAdverts.forEach(video => {
      console.log(`${video.title} (${video.layout}) - ${video.length}s`);
      console.log(`File: ${video.file.key}\n`);
    });
  }
});

Python

import requests

api_key = 'YOUR_API_KEY'
headers = {'Authorization': f'Bearer {api_key}'}

response = requests.get(
    'https://api.pixelsuite.com.au/v1/adverts/videos',
    headers=headers
)

data = response.json()
if data['success']:
    for video in data['data']['videoAdverts']:
        print(f"{video['title']} ({video['layout']}) - {video['length']}s")
        print(f"File: {video['file']['key']}\n")