POST /api/v1/scan

Overview

The /scan endpoint performs thorough validation of your ad creative ZIP file. It analyzes the creative against over 40 checks including IAB standards, clickTag detection, file size limits, backup image requirements, animation specifications, SSL/HTTPS compliance, and accessibility standards.

The scan is non-destructive; no changes are made to your file. The endpoint returns analysis data only, making it ideal for validation workflows and compliance checking.

Request

Endpoint

POST https://adloom.io/api/v1/scan

Authentication

Include your API key in the request header:

X-API-Key: adl_your_api_key_here

Content type

Requests must use multipart/form-data encoding.

Parameters

Example requests

curl -X POST https://adloom.io/api/v1/scan \
  -H "X-API-Key: adl_your_api_key_here" \
  -F "file=@creative.zip" \
  -F "target_platform=cm360"

const fs = require('fs');

const formData = new FormData();
formData.append('file', fs.createReadStream('creative.zip'));
formData.append('target_platform', 'cm360');

const response = await fetch('https://adloom.io/api/v1/scan', {
  method: 'POST',
  headers: {
    'X-API-Key': 'adl_your_api_key_here'
  },
  body: formData
});

const report = await response.json();
console.log(report);

Response

Status code

200 OK on success

Response fields

Example response

{
  "success": true,
  "report": {
    "filename": "creative.zip",
    "targetPlatform": "cm360",
    "dimensions": {
      "width": 300,
      "height": 250
    },
    "fileSize": 145.2,
    "entryFile": "index.html",
    "score": 92,
    "clicktag": {
      "detected": true,
      "type": "cm360",
      "variable": "clickTag"
    },
    "tests": [
      {
        "category": "clicktag",
        "name": "ClickTag detected",
        "status": "pass",
        "expected": "ClickTag present",
        "actual": "ClickTag found (cm360 format)",
        "detail": ""
      },
      {
        "category": "weight",
        "name": "Initial load under 150KB",
        "status": "pass",
        "expected": "< 150 KB",
        "actual": "145.2 KB",
        "detail": ""
      },
      {
        "category": "backup",
        "name": "Backup image exists",
        "status": "pass",
        "expected": "Backup image required",
        "actual": "backup.jpg found",
        "detail": ""
      }
    ],
    "categories": [
      { "key": "structure", "label": "File structure", "score": 100 },
      { "key": "weight", "label": "Weight and size", "score": 95 },
      { "key": "clicktag", "label": "ClickTag", "score": 100 },
      { "key": "ssl", "label": "SSL and security", "score": 100 },
      { "key": "backup", "label": "Backup image", "score": 100 },
      { "key": "technology", "label": "Technology", "score": 90 },
      { "key": "dimensions", "label": "Dimensions", "score": 100 },
      { "key": "animation", "label": "Animation", "score": 85 },
      { "key": "accessibility", "label": "Accessibility", "score": 80 }
    ],
    "meta": {
      "fileCount": 5,
      "hasBackupImage": true,
      "hasMetaAdSize": true,
      "usesHttps": true
    }
  },
  "usage": {
    "used": 251,
    "limit": 1000
  },
  "durationMs": 245
}

Supported platforms

The /scan endpoint supports clickTag detection for 12 ad platforms across ad servers and DSPs.

Error handling

For detailed information on error responses, see the error handling guide.