Reporting API

Rapor Uç Noktası

GET /v1/report — boyutlar, metrikler, granularity, sayfalama ve örnekler.

GET /v1/report tek uç noktadır. Tarih aralığı + metrik seçersin, isteğe bağlı olarak boyutlarla kırılım alırsın. Her satır { dimensions, metrics } şeklindedir.

Parametreler

ParametreZorunluAçıklama
fromBaşlangıç (dahil), ISO 8601
toBitiş (dahil), ISO 8601. Aralık en fazla 90 gün
metricsVirgülle ayrılmış metrik listesi
dimensionsVirgülle ayrılmış kırılım. Yoksa tek toplam satır
granularityhourly · daily · weekly · monthly — yalnızca date boyutuyla
campaign_idTek bir sahip olunan kampanyaya kısıtla
ad_idTek bir sahip olunan reklama kısıtla
pageSayfa numarası (1'den başlar)
limitSayfa başına satır (sunucuda üst sınır var)

Metrikler

MetrikAçıklama
viewsGörüntülenme
spendingHarcama
clicksTıklama (geçerli / bot filtreli)
conversionsDönüşüm
revenueGelir

Boyutlar

BoyutAçıklama
dateZaman kovası — granularity ile saatlik/günlük/haftalık/aylık
campaignKampanya kırılımı (campaign_id + name)
adReklam kırılımı (ad_id + name)
keywordAnahtar kelime kırılımı (keyword_id + name)

Kurallar:

  • Boyut vermezsen → tek bir grand-total satırı döner.
  • Bir entity boyutu (campaign | ad | keyword) isteğe bağlı date ile birleştirilebilir — keyword hariç (o yalnızca toplam).
  • keyword yalnızca views, spending, clicks destekler (conversions/revenue yok).
  • date değeri unix epoch saniye (UTC, kova başlangıcı).

Örnekler

Kampanya × gün kırılımı

curl -s 'https://reporting.magfiads.com/v1/report?from=2026-06-01T00:00:00Z&to=2026-06-30T23:59:59Z&metrics=views,spending,clicks&dimensions=campaign,date&granularity=daily' \
  -H 'Authorization: Bearer <API_KEY>'
{
  "meta": {
    "granularity": "daily",
    "dimensions": ["campaign", "date"],
    "metrics": ["views", "spending", "clicks"],
    "total": 240,
    "page": 1,
    "limit": 500,
    "has_more": false
  },
  "data": [
    {
      "dimensions": { "date": 1780617600, "campaign_id": 10, "name": "Summer Launch" },
      "metrics": { "views": 52100, "spending": 3421.1, "clicks": 88 }
    }
  ]
}

Anahtar kelime toplamları

curl -s 'https://reporting.magfiads.com/v1/report?from=2026-06-01T00:00:00Z&to=2026-06-30T23:59:59Z&metrics=views,clicks&dimensions=keyword' \
  -H 'Authorization: Bearer <API_KEY>'
{
  "meta": { "granularity": null, "dimensions": ["keyword"], "metrics": ["views", "clicks"], "total": 12, "page": 1, "limit": 500, "has_more": false },
  "data": [
    { "dimensions": { "keyword_id": 7, "name": "Spor" }, "metrics": { "views": 88010, "clicks": 1203 } }
  ]
}

Sayfalama

meta.total toplam satır sayısıdır. meta.has_more true ise page değerini artırarak sonraki sayfayı al:

...&page=2&limit=500

Tarih dönüştürme

date unix epoch saniyedir (UTC). Örnek dönüştürme:

new Date(1780617600 * 1000).toISOString(); // "2026-06-01T00:00:00.000Z"

Tam şema → API referansı.

On this page