Mulai Cepat API DOOH Audience Meter

Panduan mulai cepat ini membaca audiens layar di suatu lokasi dari perangkat DOOH Audience Meter. Anda memerlukan curl dan sekitar sepuluh menit. Angka pada jawaban di bawah adalah nilai contoh. Tayangan bersifat anonim: tidak ada identitas dan tidak ada gambar yang disimpan.

Sebelum Anda Mulai

Mintalah Admin perangkat membuat akun API di dasbor (halaman Akun API) dengan:

• peran Pemantau di lokasi layar;
• cakupan read (tambahkan export untuk mengunduh log tayangan atau angka kampanye sebagai file);
• tanggal berakhir.

Admin memberikan token (<API_KEY> di bawah), alamat perangkat (<BOX_HOST>) dan salinan sertifikat perangkat (box.pem, dari Unduh sertifikat perangkat di halaman Akun API) beserta sidik jari SHA-256-nya: periksa seperti yang ditunjukkan Sertifikat Perangkat. Autentikasi dan Cakupan menjelaskan masing-masing.

Cari Lokasi Anda

curl --cacert box.pem \
  -H "Authorization: Bearer <API_KEY>" \
  "https://<BOX_HOST>/api/v1/sites"

{
  "items": [
    {
      "id": 1,
      "name": "North Plant",
      "timezone": "Asia/Jakarta",
      "created": "2026-10-01T02:00:00Z",
      "version": 4,
      "my_role": "viewer",
      "location": { "lat": -6.2, "lon": 106.8 },
      "area": null,
      "zones": 3
    }
  ]
}

Simpan id lokasi (di sini 1). Setiap layar diamati oleh satu kamera; kameranya ada di GET /api/v1/cameras.

Baca Ikhtisar Audiens

Mintalah satu periode dengan from dan to (RFC 3339; %2B adalah tanda + dari selisih zona waktu):

curl --cacert box.pem \
  -H "Authorization: Bearer <API_KEY>" \
  "https://<BOX_HOST>/api/dooh/v1/sites/1/overview?from=2026-11-01T00:00:00%2B07:00&to=2026-11-02T00:00:00%2B07:00"

{
  "ots": 9620,
  "impressions": 3105,
  "engaged": 684,
  "attention_rate": 32.3,
  "engagement_rate": 7.1,
  "avg_attention_s": 3.1,
  "avg_dwell_s": 6.4,
  "audience_now": { "in_view": 7, "watching": 2 },
  "demographics": {
    "cells": [{ "age_band": "18-24", "gender": "male", "impressions": 512, "share": 19.8 }],
    "unknown": 514
  },
  "emotions": { "neutral": 2210, "happy": 604, "sad": 41, "surprised": 88, "angry": 12, "unknown": 150 }
}

Untuk angka yang sama per jam atau hari, panggil GET /api/dooh/v1/sites/1/trend; untuk jam puncak, bagian hari dan setiap layar, GET /api/dooh/v1/sites/1/analytics.

Baca Audiens Per Kampanye

Perangkat mencocokkan apa yang ditayangkan setiap layar (log tayangnya) dengan audiens di depannya:

curl --cacert box.pem \
  -H "Authorization: Bearer <API_KEY>" \
  "https://<BOX_HOST>/api/dooh/v1/sites/1/campaigns?from=2026-11-01T00:00:00%2B07:00&to=2026-11-02T00:00:00%2B07:00"

{
  "price_per_slot": null,
  "currency": "IDR",
  "campaigns": [
    {
      "campaign_id": "Morning Coffee",
      "plays": 320,
      "play_s": 4800,
      "ots": 2410,
      "impressions": 806,
      "engaged": 170,
      "attention_rate": 33.4,
      "engagement_rate": 7.1,
      "avg_attention_s": 2.9,
      "est_cost": null,
      "est_cpm": null,
      "out_of_flight": 0,
      "record": {
        "id": 3,
        "advertiser": "Advertiser A",
        "flight_start": "2026-11-01",
        "flight_end": "2026-11-30",
        "external_id": "CMP-1001",
        "screens": [41]
      },
      "creatives": [
        {
          "creative_id": "Coffee 15s",
          "record_id": 4,
          "length_s": 15,
          "plays": 320,
          "play_s": 4800,
          "ots": 2410,
          "impressions": 806,
          "engaged": 170,
          "attention_rate": 33.4,
          "engagement_rate": 7.1,
          "avg_attention_s": 2.9,
          "est_cost": null,
          "est_cpm": null,
          "out_of_flight": 0
        }
      ]
    }
  ]
}

Satu tayangan dihitung untuk setiap materi iklan di layarnya selama orang tersebut terlihat. record adalah catatan pengelola kampanye bila kampanye memilikinya. est_cost dan est_cpm tetap null sampai Admin mengatur harga per slot lokasi. Unduh angka yang sama dengan GET /api/dooh/v1/sites/1/campaigns/export?format=csv dan cakupan export.

Kirim Log Tayang

Angka kampanye perlu mengetahui apa yang ditayangkan setiap layar. CMS atau pemutar Anda dapat mengirim log tayangnya dengan dua cara:

• ditandatangani oleh CMS sendiri: POST /api/dooh/v1/feeds/plays/{site}, dengan kunci log tayang lokasi yang dibuat Admin lokasi di dasbor (lihat Menandatangani Permintaan ke Perangkat);
• sebagai unggahan CSV dengan token API yang menjadi Admin lokasi: POST /api/dooh/v1/sites/1/plays/upload (screen,creative,campaign,start,end).

Server iklan dapat membaca audiens per layar dan interval dengan token umpannya sendiri, tanpa akun API: GET /api/dooh/v1/feeds/audience/1?from=...&to=...&bucket=hour dengan Authorization: Bearer <FEED_TOKEN>.

Langkah Berikutnya

• Kirim tayangan dan log tayang ke sistem Anda tanpa perlu menanyakan berulang kali: Webhook (jenis peristiwa dooh.view dan dooh.play, serta ringkasan berkala).
• Setiap operasi dan kolom: referensi API DOOH Audience Meter dan referensi API platform.