Amplify APIReference
Retrieve performance statistics for all marketer campaigns by geo
GET
/reports/marketers/{id}/campaigns/geoAuthorization
obToken OB-TOKEN-V1<token>
Token obtained from the Obtain a token endpoint or the Amplify API token page. Valid for 30 days.
In: header
Path Parameters
id*string
Marketer id
Query Parameters
from?string
Start day Date
to?string
End day Date
breakdown?string
Defines the geo breakdown of data, either country, region or DMA.
limit?number
Number of results to return in this request for each campaign. default is 10.
offset?number
Result number to start this response at. zero based. Used with limit for pagination. default is 0.
includeArchivedCampaigns?string
Include data of archived campaigns, default false.
includeConversionDetails?string
Include metrics of conversion pixels, default false.
conversionsByClickDate?string
Report conversion metrics by click or conversion date, default false (report by conversion date).
enabledCampaignsOnly?string
Include data of active campaigns only (data of inactive campaigns will not be shown). Relevant only when requesting all campaigns
Response Body
application/json
curl -X GET "https://example.com/reports/marketers/abf4b02153ee75f3cadc4fc128ab0419ab/campaigns/geo?from=2015-12-22&to=2016-01-20&breakdown=region&limit=10&offset=3&includeArchivedCampaigns=true&includeConversionDetails=false&conversionsByClickDate=true&enabledCampaignsOnly=true"{ "campaignResults": [ { "campaignId": "0036dfd487d1ec2b80094ba93cb9cfc86a", "results": [ { "metadata": { "id": "fc4deb5112fb4415a9edacdf4aafb0d8", "name": "United States", "code": "US" }, "metrics": { "impressions": 13, "clicks": 0, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 0, "ecpc": 0, "ctr": 0, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } }, { "metadata": { "id": "4b90a812044fa1a76b265b916218fb04", "name": "Israel", "code": "IL" }, "metrics": { "impressions": 191, "clicks": 0, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 0, "ecpc": 0, "ctr": 0, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } }, { "metadata": { "id": "281f981b8e4f56604268e52d8f50157e", "name": "Brazil", "code": "BR" }, "metrics": { "impressions": 1141826, "clicks": 10618, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 1388.14, "ecpc": 0.13, "ctr": 0.93, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } } ], "totalResults": 3 }, { "campaignId": "005a31a55e4fd8ccece20433d61cd78419", "results": [ { "metadata": { "id": "fc4deb5112fb4415a9edacdf4aafb0d8", "name": "United States", "code": "US" }, "metrics": { "impressions": 30, "clicks": 0, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 0, "ecpc": 0, "ctr": 0, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } }, { "metadata": { "id": "4b90a812044fa1a76b265b916218fb04", "name": "Israel", "code": "IL" }, "metrics": { "impressions": 5, "clicks": 0, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 0, "ecpc": 0, "ctr": 0, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } } ], "totalResults": 3 } ], "totalCampaigns": 2}