API Reference

Get Metrics

Retrieve performance metrics for a specific campaign

GEThttps://api.syntermedia.ai/v1/campaigns/:id/metrics

Path parameters

idstringrequired

Campaign ID from the ad platform

Query parameters

start_datestring

Start date in YYYY-MM-DD format. Default: 7 days ago

end_datestring

End date in YYYY-MM-DD format. Default: today

granularitystring

Time granularity: daily, weekly, or monthly. Default: daily

Example request

bash

curl -X GET "https://api.syntermedia.ai/v1/campaigns/123456789/metrics?start_date=2024-01-01&end_date=2024-01-31" \
  -H "X-Synter-Key: syn_your_api_key"

Example response

json

{
  "campaign_id": "123456789",
  "platform": "GOOGLE",
  "summary": {
    "impressions": 125000,
    "clicks": 3400,
    "cost": 1250.00,
    "conversions": 85,
    "ctr": 2.72,
    "roas": 4.2
  }
}

Available metrics

impressionsclickscostconversionsctrcpccparoasrevenue

Was this page helpful?

PreviousList Campaigns Next Pause Campaign